分页查询防护规则。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

yundun-waf:DescribeDefenseRules

list

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	WAF 实例 ID。说明您可以通过调用 DescribeInstance 接口查看当前 WAF 实例 ID。	waf_cdnsdf3****
RuleType	string	否	防护规则类型。取值： whitelist：白名单规则 defense（默认）：防护规则说明仅当 DefenseType 为 template 时，需要传入该参数。	whitelist
Query	string	否	查询条件，以一系列参数构造的 JSON 格式转化成字符串。说明根据不同的查询条件，查询到的防护规则结果不同。详细信息，请参见Query 参数描述。	{\"name\":\"IP压制_20220822_10\",\"scene\":\"custom_acl\",\"templateId\":5327}
PageNumber	integer	否	分页查询时，返回第几页数据。默认值为 1，表示返回第 1 页数据。	1
PageSize	integer	否	分页查询时，每页包含多少条结果。默认值为 10，表示每页包含 10 条结果。	10
DefenseType	string	否	防护规则类型。取值： template（默认）：表示模板防护规则。 resource：表示防护对象维度的规则。 global：表示全局维度的规则。枚举值： template : template resource : resource global : global	template
RegionId	string	否	WAF 实例所属地域。取值： cn-hangzhou：表示中国内地。 ap-southeast-1：表示非中国内地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里云资源组 ID。	rg-acfm***q

Query 参数详解

模版防护规则（template）

当防护规则类型 DefenseType 为 template 时，具体的参数描述如下。

参数描述

名称	类型	是否必选	示例值	描述
name	String	可选	test	要查询的防护规则名称。您可以设置该参数，精确查询某条防护规则。
nameId	String	可选	test1	要查询的防护规则 ID 或名称。您可以设置该参数，模糊查询某条防护规则。
nameLike	String	可选	test.aliyundoc.c	要查询的防护规则名称。您可以设置该参数，模糊查询某条防护规则。
scene	String	可选	waf_group	要查询的防护场景。您可以设置该参数，精确查询某个防护场景的防护规则。取值： - waf_group：表示基础防护的正则规则。 - waf_base：表示新版 Web 核心防护规则。 - waf_base_compliance：表示基础防护的协议合规规则。 - waf_base_sema：表示基础防护的语义规则。 - cc：表示 cc 防护。 - antiscan_dirscan：表示扫描防护中的目录遍历封禁。 - antiscan_highfreq：表示扫描防护中的高频扫描封禁。 - antiscan_scantools：表示扫描防护中的扫描工具封禁。 - ip_blacklist：表示 IP 黑名单。 - custom_acl：表示自定义规则。 - region_block：表示区域封禁。 - tamperproof：表示网页防篡改。 - dlp：表示信息泄漏防护。 - custom_response_block：表示自定义响应。
ruleId	Long	可选	33444	要查询的防护规则 ID。您可以设置该参数，精确查询某条防护规则。
ruleIdIn	Array	可选	[3334455643,345555]	要查询的防护规则 ID 范围。您可以设置该参数，查询多个防护规则。多个防护规则之间使用英文逗号（,）分隔。
templateId	Long	可选	24354	要查询的防护模板 ID。您可以设置该参数，查询某个防护模板中的防护规则。
orderBy	String	可选	name	设置防护规则排序方式。取值： - name : 表示按防护规则名称排序。 - gmtModified : 表示按防护规则修改时间排序。 - id : 表示按规则 ID 排序。 - templateId : 表示按防护模板 ID 排序。
desc	Boolean	可选	true	设置排序顺序。取值： - false : 表示正序显示。 - true : 表示倒序显示。

示例

{
    "name": "test",
    "nameId ": "test1,
    "nameLike": "test.aliyundoc.c",
    "nameIn": "test.aliyundoc.c",
    "InstaneId": "test1.aliyundoc.com,test2.aliyundoc.com",
    "templateId": 24354
}

防护对象维度规则（resource）

当防护规则类型 DefenseType 为 resource 时，具体的参数描述如下。

参数描述

名称	类型	是否必选	示例值	描述
resource	String	可选	sec****-waf	规则对应的防护对象。
scene	String	可选	waf_group	要查询的防护场景。您可以设置该参数，精确查询某个防护场景的防护规则。取值： - account_identifier：表示账号提取规则。

示例

{
    "resource": "sec****-waf",
    "scene ": "account_identifier"
}

全局维度规则（global）

当防护规则类型 DefenseType 为 global 时，具体的参数描述如下。

参数描述

名称	类型	是否必选	示例值	描述
scene	String	可选	regular_custom	要查询的防护场景。您可以设置该参数，精确查询某个防护场景的防护规则。取值： - regular_custom：表示自定义正则规则。
detectType	String	可选	sqli	要查询的检测模块，取值： - sqli：表示 SQL 注入。 - xss：表示跨站脚本（XSS）。 - cmdi：表示 OS 命令注入。 - expression_injection：表示表达式注入。 - java_deserialization：表示 Java 反序列化。 - dot_net_deserialization：表示.net 反序列化。 - php_deserialization：表示 PHP 反序列化。 - code_exec：表示代码执行。 - ssrf：表示 SSRF（服务器端请求伪造）。 - path_traversal：表示路径穿越。 - arbitrary_file_uploading：表示任意文件上传。 - webshell：表示 webshell。 - rfilei：表示远程文件包含（RFI）。 - lfilei：表示本地文件包含（LFI）。 - protocol_violation：表示协议违背。 - scanner_behavior：表示扫描器行为。 - logic_flaw：表示业务逻辑缺陷。 - arbitrary_file_reading：表示任意文件读取。 - arbitrary_file_download：表示任意文件下载。 - xxe：表示外部实体注入。 - csrf：表示跨站请求伪造。 - crlf：表示 CRLF。 - other：表示其他。重要仅当防护场景(scene)为自定义正则规则（regular_custom）时，支持查询。
riskLevel	String	可选	strict	要查询的风险等级。取值： - super_strict：超严格。 - strict：严格。 - medium：中等。 - loose：宽松。重要仅当防护场景(scene)为自定义正则规则（regular_custom）时，支持查询。
templateId	Long	可选	24354	要查询的防护模板 ID。您可以设置该参数，查询某个防护模板中的防护规则。重要仅当防护场景(scene)为自定义正则规则（regular_custom）时，支持查询。

示例

{
    "detectType": "sqli",
    "riskLevel ": "strict",
    "templateId": 24354
}

返回参数

名称	类型	描述	示例值
	object	请求结果。
TotalCount	integer	返回结果的总数。	2
RequestId	string	请求 ID。	80736FA5-FA87-55F6-AA69-C5477C6FE6D0
Rules	array<object>	防护规则列表。
	object	防护规则列表。
Status	integer	防护规则状态。取值： 0：表示已禁用。 1：表示已启用。	1
DefenseOrigin	string	防护来源。取值： custom：用户自定义。 system：系统自动生成。	custom
Config	string	防护规则详情，以一系列参数构造的 JSON 格式转化成字符串。更多信息，请参见 CreateDefenseRule 的Rule 参数具体说明。	{\"policyId\":1012,\"action\":\"block\"}
RuleId	integer	防护规则 ID。	42755
DefenseScene	string	防护场景。当入参防护规则类型 DefenseType 为 template 时，取值： waf_group：表示基础防护的正则规则。 waf_base：表示新版 Web 核心防护。 waf_base_compliance：表示基础防护的协议合规规则。 waf_base_sema：表示基础防护的语义规则。 cc：表示 cc 防护。 antiscan_dirscan：表示扫描防护中的目录遍历封禁。 antiscan_highfreq：表示扫描防护中的高频扫描封禁。 antiscan_scantools：表示扫描防护中的扫描工具封禁。 ip_blacklist：表示 IP 黑名单。 custom_acl：表示自定义规则。 region_block：表示区域封禁。 tamperproof：表示网页防篡改。 dlp：表示信息泄漏防护。 custom_response_block：表示自定义响应。 spike_throttle：表示洪峰限流。当入参防护规则类型 DefenseType 为 resource 时，取值： account_identifier：表示账号提取。当入参防护规则类型 DefenseType 为 global 时，取值： regular_custom：表示自定义正则规则。	waf_group
GmtModified	integer	防护规则修改时间。	1665460629000
RuleName	string	防护规则名称。	rules_41
TemplateId	integer	防护规则模板 ID。	5673
Resource	string	规则所属的防护对象。说明仅当入参 DefenseType 为 resource 时，会返回对应参数。	rencs***-waf
DefenseType	string	防护规则类型。取值： template（默认）：表示模板防护规则。 resource：表示防护对象维度的规则。 global：表示全局维度的规则。	template

示例

正常返回示例

JSON格式

{
  "TotalCount": 2,
  "RequestId": "80736FA5-FA87-55F6-AA69-C5477C6FE6D0",
  "Rules": [
    {
      "Status": 1,
      "DefenseOrigin": "custom",
      "Config": "{\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
      "RuleId": 42755,
      "DefenseScene": "waf_group",
      "GmtModified": 1665460629000,
      "RuleName": "rules_41",
      "TemplateId": 5673,
      "Resource": "rencs***-waf",
      "DefenseType": "template"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。