调用DescribeDcdnWafRules查询用户已配置的防护规则详细信息。

使用说明

单用户调用频率:20次/秒。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDcdnWafRules

系统规定参数。取值:DescribeDcdnWafRules

QueryArgs String {"RuleIds":"100001,200002"}

查询条件,JSON序列化后的字符串。

格式如下:
QueryArgs={"PolicyIds":"防护策略ID范围","RuleIds":"防护规则ID范围","RuleNameLike":"防护规则名称","DomainNames":"防护域名","DefenseScenes":"waf_group","RuleStatus":"on","OrderBy":"GmtModified","Desc":"false"}
说明 不传默认查询所有防护规则。
PageNumber Integer 1

页码,默认值1,取值范围:1~100000

PageSize Integer 20

每页显示的防护规则个数,默认值20,取值范围:1~500之间的任意整数。

QueryArgs取值说明

名称

类型

是否必选

示例值

描述

PolicyIds

string

10000001,10000100

防护策略ID范围,精确查询,多个ID用英文逗号(,)分隔。

RuleIds

string

100001,200002

防护规则ID范围,精确查询,多个ID用英文逗号(,)分隔。

RuleNameLike

string

rule_1

防护规则名称,模糊查询。支持输入中文字符、英文字符(大小写)、数字(0~9)及下划线(_),最大输入64个字符。

DomainNames

string

example.com

防护域名列表,精确查询,最多输入50个,多个域名用英文逗号(,)分隔。

DefenseScenes

string

custom_acl

防护策略精确查询,多个用英文逗号(,)分隔。目前支持以下场景:waf_group:Web基础防护。custom_acl:自定义防护策略。whitelist:白名单。

RuleStatus

string

on

策略状态。on:开启。off:关闭。

OrderBy

string

GmtModified

排序列,支持排序的字段:GmtModified、RuleName、RuleStatus、RuleId和PolicyId。

Desc

Boolean

false

排列顺序。true:倒序。false(默认):正序。

返回数据

名称 类型 示例值 描述
PageSize Integer 20

每页显示的防护规则个数,同请求参数中PageSize。

RequestId String 66A98669-CC6E-4F3E-80A6-3014697B11AE

请求ID。

PageNumber Integer 1

页码,同请求参数中PageNumber。

TotalCount Integer 121

防护规则总数。

Rules Array of RuleItem

防护规则信息。

RuleStatus String on

防护规则状态,同请求参数QueryArgs中RuleStatus。

DefenseScene String custom_acl

防护策略类型,同请求参数QueryArgs中的DefenseScene。

PolicyId Long 200001

防护策略ID。

GmtModified String 2021-12-29T17:08:45Z

修改时间。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

RuleId Long 100001

防护规则ID。

RuleName String rule_1

防护规则名称。

RuleConfig String {\"action\":\"monitor\",\"actionExternal\":\"{}\",\"ccStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"eq\",\"targetKey\":\"request_uri\",\"values\":\"/example\"},{\"key\":\"Header\",\"opValue\":\"eq\",\"subKey\":\"trt\",\"targetKey\":\"header.trt\",\"values\":\"3333\"}],\"effect\":\"service\",\"name\":\"aaa333\",\"origin\":\"custom\",\"ratelimit\":{\"interval\":5,\"status\":{\"code\":404,\"count\":2,\"stat\":{\"mode\":\"count\",\"value\":2.0}},\"target\":\"remote_addr\",\"threshold\":2,\"ttl\":1800}}

防护规则配置信息。

示例

请求示例

http(s)://dcdn.aliyuncs.com/?Action=DescribeDcdnWafRules
&QueryArgs={"RuleIds":"100001,200002"}
&PageNumber=1
&PageSize=20
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDcdnWafRulesResponse>
    <TotalCount>121</TotalCount>
    <Rules>
        <GmtModified>2021-12-29T17:08:45Z</GmtModified>
        <PolicyId>200001</PolicyId>
        <RuleId>100001</RuleId>
        <RuleName>rule_1</RuleName>
        <RuleStatus>on</RuleStatus>
        <RuleConfig>{"action":"monitor","actionExternal":"{}","ccStatus":1,"conditions":[{"key":"URL","opValue":"eq","targetKey":"request_uri","values":"/example"},{"key":"Header","opValue":"eq","subKey":"trt","targetKey":"header.trt","values":"3333"}],"effect":"service","name":"aaa333","origin":"custom","ratelimit":{"interval":5,"status":{"code":404,"count":2,"stat":{"mode":"count","value":2.0}},"target":"remote_addr","threshold":2,"ttl":1800}}</RuleConfig>
        <DefenseScene>custom_acl</DefenseScene>
    </Rules>
    <Rules>
        <GmtModified>2021-12-19T17:08:45Z</GmtModified>
        <PolicyId>200001</PolicyId>
        <RuleId>200002</RuleId>
        <RuleStatus>off</RuleStatus>
        <RuleConfig>{"action":"block"}</RuleConfig>
        <DefenseScene>waf_group</DefenseScene>
    </Rules>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
    <RequestId>66A98669-CC6E-4F3E-80A6-3014697B11AE</RequestId>
</DescribeDcdnWafRulesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalCount" : 121,
  "Rules" : [ {
    "GmtModified" : "2021-12-29T17:08:45Z",
    "PolicyId" : 200001,
    "RuleId" : 100001,
    "RuleName" : "rule_1",
    "RuleStatus" : "on",
    "RuleConfig" : "{\"action\":\"monitor\",\"actionExternal\":\"{}\",\"ccStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"eq\",\"targetKey\":\"request_uri\",\"values\":\"/example\"},{\"key\":\"Header\",\"opValue\":\"eq\",\"subKey\":\"trt\",\"targetKey\":\"header.trt\",\"values\":\"3333\"}],\"effect\":\"service\",\"name\":\"aaa333\",\"origin\":\"custom\",\"ratelimit\":{\"interval\":5,\"status\":{\"code\":404,\"count\":2,\"stat\":{\"mode\":\"count\",\"value\":2.0}},\"target\":\"remote_addr\",\"threshold\":2,\"ttl\":1800}}",
    "DefenseScene" : "custom_acl"
  }, {
    "GmtModified" : "2021-12-19T17:08:45Z",
    "PolicyId" : 200001,
    "RuleId" : 200002,
    "RuleStatus" : "off",
    "RuleConfig" : "{\"action\":\"block\"}",
    "DefenseScene" : "waf_group"
  } ],
  "PageNumber" : 1,
  "PageSize" : 20,
  "RequestId" : "66A98669-CC6E-4F3E-80A6-3014697B11AE"
}

错误码

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