文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>API 中心>Web 应用防火墙>防护设置相关接口>批量自定义规则列表接口

批量自定义规则列表接口

最近更新时间：2026-04-23 04:00:46

我的收藏

本页目录：

1. 接口描述

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

批量自定义规则列表接口

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBatchCustomRuleList。
Version 是 String 公共参数，本接口取值：2018-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-chengdu, ap-guangzhou, ap-seoul, ap-singapore 。
Offset 是 Integer 偏移量
示例值：0
Limit 是 Integer 页尺寸

示例值：10
By 是 String 排序字段
"update_time"-更新时间、"expire_time"-过期时间、"sort_id"-优先级、"id"-规则Id、"create_time"-创建时间
示例值：update_time
Order 是 String 排序类型
desc-降序、asc-升序
示例值：asc
DataType 是 String 数据类型 "custom-rule"-自定义规则、"custom-white-rule"-精准白名单
示例值：custom-rule
Filters.N 是 Array of FiltersItemNew 筛选列表

3. 输出参数

参数名称 类型 描述
Data BatchCustomRuleListData 操作成功
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 批量自定义规则列表接口

输入示例

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

{
    "Offset": 0,
    "Limit": 0,
    "By": "abc",
    "Order": "abc",
    "DataType": "abc",
    "Filters": [
        {
            "Name": "abc",
            "Values": [
                "abc"
            ],
            "ExactMatch": true
        }
    ]
}

输出示例

{
    "Response": {
        "Data": {
            "List": [
                {
                    "Id": 1101834050,
                    "ActionType": 1,
                    "Bypass": "",
                    "ExpireTime": 0,
                    "Name": "clb访问测试",
                    "Redirect": "/",
                    "SortId": 40,
                    "Status": 1,
                    "Domains": [
                        "zhenhua1020.qcloudwaf.com"
                    ],
                    "Remark": "",
                    "Strategies": [
                        {
                            "Field": "URL",
                            "Arg": "",
                            "CompareFunc": "contains",
                            "Content": "/ccc/bbb",
                            "CaseNotSensitive": 0
                        }
                    ],
                    "EventId": "",
                    "ValidStatus": 1,
                    "CreateTime": "2024-10-23 15:23:51",
                    "UpdateTime": "2024-10-23 16:17:08",
                    "JobType": "TimedJob",
                    "JobDateTime": {
                        "Timed": [
                            {
                                "StartDateTime": 0,
                                "EndDateTime": 0
                            }
                        ],
                        "Cron": null,
                        "TimeTZone": "UTC+8"
                    },
                    "CronType": "-",
                    "Label": "",
                    "PageId": ""
                }
            ],
            "Total": 1
        },
        "RequestId": "1547e8aa-b673-1a81-60ea-c91a2b153940"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError.DBErr DBErr
InvalidParameter 参数错误。
中国站