Web 应用防火墙批量防护IP黑白名单查询-API 文档-文档中心-腾讯云

1. 接口描述

接口请求域名： waf.tencentcloudapi.com 。

Waf 批量防护IP黑白名单查询

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

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，可选的值为1（生效）0（过期）示例值：[{"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	输出示例值：{ "Res": [ { "Id": "66ac350c8f33c805d6d533ff", "RuleId": 5501677048, "ActionType": 42, "Ip": "4.4.4.4,5.5.5.5", "Note": "", "Source": "batch", "TsVersion": 1722561804743, "CreateTime": 1722561804743, "ValidTs": 2019571199, "Hosts": [ "testwaf.com" ], "IpList": [ "4.4.4.4", "5.5.5.5" ], "JobType": "TimedJob", "JobDateTime": { "Timed": [ { "StartDateTime": 0, "EndDateTime": 0 } ], "Cron": null, "TimeTZone": "UTC+8" }, "CronType": "-", "ValidStatus": 1 }], "TotalCount":1}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 Waf 多域名ip黑白名单查询

输入示例

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"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InternalError.DBErr	DBErr

批量防护IP黑白名单查询

本页目录：