Web 应用防火墙获取信息防泄漏规则列表-防护设置相关接口-API 中心-腾讯云

1. 接口描述

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

取得信息防泄漏规则列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAntiInfoLeakageRules。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul 。
Domain	是	String	域名示例值：test.com
Offset	否	Integer	翻页支持，读取偏移示例值：1
Limit	否	Integer	翻页支持，读取长度限制示例值：10
Order	否	String	排序方式，asc或者desc 示例值：asc
Filters.N	否	Array of FiltersItemNew	过滤器,可以允许如下的值： RuleId,Match_field,Name,Action,Status 示例值：[{"Name":"RuleId", "Values":["111011"], "ExactMatch":true}]

3. 输出参数

参数名称	类型	描述
Total	Integer	记录条数示例值：1
RuleList	Array of DescribeAntiLeakageItem	规则列表示例值：[ { "RuleId": 3100175505, "Name": "0527", "Status": 1, "Action": "0", "CreateTime": "2024-05-27T21:28:08+08:00", "ModifyTime": "2024-05-27T21:28:08+08:00", "Uri": "/abc", "Strategies": [ { "Field": "information", "CompareFunc": "contains", "Content": "idcard" } ] }, { "RuleId": 3100144126, "Name": "防泄露", "Status": 1, "Action": "0", "CreateTime": "2024-04-26T11:18:05+08:00", "ModifyTime": "2024-04-26T11:24:23+08:00", "Uri": "/info", "Strategies": [ { "Field": "information", "CompareFunc": "contains", "Content": "bankcard" } ] }]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取信息防泄漏规则列表

获取信息防泄漏规则列表

输入示例

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

{
    "Domain": "www.testwaf.com",
    "Order": "Desc",
    "Limit": 1,
    "Filters": [
        {
            "Values": [
                "0"
            ],
            "Name": "Action",
            "ExactMatch": true
        }
    ],
    "Offset": 1
}

输出示例

{
    "Response": {
        "Total": 1,
        "RequestId": "66ec4266-fce2-4238-bb69-8b99f3b19ad0",
        "RuleList": [
            {
                "Status": 1,
                "Name": "RuleName",
                "RuleId": 1,
                "Uri": "/url",
                "Action": "0",
                "Strategies": [
                    {
                        "Content": "180080",
                        "Field": "information",
                        "CompareFunc": "contains"
                    }
                ],
                "CreateTime": "2022-10-26T16:31:43+08:00"
            }
        ]
    }
}

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