Web 应用防火墙添加批量精准白名单规则

1. 接口描述

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

增加批量精准白名单规则

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：AddBatchCustomWhiteRule。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Name	是	String	规则名称示例值：精准白名单
SortId	是	Integer	优先级示例值：100
Strategies.N	是	Array of Strategy	策略详情示例值：[ { "Field": "URL", "Arg": "", "CompareFunc": "eq", "Content": "/acl" } ]
Bypass.N	是	Array of String	加白的模块，owasp：Web防护-规则引擎、ai：Web防护-AI引擎、ip_auto_deny：IP封禁、geoip：访问控制-地域封禁、acl：访问控制-自定义规则、cc：CC防护、antileakage：信息防泄漏防护、bwip：IP黑白名单、botrpc：BOT防护、api：API安全、applet：小程序防护示例值：["owasp","ip_auto_deny"]
JobType	是	String	规则执行的方式，TimedJob为定时执行，CronJob为周期执行示例值：TimedJob
JobDateTime	是	JobDateTime	定时任务配置
Domains.N	否	Array of String	域名列表，如果绑定的是批量域名，和GroupIds参数二选一示例值：["config.qcloudwaf.com","test.zjw.com"]
GroupIds.N	否	Array of Integer	防护对象组ID列表，如果绑定的是防护对象组，和Domains参数二选一示例值：[11101, 11102]
LogicalOp	否	String	匹配条件的逻辑关系，支持and、or，分别表示多个逻辑匹配条件是与、或的关系示例值：and

3. 输出参数

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

4. 示例

示例1 添加精准白名单

输入示例

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

{
    "Name": "name",
    "SortId": "100",
    "Domains": [
        "waf.com"
    ],
    "Bypass": [
        "cc",
        "acl"
    ],
    "JobType": "TimedJob",
    "JobDateTime": {
        "Timed": [
            {
                "StartDateTime": 1711618518,
                "EndDateTime": 1711918518
            }
        ],
        "TimeTZone": "UTC+8"
    },
    "Strategies": [
        {
            "Field": "COOKIE",
            "CompareFunc": "eq",
            "Content": "cookie_value",
            "Arg": "cookie_key"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
        "RuleId": 7025
    }
}

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.TheNameOfTheBatchProtectionRuleCannotBeEmpty	批量防护规则名称不能为空
InternalError	内部错误。
InternalError.DBErr	DBErr
InvalidParameter	参数错误。
LimitExceeded	超过配额限制。
LimitExceeded.SpecificationErr	SpecificationErr
UnsupportedOperation	操作不支持。

添加批量精准白名单规则

本页目录：