Web 应用防火墙获取批量精准白名单列表

1. 接口描述

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

获取批量精准白名单的规则列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeBatchCustomWhiteRules。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Offset	否	Integer	偏移量，默认为0 示例值：0
Limit	否	Integer	页尺寸，默认为10 示例值：10
By	否	String	排序字段"modify_time"-更新时间、"sort_id"-优先级、"id"-规则Id、"create_time"-创建时间，默认为update_time 示例值：modify_time
Order	否	String	排序类型desc-降序、asc-升序，默认为desc 示例值：desc
Filters.N	否	Array of FiltersItemNew	筛选列表，支持按照 ID：规则RuleId、Domain：生效的域名、Name：规则名称来筛选、ValidStatus：生效状态、Status：开关状态、TimerType：生效方式示例值：[{"Name":"RuleId","Value":"11101"}]

3. 输出参数

参数名称	类型	描述
Data	Array of BatchCustomWhiteRule	批量规则列表
Total	Integer	总数示例值：100
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取批量精准白名单的规则列表

输入示例

POST / HTTP/1.1
Host: waf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBatchCustomWhiteRules
<公共请求参数>

{
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Data": [
            {
                "ID": 11101,
                "Name": "test",
                "SortId": "100",
                "Strategies": [
                    {
                        "Arg": "",
                        "CompareFunc": "ipmatch",
                        "Content": "1.1.1.2",
                        "Field": "IP"
                    }
                ],
                "Bypass": [
                    "geoip",
                    "cc",
                    "owasp"
                ],
                "JobType": "timed",
                "JobDateTime": {
                    "Timed": [
                        {
                            "StartDateTime": 1711618518,
                            "EndDateTime": 1711918518
                        }
                    ]
                },
                "GroupIds": [
                    1101,
                    1102
                ],
                "ValidStatus": 1,
                "CreateTime": "2020-02-20 14:00:12",
                "Status": "1"
            }
        ],
        "Total": 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: 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. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError	内部错误。
InternalError.DBErr	DBErr
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
ResourceNotFound	资源不存在。
UnknownParameter	未知参数错误。

获取批量精准白名单列表

本页目录：