Web 应用防火墙
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > Web 应用防火墙 > API 文档 > 其他接口 > 添加精准白名单规则

添加精准白名单规则

最近更新时间：2024-03-12 02:04:45

我的收藏

本页目录：

1. 接口描述

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

增加精准白名单规则

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：AddCustomWhiteRule。
Version 是 String 公共参数，本接口取值：2018-01-25。
Region 是 String 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。
Name 是 String 规则名称
SortId 是 String 优先级
ExpireTime 是 String 过期时间
Strategies.N 是 Array of Strategy 策略详情
Domain 是 String 需要添加策略的域名
Bypass 是 String 放行的详情

3. 输出参数

参数名称 类型 描述
Success ResponseCode 操作的状态码，如果所有的资源操作成功则返回的是成功的状态码，如果有资源操作失败则需要解析Message的内容来查看哪个资源失败
RuleId Integer 添加成功的规则ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：7025
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 增加精准白名单规则

输入示例

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

{
    "Name": "test",
    "SortId": "100",
    "ExpireTime": "",
    "Domain": "waf.tencentcloudapi.com",
    "Bypass": "",
    "Strategies": [
        {
            "Field": "COOKIE",
            "CompareFunc": "eq",
            "Content": "abc",
            "Arg": ""
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "5d207f4f-0d41-4f5d-bce2-0320090c98d8",
        "RuleId": 7025,
        "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。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
LimitExceeded.SpecificationErr SpecificationErr
UnsupportedOperation 操作不支持。
中国站