Web 应用防火墙编辑精准白名单-API 文档-文档中心-腾讯云

1. 接口描述

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

编辑精准白名单

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyCustomWhiteRule。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。
Domain	是	String	编辑的域名示例值：test.qcloudwaf.com
RuleId	是	Integer	编辑的规则ID 示例值：1100000001
RuleName	是	String	编辑的规则名称示例值：name
Bypass	是	String	放行时是否继续执行其它检查逻辑，继续执行地域封禁防护：geoip、继续执行CC策略防护：cc、继续执行WEB应用防护：owasp、继续执行AI引擎防护：ai、继续执行信息防泄漏防护：antileakage。如果勾选多个，则以“，”串接。示例值：cc
SortId	是	Integer	优先级，1~100的整数，数字越小，代表这条规则的执行优先级越高。示例值：100
ExpireTime	是	Integer	规则生效截止时间，0：永久生效，其它值为对应时间的时间戳。示例值：0
Strategies.N	是	Array of Strategy	匹配条件数组示例值：[ { "Field": "URL", "Arg": "", "CompareFunc": "eq", "Content": "/acl" } ]
JobType	否	String	规则执行的方式，TimedJob为定时执行，CronJob为周期执行示例值：TimedJob
JobDateTime	否	JobDateTime	定时任务配置示例值：{ "Timed": [ { "StartDateTime": 1711618518, "EndDateTime": 1711918518 } ], "Cron": [ { "Day": 12, "WDay": 2, "StartTime": "12:11", "EndTime": "21:00" } ], "TimeTZone": "UTC+8" }

3. 输出参数

参数名称	类型	描述
Success	ResponseCode	操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败示例值：{"Code":"Success","Message":"Success"}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 编辑精准白名单规则

输入示例

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

{
    "RuleId": 1100000001,
    "Domain": "waf.tencentcloudapi.com",
    "RuleName": "rulename",
    "Bypass": "cc",
    "SortId": 100,
    "ExpireTime": 0,
    "Strategies": [
        {
            "Field": "COOKIE",
            "CompareFunc": "eq",
            "Content": "cookie_key",
            "Arg": "cookie_value"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
        "Success": {
            "Message": "Success",
            "Code": "Success"
        }
    }
}

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
InvalidParameter	参数错误。
UnsupportedOperation	操作不支持。