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

1. 接口描述

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

Waf ip黑白名单查询

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeIpAccessControl。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	域名示例值：test.testwaf.com
Count	是	Integer	计数标识示例值：1
ActionType	否	Integer	动作，40表示查询白名单，42表示查询黑名单示例值：40
CtsMin	否	Integer	最小创建时间的时间戳示例值：1643594882000
CtsMax	否	Integer	最大创建时间的时间戳示例值：1646273282000
OffSet	否	Integer	分页偏移量，取Limit整数倍。最小值为0，最大值= Total/Limit向上取整示例值：0
Limit	否	Integer	每页返回的数量，默认为20 示例值：20
Source	否	String	来源示例值：custom
Sort	否	String	排序参数示例值：ts_version:-1
Ip	否	String	IP 示例值：1.1.1.1
ValidStatus	否	Integer	生效状态示例值：1
ValidTimeStampMin	否	String	最小有效时间的时间戳示例值：1674958082000
ValidTimeStampMax	否	String	最大有效时间的时间戳示例值：1674958082000
RuleId	否	Integer	规则ID 示例值：551024411
TimerType	否	Integer	定时任务类型筛选0 1 2 3 4 示例值：1

3. 输出参数

参数名称	类型	描述
Data	IpAccessControlData	输出示例值：{ "Res": [ { "ActionType": 40, "Ip": "1.1.1.234", "Note": "测试白", "Source": "custom", "TsVersion": 1675087938186, "ValidTs": 2019571199 } ], "TotalCount": 1 }, "RequestId": "4afdae60-51ec-44f0-b09b-faf904ae6c6b" }
UsedTotal	Integer	已经使用的IP黑白名单的IP总数示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 Waf ip黑白名单查询

Waf ip黑名单查询

输入示例

https://waf.tencentcloudapi.com/?Action=DescribeIpAccessControl
&Domain=www.test.com
&Count=1
&ActionType=42
&Limit=20
&OffSet=0
&Sort=ts_version:-1
&<公共请求参数>

输出示例

{
    "Response": {
        "Data": {
            "Res": [
                {
                    "ActionType": 42,
                    "Ip": "1.1.1.1",
                    "Note": "note",
                    "Source": "custom",
                    "TsVersion": 1579074751421,
                    "ValidTs": 1579017599
                }
            ],
            "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黑白名单查询

本页目录：