1. 接口描述
接口请求域名： waf.tencentcloudapi.com 。
批量IP黑白名单新增接口
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：CreateBatchIpAccessControl。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。 |
| IpList.N | 是 | Array of String | IP参数列表 示例值：["192.16.8.1.1","192.168.2.1"] |
| JobType | 是 | String | 规则执行的方式，TimedJob为定时执行，CronJob为周期执行 示例值：TimedJob |
| JobDateTime | 是 | JobDateTime | 定时任务配置 示例值：{"Timed":[{"StartDateTime":1711618518,"EndDateTime":1711918518}],"Cron":[{"Day":12,"WDay":2,"StartTime":"12:11","EndTime":"21:00"}],"TimeTZone":"UTC+8"} |
| ActionType | 是 | Integer | 42为黑名单，40为白名单 示例值：42 |
| GroupIds.N | 否 | Array of Integer | 防护对象组ID列表，如果绑定的是防护对象组，和Domains参数二选一 示例值：[11101, 11102] |
| Domains.N | 否 | Array of String | 域名列表，如果绑定的是批量域名，和GroupIds参数二选一 示例值：["www.qcloudwaf.com","test.waf.com"] |
| Note | 否 | String | 备注 示例值：备注 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Failed | Array of BatchDomainResult | 添加失败的域名列表，如果非空则表示有域名添加失败，整个批量规则添加失败，否则则表示批量规则添加成功。 示例值：[{"Domain":"www.testwaf.com", "Message":"域名IP个数超过规格"}] |
| RuleId | Integer | 添加成功的批量规则ID 示例值：11101 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 新增批量IP黑白名单
输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateBatchIpAccessControl
<公共请求参数>
{
"IpList": [
"12.32.4.3"
],
"ActionType": 42,
"Domains": [
"www.testwaf.com",
"www.testwaf2.com"
],
"Note": "",
"JobType": "TimedJob",
"JobDateTime": {
"Timed": [
{
"StartDateTime": 0,
"EndDateTime": 0
}
],
"TimeTZone": "UTC+8"
}
}输出示例
{
"Response": {
"RequestId": "5331fe64-a3a5-49c4-8c4b-ada147d91403",
"RuleId": 5500921210
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.TheNumberOfAddedBlackAndWhiteListExceedsTheUpperLimit | 黑白名单添加数超过上限 |
| InternalError | 内部错误。 |
| InternalError.DBErr | DBErr |
| LimitExceeded | 超过配额限制。 |
| LimitExceeded.SpecificationErr | SpecificationErr |
| UnsupportedOperation | 操作不支持。 |
