修改域名配置
最近更新时间: 2024-10-18 10:38:33
1. 接口描述
接口请求域名： ngwaf.api3.fincloud.tencent.cn。
修改域名配置
默认接口请求频率限制：2次/秒。
接口更新时间：2023-10-18 15:01:19。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：ModifySpartaProtection |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-01-25 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| IsCdn | 否 | 否 | Int64 | 此参数对外不可见。 表示是否开启了CDN代理 |
| LoadBalance | 否 | 否 | Int64 | 此参数对外不可见。 负载均衡策略，0表示轮徇，1表示IP hash |
| IsGray | 否 | 否 | Int64 | 此参数对外不可见。 是否灰度 |
| ProxySendTimeout | 否 | 否 | Int64 | 此参数对外不可见。 300s |
| IsHttp2 | 否 | 否 | Int64 | 此参数对外不可见。 是否开启HTTP2，1表示开启，0表示不开启http2。开启HTTP2需要HTTPS支持 |
| IpHeaders | 否 | 否 | Array of String | 此参数对外不可见。 IsCdn=3时，需要填此参数，表示自定义header |
| TLSVersion | 否 | 否 | Int64 | 此参数对外不可见。 TLS版本信息 |
| SniType | 否 | 否 | Int64 | 此参数对外不可见。 0:关闭SNI；1:开启SNI，SNI=源请求host；2:开启SNI，SNI=修改为源站host；3：开启SNI，自定义host，SNI=SniHost； |
| Domain | 是 | 否 | String | 此参数对外不可见。 域名 |
| UpstreamScheme | 否 | 否 | String | 此参数对外不可见。 HTTPS回源协议 |
| UpstreamType | 否 | 否 | Int64 | 此参数对外不可见。 回源类型，0表示通过IP回源,1 表示通过域名回源 |
| UpstreamDomain | 否 | 否 | String | 此参数对外不可见。 UpstreamType=1时，填次字段表示回源域名 |
| Edition | 否 | 否 | String | 此参数对外不可见。 WAF版本 |
| Ports | 否 | 否 | Array of SpartaProtectionPort | 此参数对外不可见。 端口信息 |
| Weights | 否 | 否 | Array of Int64 | 此参数对外不可见。 src的权重 |
| HttpsRewrite | 否 | 否 | Uint64 | 此参数对外不可见。 表示是否强制跳转到HTTPS，1表示开启，0表示不开启 |
| Ciphers | 否 | 否 | Array of Int64 | 此参数对外不可见。 加密套件信息 |
| ProxyReadTimeout | 否 | 否 | Int64 | 此参数对外不可见。 300s |
| XFFReset | 否 | 否 | Int64 | 此参数对外不可见。 0:关闭xff重置；1:开启xff重置，只有在IsCdn=0时可以开启 |
| SrcList | 否 | 否 | Array of String | 此参数对外不可见。 UpstreamType=0时，填次字段表示回源ip |
| IsKeepAlive | 否 | 否 | String | 此参数对外不可见。 长短连接标志，仅IP回源时有效 |
| CipherTemplate | 否 | 否 | Int64 | 此参数对外不可见。 0:不支持选择：默认模板 1:通用型模板 2:安全型模板 3:自定义模板 |
| SniHost | 否 | 否 | String | 此参数对外不可见。 SniType=3时，需要填此参数，表示自定义的host； |
| Cert | 否 | 否 | String | 此参数对外不可见。 CertType=1时，需要填次参数，表示证书内容 |
| PrivateKey | 否 | 否 | String | 此参数对外不可见。 CertType=1时，需要填次参数，表示证书的私钥 |
| SSLId | 否 | 否 | String | 此参数对外不可见。 CertType=2时，需要填次参数，表示证书的ID |
| HttpsUpstreamPort | 否 | 否 | String | 此参数对外不可见。 HTTPS回源端口,仅UpstreamScheme为http时需要填当前字段 |
| InstanceID | 否 | 否 | String | 此参数对外不可见。 实例id |
| Anycast | 否 | 否 | Int64 | 此参数对外不可见。 是否为Anycast ip类型：1 Anycast 0 普通ip |
| DomainId | 否 | 否 | String | 此参数对外不可见。 域名ID |
| CertType | 否 | 否 | Int64 | 此参数对外不可见。 证书类型，0表示没有证书，CertType=1表示自有证书,2 为托管证书 |
| IsWebsocket | 否 | 否 | Int64 | 此参数对外不可见。 是否开启WebSocket， 1：开启WebSocket，0：不开启WebSocket |
| ActiveCheck | 否 | 否 | Int64 | 此参数对外不可见。 是否开启源站的主动健康检测，1表示开启，0表示不开启 |
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.SupportTLSConfFailed | |
| InternalError.AsynchronousCallFailed | |
| FailedOperation.MysqlDBOperationFailed |