添加SaaS型WAF防护域名
最近更新时间: 2024-09-03 18:49:48
1. 接口描述
接口请求域名： ngwaf.api3.cloud.sunhongs.com。
添加SaaS型WAF防护域名
默认接口请求频率限制：20次/秒。
接口更新时间：2023-12-12 15:03:13。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：AddSpartaProtection |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-01-25 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| UpstreamDomain | 否 | 否 | String | 此参数对外不可见。 域名回源时的回源域名。UpstreamType为1时，需要填充此字段 |
| Weights | 否 | 否 | Array of Int64 | 此参数对外不可见。 回源IP列表各IP的权重，和SrcList一一对应。当且仅当UpstreamType为0，并且SrcList有多个IP，并且LoadBalance为2时需要填写，否则填 [] |
| ActiveCheck | 否 | 否 | Int64 | 此参数对外不可见。 是否开启主动健康检测。 |
| 0：不开启 | ||||
| 1：开启 | ||||
| CipherTemplate | 否 | 否 | Int64 | 此参数对外不可见。 加密套件模板。 |
| 0：不支持选择，使用默认模板 | ||||
| 1：通用型模板 | ||||
| 2：安全型模板 | ||||
| 3：自定义模板 | ||||
| ProxySendTimeout | 否 | 否 | Int64 | 此参数对外不可见。 WAF与源站的写超时时间，默认300s。 |
| SniType | 否 | 否 | Int64 | 此参数对外不可见。 WAF回源时的SNI类型。 |
| 0：关闭SNI，不配置client_hello中的server_name | ||||
| 1：开启SNI，client_hello中的server_name为防护域名 | ||||
| 2：开启SNI，SNI为域名回源时的源站域名 | ||||
| 3：开启SNI，SNI为自定义域名 | ||||
| PrivateKey | 否 | 否 | String | 此参数对外不可见。 CertType为1时，需要填充此参数，表示自有证书的私钥 |
| HttpsUpstreamPort | 否 | 否 | String | 此参数对外不可见。 HTTPS回源端口,仅UpstreamScheme为http时需要填当前字段 |
| XFFReset | 否 | 否 | Int64 | 此参数对外不可见。 是否开启XFF重置。 |
| 0：关闭 | ||||
| 1：开启 | ||||
| GrayAreas | 否 | 否 | Array of String | 此参数对外不可见。 待废弃，可不填。灰度的地区 |
| Cert | 否 | 否 | String | 此参数对外不可见。 CertType为1时，需要填充此参数，表示自有证书的证书链 |
| SSLId | 否 | 否 | String | 此参数对外不可见。 CertType为2时，需要填充此参数，表示腾讯云SSL平台托管的证书id |
| TLSVersion | 否 | 否 | Int64 | 此参数对外不可见。 TLS版本信息 |
| IsWebsocket | 是 | 否 | Int64 | 此参数对外不可见。 是否开启WebSocket支持。 |
| 0：关闭 | ||||
| 1：开启 | ||||
| HttpsRewrite | 否 | 否 | Int64 | 此参数对外不可见。 是否开启HTTP强制跳转到HTTPS。 |
| 0：不强制跳转 | ||||
| 1：开启强制跳转 | ||||
| Ciphers | 否 | 否 | Array of Int64 | 此参数对外不可见。 自定义的加密套件列表。CipherTemplate为3时需要填此字段，表示自定义的加密套件，值通过DescribeCiphersDetail接口获取。 |
| UpstreamScheme | 否 | 否 | String | 此参数对外不可见。 服务配置有HTTPS端口时，HTTPS的回源协议。 |
| http：使用http协议回源，和HttpsUpstreamPort配合使用 | ||||
| https：使用https协议回源 | ||||
| IsKeepAlive | 否 | 否 | String | 此参数对外不可见。 是否开启长连接。 |
| 0： 短连接 | ||||
| 1： 长连接 | ||||
| CertType | 是 | 否 | Int64 | 此参数对外不可见。 证书类型。 |
| 0：仅配置HTTP监听端口，没有证书 | ||||
| 1：证书来源为自有证书 | ||||
| 2：证书来源为托管证书 | ||||
| ResourceId | 否 | 否 | String | 此参数对外不可见。 待废弃，可不填。Waf的资源ID。 |
| Anycast | 否 | 否 | Int64 | 此参数对外不可见。 待废弃，目前填0即可。anycast IP类型开关： 0 普通IP 1 Anycast IP |
| IsCdn | 是 | 否 | Int64 | 此参数对外不可见。 waf前是否部署有七层代理服务。 |
| 0：没有部署代理服务 | ||||
| 1：有部署代理服务，waf将使用XFF获取客户端IP | ||||
| 2：有部署代理服务，waf将使用remote_addr获取客户端IP | ||||
| 3：有部署代理服务，waf将使用ip_headers中的自定义header获取客户端IP | ||||
| Ports | 否 | 否 | Array of PortItem | 此参数对外不可见。 服务端口列表配置。 |
| NginxServerId：新增域名时填'0' | ||||
| Port：监听端口号 | ||||
| Protocol：端口协议 | ||||
| UpstreamPort：与Port相同 | ||||
| UpstreamProtocol：与Protocol相同 | ||||
| SrcList | 否 | 否 | Array of String | 此参数对外不可见。 IP回源时的回源IP列表。UpstreamType为0时，需要填充此字段 |
| SniHost | 否 | 否 | String | 此参数对外不可见。 SniType为3时，需要填此参数，表示自定义的SNI； |
| UpstreamType | 是 | 否 | Int64 | 此参数对外不可见。 回源类型。 |
| 0：通过IP回源 | ||||
| 1：通过域名回源 | ||||
| IsHttp2 | 否 | 否 | Int64 | 此参数对外不可见。 是否开启HTTP2，需要开启HTTPS协议支持。 |
| 0：关闭 | ||||
| 1：开启 | ||||
| LoadBalance | 是 | 否 | String | 此参数对外不可见。 回源负载均衡策略。 |
| 0：轮询 | ||||
| 1：IP hash | ||||
| 2：加权轮询 | ||||
| Edition | 否 | 否 | String | 此参数对外不可见。 待废弃，可不填。WAF实例类型。 |
| sparta-waf：SAAS型WAF | ||||
| clb-waf：负载均衡型WAF | ||||
| cdn-waf：CDN上的Web防护能力 | ||||
| InstanceID | 否 | 否 | String | 此参数对外不可见。 域名所属实例id |
| ProxyReadTimeout | 否 | 否 | Int64 | 此参数对外不可见。 WAF与源站的读超时时间，默认300s。 |
| Domain | 是 | 否 | String | 此参数对外不可见。 需要防护的域名 |
| IsGray | 否 | 否 | Int64 | 此参数对外不可见。 待废弃，可不填。是否开启灰度，0表示不开启灰度。 |
| IpHeaders | 否 | 否 | Array of String | 此参数对外不可见。 IsCdn为3时，需要填此参数，表示自定义header |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| InvalidParameterValue | |
| MissingParameter | |
| UnknownParameter | |
| InternalError | |
| UnauthorizedOperation | |
| ResourceNotFound | |
| LimitExceeded | |
| ResourceUnavailable | |
| ResourceInsufficient | |
| FailedOperation | |
| ResourceInUse | |
| ResourcesSoldOut | |
| InvalidParameter.UpstreamParameterErr | |
| InvalidParameter.ProtectionDomainParameterErr | |
| InvalidParameter.CertificationParameterErr | |
| InvalidParameter.PortParameterErr | |
| InvalidParameter.TLSParameterErr | |
| InvalidParameter.UnauthorizedOperationParameterErr | |
| InvalidParameter.DomainExceedsLimitErr | |
| InvalidParameter.DomainNotRecord | |
| InternalError.AsynchronousCallFailed | |
| ResourceInUse.EmptyErr | |
| InvalidParameter.XFFResetParameterErr |