1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
Waf IP黑白名单Upsert接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpsertIpAccessControl。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Domain | 是 | String | 具体域名如：test.qcloudwaf.com 全局域名为：global 示例值：test.qcloudwaf.com |
| Items.N | 是 | 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）） 示例值：[{ip:1.2.3.4,source:custom,note:test,action:42,valid_ts:165009}] |
| InstanceId | 否 | String | 实例Id 示例值：waf_2kxq5hru00n2dxmx |
| Edition | 否 | String | WAF实例类型，sparta-waf表示SAAS型WAF，clb-waf表示负载均衡型WAF 示例值：clb-waf |
| SourceType | 否 | String | 是否为多域名黑白名单，当为多域名的黑白名单时，取值为batch，否则为空 示例值：batch |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| FailedItems | String | 添加或修改失败的条目 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.1.1.1 |
| FailedCount | Integer | 添加或修改失败的数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：0 |
| Ids | Array of String | 添加或修改的IP数据Id列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["65477a5325b70461ccfaccfc", "65477a8125b70461ccfacd1c"] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 UpsertIpAccessControl
IP黑白名单Upsert接口
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpsertIpAccessControl
<公共请求参数>
{
"Domain": "test.qcloudwaf.com",
"Items": [
"{\"ip\":\"1.2.3.4\",\"source\":\"custom\",\"note\":\"test\",\"action\":42,\"valid_ts\":1650095068}"
],
"Edition": "clb-waf"
}输出示例
{
"Response": {
"FailedCount": 0,
"FailedItems": "",
"RequestId": "fea2e723-002b-40e6-8297-7c54455cb7d6"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.TheNumberOfAddedBlackAndWhiteListExceedsTheUpperLimit | 黑白名单添加数超过上限 |
| InternalError | 内部错误。 |
| InternalError.DBErr | DBErr |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.SpecificationErr | SpecificationErr |
| UnsupportedOperation | 操作不支持。 |