Web 应用防火墙查询规则引擎规则类型列表

1. 接口描述

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

查询规则引擎的规则类型列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeOwaspRuleTypes。
Version	是	String	公共参数，本接口取值：2018-01-25。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-guangzhou, ap-seoul, ap-singapore 。
Domain	是	String	查询域名示例值：www.test.com
Offset	否	Integer	分页页数，默认为0 示例值：0
Limit	否	Integer	每页容量，默认为10 示例值：10
Filters.N	否	Array of FiltersItemNew	筛选条件，支持 RuleId：规则ID、CveID：CVE编号、Desc：描述示例值：{"ExactMatch": true,"Name": "RuleId", "Values": ["10000001"]}

3. 输出参数

参数名称	类型	描述
Total	Integer	规则类型数量示例值：0
List	Array of OwaspRuleType	规则类型列表及信息示例值：[{"Name": "rulename","Desc": "description","RuleTypeStatus": 0,"ActiveRuleCount": 10,"TotalRuleCount": 12}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询规则引擎的规则类型列表

输入示例

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

{
    "Domain": "owasp.saas3.testwaf.com"
}

输出示例

{
    "Response": {
        "List": [
            {
                "Action": 0,
                "ActiveRule": 1056,
                "Classification": "XSS攻击",
                "Description": "跨站脚本 (XSS) 攻击是一种注入，其中恶意脚本被注入到其他受信任的网站中。 当攻击者使用 Web 应用程序将恶意代码（通常以浏览器端脚本的形式）发送给不同的最终用户时，就会发生 XSS 攻击。 允许这些攻击成功的缺陷非常普遍，并且发生在 Web 应用程序在其生成的输出中使用来自用户的输入而不对其进行验证或编码的任何地方。 攻击者可以使用 XSS 向毫无戒心的用户发送恶意脚本。 最终用户的浏览器无法知道该脚本不应受信任，并且会执行该脚本。 由于它认为脚本来自可信来源，因此恶意脚本可以访问浏览器保留并与该站点一起使用的任何 cookie、会话令牌或其他敏感信息。 这些脚本甚至可以重写 HTML 页面的内容。",
                "Level": 100,
                "Status": 1,
                "TotalRule": 1320,
                "TypeId": 10000000,
                "TypeName": "XSS攻击"
            }
        ],
        "RequestId": "239d0e9a-c7b1-48af-acda-7237c060362a",
        "Total": 1
    }
}

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.Unknown	InternalError.Unknown
InvalidParameterValue.InvalidRequest	InvalidRequest
ResourceNotFound.NotFound	ResourceNotFound.NotFound

查询规则引擎规则类型列表

本页目录：