一、1. 接口描述
Waf 批量防护IP黑白名单查询
默认接口请求频率限制：20次/秒。
二、2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
| Action | 是 | String | 公共参数，本接口取值：DescribeBatchIpAccessControl。 |
| Version | 是 | String | 公共参数，本接口取值：2018-01-25。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。 |
| Filters.N | 是 | Array of FiltersItemNew | 筛选条件，支持 ActionType（可选的值为40：白名单，42：黑名单），ValidStatus（可选的值0：全部，1：生效，2：过期），Ip，Domains（域名列表），GroupId（防护对象组ID），GroupName（防护对象组名），RuleId（规则ID），TimerType（生效方式，1：永久生效，2：定时生效，3：按周周期生效，4：按月周期生效）示例值：[{"Name":"ValidStatus","Values":["1"],"ExactMatch":true},{"ExactMatch":false,"Name":"ActionType","Values":["42"]}] |
| OffSet | 否 | Integer | 偏移示例值：0 |
| Limit | 否 | Integer | 限制示例值：20 |
| Sort | 否 | String | 排序参数示例值：ts_version:-1 |
三、3. 输出参数
| 参数名称 | 类型 | 描述 |
| Data | BatchIpAccessControlData | 输出 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
四、输入示例
POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchIpAccessControl
<公共请求参数>
{
"Sort": "ts_version:-1",
"Limit": 20,
"Filters": [
{
"Values": [
"Domain"
],
"Name": "www.q.com",
"ExactMatch": true
}
],
"OffSet": 0
}
五、输出示例
{
"Response": {
"Data": {
"Res": [
{
"ActionType": 42,
"Ip": "1.1.1.1",
"Note": "remark",
"Source": "custom",
"TsVersion": 1579074751421,
"ValidTs": 1579017599,
"Hosts": [
"www.q.com",
"www.b.com"
]
}
],
"TotalCount": 1
},
"RequestId": "c937ce96-cf53-4df8-b288-07c6e092072d"
}
}
六、腾讯云 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
九、命令行工具
·Tencent Cloud CLI 3.0
十、6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
| InternalError | 内部错误。 |
| InternalError.DBErr | DBErr |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |