public class DomainsPartInfo extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
DomainsPartInfo()  | 
DomainsPartInfo(DomainsPartInfo source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Long | 
getActiveCheck()
Get Whether to enable proactive health check
0: disable
1: enable
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getCert()
Get Certificate 
 | 
Long | 
getCertType()
Get Certificate type
0: no certificate, with only the HTTP listening port configured
1: self-owned certificate
2: managed certificate 
 | 
Long[] | 
getCiphers()
Get Custom encryption suite list. 
 | 
Long | 
getCipherTemplate()
Get Cipher suite template
0: default template
1: general template
2: security template
3: custom template
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getCls()
Get Whether to enable access logging
0: disable
1: enable 
 | 
String | 
getCname()
Get CNAME record for accessing a domain name protected by SaaS WAF 
 | 
String | 
getCreateTime()
Get Creation time 
 | 
String | 
getDomain()
Get Domain name 
 | 
String | 
getDomainId()
Get Unique domain name ID 
 | 
String | 
getEdition()
Get Instance type of the domain name 
 | 
Long | 
getEngine()
Get Status of the rule engine and AI engine
1: initial status. 
 | 
String | 
getGmCert()
Get When GmCertType is 1, this parameter needs to be set, indicating the certificate chain of the self-owned SM certificate. 
 | 
Long | 
getGmCertType()
Get SM certificate type. 
 | 
String | 
getGmEncCert()
Get When GmCertType is 1, this parameter needs to be set, indicating the encryption certificate of the self-owned SM certificate. 
 | 
String | 
getGmEncPrivateKey()
Get When GmCertType is 1, this parameter needs to be set, indicating the private key of the encryption certificate for the self-owned SM certificate. 
 | 
String | 
getGmPrivateKey()
Get When GmCertType is 1, this parameter needs to be set, indicating the private key of the self-owned SM certificate. 
 | 
String | 
getGmSSLId()
Get When GmCertType is 2, this parameter needs to be set, indicating the ID of the certificate managed by the Tencent Cloud SSL platform. 
 | 
Long | 
getGmType()
Get Whether to enable SM. 
 | 
Long | 
getHttpsRewrite()
Get Whether to enable forced redirection from HTTP to HTTPS
0: do not force redirection
1: enable forced redirection 
 | 
String | 
getHttpsUpstreamPort()
Get HTTPS origin-pull port 
 | 
String | 
getInstanceId()
Get Unique instance ID of the domain name 
 | 
String | 
getInstanceName()
Get Instance name of the domain name 
 | 
String[] | 
getIpHeaders()
Get IsCdn=3 indicates custom header
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getIsCdn()
Get Whether a layer-7 proxy service is deployed before WAF
0: No proxy service deployed
1: Proxy service deployed, and WAF will use XFF to obtain the client IP address
2: Proxy service deployed and WAF will use remote_addr to obtain the client IP address
3: Proxy service deployed and WAF will use the custom header in ip_headers to obtain the client IP address 
 | 
Long | 
getIsGray()
Get This parameter has been deprecated. 
 | 
Long | 
getIsHttp2()
Get Whether to enable HTTP2. 
 | 
Long | 
getIsKeepAlive()
Get Whether to enable persistent connection
0: non-persistent connection
1: persistent connection 
 | 
Long | 
getIsWebsocket()
Get Whether to enable support for WebSocket
0: disable
1: enable 
 | 
String[] | 
getLabels()
Get Domain name tag. 
 | 
String | 
getLevel()
Get Protection rule
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getLoadBalance()
Get Load balancing policy for origin-pull
0: round-robin
1: IP hash
2: weighted round-robin 
 | 
Long | 
getMode()
Get Protection mode
0: observation mode
1: interception mode 
 | 
String | 
getNote()
Get Domain name remarks
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
PortInfo[] | 
getPorts()
Get  Domain name port configuration 
 | 
String | 
getPrivateKey()
Get Private key of the self-owned certificate 
 | 
Long | 
getProxyBuffer()
Get Whether to enable caching. 
 | 
Long | 
getProxyReadTimeout()
Get Read timeout between WAF and origin server, 300s by default. 
 | 
Long | 
getProxySendTimeout()
Get WAF and origin server write timeout, 300s by default. 
 | 
String | 
getSniHost()
Get When SniType=3, this parameter is required, indicating a custom SNI;
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getSniType()
Get SNI type during WAF origin-pull
0: Disable SNI and do not configure server_name in client_hello. 
 | 
String[] | 
getSrcList()
Get Origin IP list when IP is back to source. 
 | 
String | 
getSSLId()
Get When CertType is 2, this parameter must be filled, indicating the certificate ID hosted on Tencent Cloud's SSL platform 
 | 
Long | 
getTLSVersion()
Get TLS version information
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
String | 
getUpstreamDomain()
Get Origin domain when domain is back to source. 
 | 
String | 
getUpstreamHost()
Get Custom origin-pull host. 
 | 
String | 
getUpstreamScheme()
Get Origin-pull protocol for HTTPS when the service is configured with an HTTPS port
http: Use the HTTP protocol for origin-pull. 
 | 
Long | 
getUpstreamType()
Get Origin-pull type
0: origin-pull via IP address
1: origin-pull via domain name 
 | 
String[] | 
getWeights()
Get Weight of the IP address for origin-pull
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
Long | 
getXFFReset()
Get Whether to enable XFF reset
0: disable
1: enable
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setActiveCheck(Long ActiveCheck)
Set Whether to enable proactive health check
0: disable
1: enable
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setCert(String Cert)
Set Certificate 
 | 
void | 
setCertType(Long CertType)
Set Certificate type
0: no certificate, with only the HTTP listening port configured
1: self-owned certificate
2: managed certificate 
 | 
void | 
setCiphers(Long[] Ciphers)
Set Custom encryption suite list. 
 | 
void | 
setCipherTemplate(Long CipherTemplate)
Set Cipher suite template
0: default template
1: general template
2: security template
3: custom template
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setCls(Long Cls)
Set Whether to enable access logging
0: disable
1: enable 
 | 
void | 
setCname(String Cname)
Set CNAME record for accessing a domain name protected by SaaS WAF 
 | 
void | 
setCreateTime(String CreateTime)
Set Creation time 
 | 
void | 
setDomain(String Domain)
Set Domain name 
 | 
void | 
setDomainId(String DomainId)
Set Unique domain name ID 
 | 
void | 
setEdition(String Edition)
Set Instance type of the domain name 
 | 
void | 
setEngine(Long Engine)
Set Status of the rule engine and AI engine
1: initial status. 
 | 
void | 
setGmCert(String GmCert)
Set When GmCertType is 1, this parameter needs to be set, indicating the certificate chain of the self-owned SM certificate. 
 | 
void | 
setGmCertType(Long GmCertType)
Set SM certificate type. 
 | 
void | 
setGmEncCert(String GmEncCert)
Set When GmCertType is 1, this parameter needs to be set, indicating the encryption certificate of the self-owned SM certificate. 
 | 
void | 
setGmEncPrivateKey(String GmEncPrivateKey)
Set When GmCertType is 1, this parameter needs to be set, indicating the private key of the encryption certificate for the self-owned SM certificate. 
 | 
void | 
setGmPrivateKey(String GmPrivateKey)
Set When GmCertType is 1, this parameter needs to be set, indicating the private key of the self-owned SM certificate. 
 | 
void | 
setGmSSLId(String GmSSLId)
Set When GmCertType is 2, this parameter needs to be set, indicating the ID of the certificate managed by the Tencent Cloud SSL platform. 
 | 
void | 
setGmType(Long GmType)
Set Whether to enable SM. 
 | 
void | 
setHttpsRewrite(Long HttpsRewrite)
Set Whether to enable forced redirection from HTTP to HTTPS
0: do not force redirection
1: enable forced redirection 
 | 
void | 
setHttpsUpstreamPort(String HttpsUpstreamPort)
Set HTTPS origin-pull port 
 | 
void | 
setInstanceId(String InstanceId)
Set Unique instance ID of the domain name 
 | 
void | 
setInstanceName(String InstanceName)
Set Instance name of the domain name 
 | 
void | 
setIpHeaders(String[] IpHeaders)
Set IsCdn=3 indicates custom header
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setIsCdn(Long IsCdn)
Set Whether a layer-7 proxy service is deployed before WAF
0: No proxy service deployed
1: Proxy service deployed, and WAF will use XFF to obtain the client IP address
2: Proxy service deployed and WAF will use remote_addr to obtain the client IP address
3: Proxy service deployed and WAF will use the custom header in ip_headers to obtain the client IP address 
 | 
void | 
setIsGray(Long IsGray)
Set This parameter has been deprecated. 
 | 
void | 
setIsHttp2(Long IsHttp2)
Set Whether to enable HTTP2. 
 | 
void | 
setIsKeepAlive(Long IsKeepAlive)
Set Whether to enable persistent connection
0: non-persistent connection
1: persistent connection 
 | 
void | 
setIsWebsocket(Long IsWebsocket)
Set Whether to enable support for WebSocket
0: disable
1: enable 
 | 
void | 
setLabels(String[] Labels)
Set Domain name tag. 
 | 
void | 
setLevel(String Level)
Set Protection rule
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setLoadBalance(Long LoadBalance)
Set Load balancing policy for origin-pull
0: round-robin
1: IP hash
2: weighted round-robin 
 | 
void | 
setMode(Long Mode)
Set Protection mode
0: observation mode
1: interception mode 
 | 
void | 
setNote(String Note)
Set Domain name remarks
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setPorts(PortInfo[] Ports)
Set  Domain name port configuration 
 | 
void | 
setPrivateKey(String PrivateKey)
Set Private key of the self-owned certificate 
 | 
void | 
setProxyBuffer(Long ProxyBuffer)
Set Whether to enable caching. 
 | 
void | 
setProxyReadTimeout(Long ProxyReadTimeout)
Set Read timeout between WAF and origin server, 300s by default. 
 | 
void | 
setProxySendTimeout(Long ProxySendTimeout)
Set WAF and origin server write timeout, 300s by default. 
 | 
void | 
setSniHost(String SniHost)
Set When SniType=3, this parameter is required, indicating a custom SNI;
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setSniType(Long SniType)
Set SNI type during WAF origin-pull
0: Disable SNI and do not configure server_name in client_hello. 
 | 
void | 
setSrcList(String[] SrcList)
Set Origin IP list when IP is back to source. 
 | 
void | 
setSSLId(String SSLId)
Set When CertType is 2, this parameter must be filled, indicating the certificate ID hosted on Tencent Cloud's SSL platform 
 | 
void | 
setTLSVersion(Long TLSVersion)
Set TLS version information
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setUpstreamDomain(String UpstreamDomain)
Set Origin domain when domain is back to source. 
 | 
void | 
setUpstreamHost(String UpstreamHost)
Set Custom origin-pull host. 
 | 
void | 
setUpstreamScheme(String UpstreamScheme)
Set Origin-pull protocol for HTTPS when the service is configured with an HTTPS port
http: Use the HTTP protocol for origin-pull. 
 | 
void | 
setUpstreamType(Long UpstreamType)
Set Origin-pull type
0: origin-pull via IP address
1: origin-pull via domain name 
 | 
void | 
setWeights(String[] Weights)
Set Weight of the IP address for origin-pull
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
setXFFReset(Long XFFReset)
Set Whether to enable XFF reset
0: disable
1: enable
Note: This field may return null, indicating that no valid values can be obtained. 
 | 
void | 
toMap(HashMap<String,String> map,
     String prefix)
Internal implementation, normal users should not use it. 
 | 
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic DomainsPartInfo()
public DomainsPartInfo(DomainsPartInfo source)
public String getDomain()
public void setDomain(String Domain)
Domain - Domain namepublic String getDomainId()
public void setDomainId(String DomainId)
DomainId - Unique domain name IDpublic String getInstanceId()
public void setInstanceId(String InstanceId)
InstanceId - Unique instance ID of the domain namepublic String getEdition()
public void setEdition(String Edition)
Edition - Instance type of the domain namepublic String getInstanceName()
public void setInstanceName(String InstanceName)
InstanceName - Instance name of the domain namepublic String getCert()
public void setCert(String Cert)
Cert - Certificatepublic String getCreateTime()
public void setCreateTime(String CreateTime)
CreateTime - Creation timepublic Long getEngine()
public void setEngine(Long Engine)
Engine - Status of the rule engine and AI engine
1: initial status. Interception for the rule engine and disabled for the AI engine.
10: observation for the rule engine and disabled for the AI engine
11: observation for both the rule engine and AI engine
12: observation for the rule engine and interception for the AI engine
20: interception for the rule engine and disabled for the AI engine
21: interception for the rule engine and observation for the AI engine
22: interception for both the rule engine and AI enginepublic Long getHttpsRewrite()
public void setHttpsRewrite(Long HttpsRewrite)
HttpsRewrite - Whether to enable forced redirection from HTTP to HTTPS
0: do not force redirection
1: enable forced redirectionpublic String getHttpsUpstreamPort()
public void setHttpsUpstreamPort(String HttpsUpstreamPort)
HttpsUpstreamPort - HTTPS origin-pull portpublic Long getIsCdn()
public void setIsCdn(Long IsCdn)
IsCdn - Whether a layer-7 proxy service is deployed before WAF
0: No proxy service deployed
1: Proxy service deployed, and WAF will use XFF to obtain the client IP address
2: Proxy service deployed and WAF will use remote_addr to obtain the client IP address
3: Proxy service deployed and WAF will use the custom header in ip_headers to obtain the client IP addresspublic Long getIsGray()
public void setIsGray(Long IsGray)
IsGray - This parameter has been deprecated.public Long getIsHttp2()
public void setIsHttp2(Long IsHttp2)
IsHttp2 - Whether to enable HTTP2. You should enable HTTPS as well.
0: disable
1: enablepublic Long getIsWebsocket()
public void setIsWebsocket(Long IsWebsocket)
IsWebsocket - Whether to enable support for WebSocket
0: disable
1: enablepublic Long getLoadBalance()
public void setLoadBalance(Long LoadBalance)
LoadBalance - Load balancing policy for origin-pull
0: round-robin
1: IP hash
2: weighted round-robinpublic Long getMode()
public void setMode(Long Mode)
Mode - Protection mode
0: observation mode
1: interception modepublic String getPrivateKey()
public void setPrivateKey(String PrivateKey)
PrivateKey - Private key of the self-owned certificatepublic String getSSLId()
public void setSSLId(String SSLId)
SSLId - When CertType is 2, this parameter must be filled, indicating the certificate ID hosted on Tencent Cloud's SSL platformpublic String getUpstreamDomain()
public void setUpstreamDomain(String UpstreamDomain)
UpstreamDomain - Origin domain when domain is back to source. When UpstreamType=1, this field needs to be filledpublic Long getUpstreamType()
public void setUpstreamType(Long UpstreamType)
UpstreamType - Origin-pull type
0: origin-pull via IP address
1: origin-pull via domain namepublic String[] getSrcList()
public void setSrcList(String[] SrcList)
SrcList - Origin IP list when IP is back to source. When UpstreamType=0, this field is requiredpublic PortInfo[] getPorts()
public void setPorts(PortInfo[] Ports)
Ports - Domain name port configurationpublic Long getCertType()
public void setCertType(Long CertType)
CertType - Certificate type
0: no certificate, with only the HTTP listening port configured
1: self-owned certificate
2: managed certificatepublic String getUpstreamScheme()
public void setUpstreamScheme(String UpstreamScheme)
UpstreamScheme - Origin-pull protocol for HTTPS when the service is configured with an HTTPS port
http: Use the HTTP protocol for origin-pull. It is used together with HttpsUpstreamPort.
https: Use the HTTPS protocol for origin-pull.public Long getCls()
public void setCls(Long Cls)
Cls - Whether to enable access logging
0: disable
1: enablepublic String getCname()
public void setCname(String Cname)
Cname - CNAME record for accessing a domain name protected by SaaS WAFpublic Long getIsKeepAlive()
public void setIsKeepAlive(Long IsKeepAlive)
IsKeepAlive - Whether to enable persistent connection
0: non-persistent connection
1: persistent connectionpublic Long getActiveCheck()
public void setActiveCheck(Long ActiveCheck)
ActiveCheck - Whether to enable proactive health check
0: disable
1: enable
Note: This field may return null, indicating that no valid values can be obtained.public Long getTLSVersion()
public void setTLSVersion(Long TLSVersion)
TLSVersion - TLS version information
Note: This field may return null, indicating that no valid values can be obtained.public Long[] getCiphers()
public void setCiphers(Long[] Ciphers)
Ciphers - Custom encryption suite list. When CipherTemplate is 3, this field is required, indicating the custom encryption suite, value obtained through DescribeCiphersDetail API.
Note: This field may return null, indicating that no valid values can be obtained.public Long getCipherTemplate()
public void setCipherTemplate(Long CipherTemplate)
CipherTemplate - Cipher suite template
0: default template
1: general template
2: security template
3: custom template
Note: This field may return null, indicating that no valid values can be obtained.public Long getProxyReadTimeout()
public void setProxyReadTimeout(Long ProxyReadTimeout)
ProxyReadTimeout - Read timeout between WAF and origin server, 300s by default.
Note: This field may return null, indicating that no valid values can be obtained.public Long getProxySendTimeout()
public void setProxySendTimeout(Long ProxySendTimeout)
ProxySendTimeout - WAF and origin server write timeout, 300s by default.
Note: This field may return null, indicating that no valid values can be obtained.public Long getSniType()
public void setSniType(Long SniType)
SniType - SNI type during WAF origin-pull
0: Disable SNI and do not configure server_name in client_hello.
1: Enable SNI. server_name in client_hello is a protected domain name.
2: Enable SNI. SNI is the origin server domain name during the domain name origin-pull.
3: Enable SNI. SNI is a custom domain name.
Note: This field may return null, indicating that no valid values can be obtained.public String getSniHost()
public void setSniHost(String SniHost)
SniHost - When SniType=3, this parameter is required, indicating a custom SNI;
Note: This field may return null, indicating that no valid values can be obtained.public String[] getWeights()
public void setWeights(String[] Weights)
Weights - Weight of the IP address for origin-pull
Note: This field may return null, indicating that no valid values can be obtained.public String[] getIpHeaders()
public void setIpHeaders(String[] IpHeaders)
IpHeaders - IsCdn=3 indicates custom header
Note: This field may return null, indicating that no valid values can be obtained.public Long getXFFReset()
public void setXFFReset(Long XFFReset)
XFFReset - Whether to enable XFF reset
0: disable
1: enable
Note: This field may return null, indicating that no valid values can be obtained.public String getNote()
public void setNote(String Note)
Note - Domain name remarks
Note: This field may return null, indicating that no valid values can be obtained.public String getUpstreamHost()
public void setUpstreamHost(String UpstreamHost)
UpstreamHost - Custom origin-pull host. The default value is a null string, indicating that a protected domain name is used as the origin-pull host.
Note: This field may return null, indicating that no valid values can be obtained.public String getLevel()
public void setLevel(String Level)
Level - Protection rule
Note: This field may return null, indicating that no valid values can be obtained.public Long getProxyBuffer()
public void setProxyBuffer(Long ProxyBuffer)
ProxyBuffer - Whether to enable caching. 0: disable; 1: enable.
Note: This field may return null, indicating that no valid values can be obtained.public Long getGmType()
public void setGmType(Long GmType)
GmType - Whether to enable SM. 0: do not enable SM; 1: add support for SM based on the existing TLS option; 2: enable SM and support only SM client access.
Note: This field may return null, indicating that no valid values can be obtained.public Long getGmCertType()
public void setGmCertType(Long GmCertType)
GmCertType - SM certificate type. 0: no SM certificate is available; 1: the certificate is a self-owned SM certificate; 2: the certificate is a managed SM certificate.
Note: This field may return null, indicating that no valid values can be obtained.public String getGmCert()
public void setGmCert(String GmCert)
GmCert - When GmCertType is 1, this parameter needs to be set, indicating the certificate chain of the self-owned SM certificate.
Note: This field may return null, indicating that no valid values can be obtained.public String getGmPrivateKey()
public void setGmPrivateKey(String GmPrivateKey)
GmPrivateKey - When GmCertType is 1, this parameter needs to be set, indicating the private key of the self-owned SM certificate.
Note: This field may return null, indicating that no valid values can be obtained.public String getGmEncCert()
public void setGmEncCert(String GmEncCert)
GmEncCert - When GmCertType is 1, this parameter needs to be set, indicating the encryption certificate of the self-owned SM certificate.
Note: This field may return null, indicating that no valid values can be obtained.public String getGmEncPrivateKey()
public void setGmEncPrivateKey(String GmEncPrivateKey)
GmEncPrivateKey - When GmCertType is 1, this parameter needs to be set, indicating the private key of the encryption certificate for the self-owned SM certificate.
Note: This field may return null, indicating that no valid values can be obtained.public String getGmSSLId()
public void setGmSSLId(String GmSSLId)
GmSSLId - When GmCertType is 2, this parameter needs to be set, indicating the ID of the certificate managed by the Tencent Cloud SSL platform.
Note: This field may return null, indicating that no valid values can be obtained.public String[] getLabels()
public void setLabels(String[] Labels)
Labels - Domain name tag.
Note: This field may return null, indicating that no valid values can be obtained.Copyright © 2025. All rights reserved.