Web 应用防火墙查询CC规则-防护设置相关接口-API 中心-腾讯云

1. 接口描述

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

根据多条件查询CC规则

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeCCRuleList。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	需要查询的API所属的域名示例值：test.qcloudwaf.com
Offset	是	Integer	偏移示例值：1
Limit	是	Integer	容量示例值：1
By	是	String	目前支持根据ts_version排序示例值：ts_version
Filters.N	否	Array of FiltersItemNew	过滤数组,name可以是如下的值： RuleID,ParamName,Url,Action,Method,Source,Status 示例值：[{"Name": "ActionType", "Values": ["20"], "ExactMatch": true}]
Order	否	String	asc或者desc 示例值：asc

3. 输出参数

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

4. 示例

示例1 根据URL查询API规则

输入示例

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

{
    "Domain": "www.testwaf.com",
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "clb",
                "saas"
            ],
            "Name": "InstanceType",
            "ExactMatch": true
        }
    ],
    "Offset": 1,
    "By": "ts_version"
}

输出示例

{
    "Response": {
        "Data": {
            "Res": [
                {
                    "ActionType": 22,
                    "Advance": 0,
                    "Interval": 60,
                    "Limit": 60,
                    "MatchFunc": 0,
                    "Name": "ccRuleName",
                    "Priority": 50,
                    "Options": "[{\"key\":\"Post\",\"args\":[\"a2V5YQ=dmFsdWVh\"],\"match\":\"0\",\"encodeflag\":true}]",
                    "Status": 1,
                    "TsVersion": 1579058116920,
                    "Url": "///",
                    "ValidTime": 600,
                    "RuleId": 1900009616,
                    "EventId": "12983ac"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "1cc54bf4-cfeb-40cc-a823-035e52106df9"
    }
}

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	内部错误。
UnsupportedOperation	操作不支持。

查询CC规则

本页目录：