public class AddSpartaProtectionRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
AddSpartaProtectionRequest() |
AddSpartaProtectionRequest(AddSpartaProtectionRequest 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 (Required) Whether to enable active health check
0: disable
1: enable
|
Long |
getAnycast()
Get To be deprecated, currently just fill in 0.
|
String |
getCert()
Get When CertType is 1, this parameter is required, indicating the self-owned certificate chain
|
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 (Required) Cipher suite template
0: default template
1: general template
2: security template
3: custom template
|
String |
getDomain()
Get Domain requiring protection
|
String |
getEdition()
Get WAF instance type.
|
String[] |
getGrayAreas()
Get To be deprecated, can be left blank.
|
Long |
getHttpsRewrite()
Get (Required) Whether to enable forced redirection from HTTP to HTTPS
0: do not force redirect
1: enable forced redirect
|
String |
getHttpsUpstreamPort()
Get HTTPS upstream port, required only when UpstreamScheme is http
|
String |
getInstanceID()
Get (Required) Instance ID of the domain name
|
String[] |
getIpHeaders()
Get When IsCdn is 3, this parameter is required, indicating a custom header.
|
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 a custom header in ip_headers to obtain the client IP address
|
Long |
getIsGray()
Get To be deprecated, can be left blank.
|
Long |
getIsHttp2()
Get (Required) Whether to enable HTTP2.
|
String |
getIsKeepAlive()
Get (Required) Whether to enable persistent connection
0: non-persistent connection
1: persistent connection
|
Long |
getIsWebsocket()
Get Whether to enable websocket
0: disable
1: enable
|
String |
getLoadBalance()
Get Load balancing policy for upstream
0: round-robin
1: IP hash
2: weighted round-robin
|
String |
getNote()
Get Domain name remarks
|
PortItem[] |
getPorts()
Get Service port list configuration
NginxServerId: fill in '0' in this function
Port: listening port number
Protocol: port protocol
UpstreamPort: same as Port
UpstreamProtocol: same as Protocol
|
String |
getPrivateKey()
Get When CertType=1, this parameter is required, indicating the private key of the self-owned certificate.
|
Long |
getProbeStatus()
Get 0: disable probe test; 1: enable probe test.
|
Long |
getProxyBuffer()
Get Whether to enable caching.
|
Long |
getProxyReadTimeout()
Get Read timeout between WAF and upstream server, 300s by default.
|
Long |
getProxySendTimeout()
Get WAF and upstream server write timeout, 300s by default.
|
String |
getResourceId()
Get To be deprecated, not required.
|
String |
getSniHost()
Get When SniType=3, this parameter is required, indicating a custom SNI;
|
Long |
getSniType()
Get SNI type during WAF sending request to upstream
0: Disable SNI and do not configure server_name in client_hello.
|
String[] |
getSrcList()
Get Upstream 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
|
String |
getUpstreamDomain()
Get Upstream domain when proxy to upstream by domain.
|
String |
getUpstreamHost()
Get Custom upstream host.
|
String |
getUpstreamScheme()
Get Upstream protocol for HTTPS when the service is configured with an HTTPS port
http: Use the HTTP protocol for upstream.
|
Long |
getUpstreamType()
Get Upstream type
0: proxy to upstream by IP address
1: proxy to upstream by domain name
|
Long[] |
getWeights()
Get Weight of each IP in the back-to-source IP List, corresponding to SrcList.
|
Long |
getXFFReset()
Get Whether to enable XFF reset
0: disable
1: enable
|
void |
setActiveCheck(Long ActiveCheck)
Set (Required) Whether to enable active health check
0: disable
1: enable
|
void |
setAnycast(Long Anycast)
Set To be deprecated, currently just fill in 0.
|
void |
setCert(String Cert)
Set When CertType is 1, this parameter is required, indicating the self-owned certificate chain
|
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 (Required) Cipher suite template
0: default template
1: general template
2: security template
3: custom template
|
void |
setDomain(String Domain)
Set Domain requiring protection
|
void |
setEdition(String Edition)
Set WAF instance type.
|
void |
setGrayAreas(String[] GrayAreas)
Set To be deprecated, can be left blank.
|
void |
setHttpsRewrite(Long HttpsRewrite)
Set (Required) Whether to enable forced redirection from HTTP to HTTPS
0: do not force redirect
1: enable forced redirect
|
void |
setHttpsUpstreamPort(String HttpsUpstreamPort)
Set HTTPS upstream port, required only when UpstreamScheme is http
|
void |
setInstanceID(String InstanceID)
Set (Required) Instance ID of the domain name
|
void |
setIpHeaders(String[] IpHeaders)
Set When IsCdn is 3, this parameter is required, indicating a custom header.
|
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 a custom header in ip_headers to obtain the client IP address
|
void |
setIsGray(Long IsGray)
Set To be deprecated, can be left blank.
|
void |
setIsHttp2(Long IsHttp2)
Set (Required) Whether to enable HTTP2.
|
void |
setIsKeepAlive(String IsKeepAlive)
Set (Required) Whether to enable persistent connection
0: non-persistent connection
1: persistent connection
|
void |
setIsWebsocket(Long IsWebsocket)
Set Whether to enable websocket
0: disable
1: enable
|
void |
setLoadBalance(String LoadBalance)
Set Load balancing policy for upstream
0: round-robin
1: IP hash
2: weighted round-robin
|
void |
setNote(String Note)
Set Domain name remarks
|
void |
setPorts(PortItem[] Ports)
Set Service port list configuration
NginxServerId: fill in '0' in this function
Port: listening port number
Protocol: port protocol
UpstreamPort: same as Port
UpstreamProtocol: same as Protocol
|
void |
setPrivateKey(String PrivateKey)
Set When CertType=1, this parameter is required, indicating the private key of the self-owned certificate.
|
void |
setProbeStatus(Long ProbeStatus)
Set 0: disable probe test; 1: enable probe test.
|
void |
setProxyBuffer(Long ProxyBuffer)
Set Whether to enable caching.
|
void |
setProxyReadTimeout(Long ProxyReadTimeout)
Set Read timeout between WAF and upstream server, 300s by default.
|
void |
setProxySendTimeout(Long ProxySendTimeout)
Set WAF and upstream server write timeout, 300s by default.
|
void |
setResourceId(String ResourceId)
Set To be deprecated, not required.
|
void |
setSniHost(String SniHost)
Set When SniType=3, this parameter is required, indicating a custom SNI;
|
void |
setSniType(Long SniType)
Set SNI type during WAF sending request to upstream
0: Disable SNI and do not configure server_name in client_hello.
|
void |
setSrcList(String[] SrcList)
Set Upstream 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
|
void |
setUpstreamDomain(String UpstreamDomain)
Set Upstream domain when proxy to upstream by domain.
|
void |
setUpstreamHost(String UpstreamHost)
Set Custom upstream host.
|
void |
setUpstreamScheme(String UpstreamScheme)
Set Upstream protocol for HTTPS when the service is configured with an HTTPS port
http: Use the HTTP protocol for upstream.
|
void |
setUpstreamType(Long UpstreamType)
Set Upstream type
0: proxy to upstream by IP address
1: proxy to upstream by domain name
|
void |
setWeights(Long[] Weights)
Set Weight of each IP in the back-to-source IP List, corresponding to SrcList.
|
void |
setXFFReset(Long XFFReset)
Set Whether to enable XFF reset
0: disable
1: enable
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public AddSpartaProtectionRequest()
public AddSpartaProtectionRequest(AddSpartaProtectionRequest source)
public String getDomain()
public void setDomain(String Domain)
Domain
- Domain requiring protectionpublic 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 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 a custom header in ip_headers to obtain the client IP addresspublic Long getUpstreamType()
public void setUpstreamType(Long UpstreamType)
UpstreamType
- Upstream type
0: proxy to upstream by IP address
1: proxy to upstream by domain namepublic Long getIsWebsocket()
public void setIsWebsocket(Long IsWebsocket)
IsWebsocket
- Whether to enable websocket
0: disable
1: enablepublic String getLoadBalance()
public void setLoadBalance(String LoadBalance)
LoadBalance
- Load balancing policy for upstream
0: round-robin
1: IP hash
2: weighted round-robinpublic PortItem[] getPorts()
public void setPorts(PortItem[] Ports)
Ports
- Service port list configuration
NginxServerId: fill in '0' in this function
Port: listening port number
Protocol: port protocol
UpstreamPort: same as Port
UpstreamProtocol: same as Protocolpublic String getIsKeepAlive()
public void setIsKeepAlive(String IsKeepAlive)
IsKeepAlive
- (Required) Whether to enable persistent connection
0: non-persistent connection
1: persistent connectionpublic String getInstanceID()
public void setInstanceID(String InstanceID)
InstanceID
- (Required) Instance ID of the domain namepublic String getCert()
public void setCert(String Cert)
Cert
- When CertType is 1, this parameter is required, indicating the self-owned certificate chainpublic String getPrivateKey()
public void setPrivateKey(String PrivateKey)
PrivateKey
- When CertType=1, this parameter is required, indicating the private key of the self-owned certificate.public 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 getResourceId()
public void setResourceId(String ResourceId)
ResourceId
- To be deprecated, not required. WAF resource ID.public String[] getIpHeaders()
public void setIpHeaders(String[] IpHeaders)
IpHeaders
- When IsCdn is 3, this parameter is required, indicating a custom header.public String getUpstreamScheme()
public void setUpstreamScheme(String UpstreamScheme)
UpstreamScheme
- Upstream protocol for HTTPS when the service is configured with an HTTPS port
http: Use the HTTP protocol for upstream. It is used together with HttpsUpstreamPort.
https: Use the HTTPS protocol for upstream.public String getHttpsUpstreamPort()
public void setHttpsUpstreamPort(String HttpsUpstreamPort)
HttpsUpstreamPort
- HTTPS upstream port, required only when UpstreamScheme is httppublic Long getIsGray()
public void setIsGray(Long IsGray)
IsGray
- To be deprecated, can be left blank. Whether to enable grayscale: 0 indicates not to enable grayscale.public String[] getGrayAreas()
public void setGrayAreas(String[] GrayAreas)
GrayAreas
- To be deprecated, can be left blank. Grayscale area.public Long getHttpsRewrite()
public void setHttpsRewrite(Long HttpsRewrite)
HttpsRewrite
- (Required) Whether to enable forced redirection from HTTP to HTTPS
0: do not force redirect
1: enable forced redirectpublic String getUpstreamDomain()
public void setUpstreamDomain(String UpstreamDomain)
UpstreamDomain
- Upstream domain when proxy to upstream by domain. When UpstreamType=1, this field needs to be filledpublic String[] getSrcList()
public void setSrcList(String[] SrcList)
SrcList
- Upstream IP list when IP is back to source. When UpstreamType=0, this field is requiredpublic Long getIsHttp2()
public void setIsHttp2(Long IsHttp2)
IsHttp2
- (Required) Whether to enable HTTP2. You should enable HTTPS as well.
0: disable
1: enablepublic String getEdition()
public void setEdition(String Edition)
Edition
- WAF instance type. This parameter will be deprecated in later versions and is not required in the current version.
sparta-waf: SaaS WAF
clb-waf: CLB WAF
cdn-waf: web protection capability on CDNpublic Long getAnycast()
public void setAnycast(Long Anycast)
Anycast
- To be deprecated, currently just fill in 0. Anycast IP type switch: 0 Ordinary IP, 1 Anycast IPpublic Long[] getWeights()
public void setWeights(Long[] Weights)
Weights
- Weight of each IP in the back-to-source IP List, corresponding to SrcList. Required only when UpstreamType is 0, and SrcList contains multiple IPs, and LoadBalance is 2; otherwise, fill in [ ].public Long getActiveCheck()
public void setActiveCheck(Long ActiveCheck)
ActiveCheck
- (Required) Whether to enable active health check
0: disable
1: enablepublic Long getTLSVersion()
public void setTLSVersion(Long TLSVersion)
TLSVersion
- TLS version informationpublic Long getCipherTemplate()
public void setCipherTemplate(Long CipherTemplate)
CipherTemplate
- (Required) Cipher suite template
0: default template
1: general template
2: security template
3: custom templatepublic 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.public Long getProxyReadTimeout()
public void setProxyReadTimeout(Long ProxyReadTimeout)
ProxyReadTimeout
- Read timeout between WAF and upstream server, 300s by default.public Long getProxySendTimeout()
public void setProxySendTimeout(Long ProxySendTimeout)
ProxySendTimeout
- WAF and upstream server write timeout, 300s by default.public Long getSniType()
public void setSniType(Long SniType)
SniType
- SNI type during WAF sending request to upstream
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.public String getSniHost()
public void setSniHost(String SniHost)
SniHost
- When SniType=3, this parameter is required, indicating a custom SNI;public Long getXFFReset()
public void setXFFReset(Long XFFReset)
XFFReset
- Whether to enable XFF reset
0: disable
1: enablepublic String getNote()
public void setNote(String Note)
Note
- Domain name remarkspublic String getUpstreamHost()
public void setUpstreamHost(String UpstreamHost)
UpstreamHost
- Custom upstream host. The default value is an empty string, indicating that protected domain is used as the upstream host.public Long getProxyBuffer()
public void setProxyBuffer(Long ProxyBuffer)
ProxyBuffer
- Whether to enable caching. 0: disable; 1: enable.public Long getProbeStatus()
public void setProbeStatus(Long ProbeStatus)
ProbeStatus
- 0: disable probe test; 1: enable probe test. The test is enabled by default.Copyright © 2024. All rights reserved.