Waf IP黑白名单Upsert接口
最近更新时间: 2024-10-18 10:38:31
1. 接口描述
接口请求域名： ngwaf.api3.fincloud.tencent.cn。
Waf IP黑白名单Upsert接口
默认接口请求频率限制：20次/秒。
接口更新时间：2023-12-12 15:03:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：UpsertIpAccessControl |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-01-25 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Domain | 是 | 否 | String | 此参数对外不可见。 具体域名如：test.qcloudwaf.com |
| 全局域名为：global | ||||
| Items | 是 | 否 | Array of String | 此参数对外不可见。 ip 参数列表，json数组由ip，source，note，action，valid_ts组成。ip对应配置的ip地址，source固定为custom值，note为注释，action值42为黑名单，40为白名单，valid_ts为有效日期，值为秒级时间戳（（如1680570420代表2023-04-04 09:07:00）） |
| Edition | 否 | 否 | String | 此参数对外不可见。 WAF实例类型，sparta-waf表示SAAS型WAF，clb-waf表示负载均衡型WAF |
| SourceType | 否 | 否 | String | 此参数对外不可见。 是否为多域名黑白名单，当为多域名的黑白名单时，取值为batch，否则为空 |
| InstanceId | 否 | 否 | String | 此参数对外不可见。 实例Id |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FailedItems | String | 此参数对外不可见。 添加或修改失败的条目 |
| FailedCount | Int64 | 此参数对外不可见。 添加或修改失败的数目 |
| Ids | String | 此参数对外不可见。 添加或修改的IP数据Id列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | |
| LimitExceeded | |
| UnsupportedOperation | |
| InternalError.DBErr | |
| LimitExceeded.SpecificationErr | |
| FailedOperation.TheNumberOfAddedBlackAndWhiteListExceedsTheUpperLimit |