Web 应用防火墙查询限流规则列表接口

1. 接口描述

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

查询限流规则列表接口

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeRateLimitsV2。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	域名示例值：www.xxxx.com
Id	否	Integer	限流规则ID 示例值：400000001
Name	否	String	规则名示例值：Test
Method	否	String	限流接口名示例值：methodname
LimitObject	否	String	限流对象，可选API、Domain 示例值：API
Status	否	Integer	规则开关，0表示关闭，1表示开启示例值：0
Order	否	String	排序方式，可选desc、asc 示例值：desc
By	否	String	排序字段，可选Priority、Timestamp、ID 示例值：Priority
Offset	否	Integer	分页的起始位置示例值：0
Limit	否	Integer	每页行数示例值：100
Filters.N	否	Array of FiltersItemNew	过滤器示例值：[{"Name": "Status", "Values": ["0"], "ExactMatch": true}]

3. 输出参数

参数名称	类型	描述
Total	Integer	查询结果中规则数量示例值：10
BaseInfo	RateLimitCommonRsp	操作结果示例值：{"Code": 0,"Info": "success"}
RateLimits	Array of LimitRuleV2	规则列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeLimitRules

输入示例

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

{
    "Domain": "www.test.com",
    "Id": 0,
    "Name": "testname",
    "Method": "",
    "LimitObject": "API",
    "Status": 0,
    "Order": "desc",
    "By": "",
    "Offset": 0,
    "Limit": 10,
    "Filters": [
        {
            "Name": "status",
            "Values": [
                "0"
            ],
            "ExactMatch": true
        }
    ]
}

输出示例

{
    "Response": {
        "Total": 0,
        "BaseInfo": {
            "Code": 1,
            "Info": "success"
        },
        "RateLimits": [
            {
                "LimitRuleID": 400000023,
                "Name": "testname",
                "Priority": 50,
                "Status": 0,
                "TsVersion": 0,
                "LimitObject": "API",
                "LimitMethod": {
                    "Method": "GET",
                    "Type": "EXACT"
                },
                "LimitPaths": {
                    "Path": "/url",
                    "Type": "EXACT"
                },
                "LimitHeaders": [
                    {
                        "Key": "",
                        "Value": "v1,v2",
                        "Type": "IN"
                    }
                ],
                "LimitWindow": {
                    "Second": 0,
                    "Minute": 10
                },
                "LimitStrategy": 0,
                "LimitHeaderName": {}
            }
        ],
        "RequestId": "546b2091-1a59-4bd9-818d-47ab565102d9"
    }
}

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. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见公共错误码。