DescribeDcdnWafRules - 查询用户配置的防护规则

更新时间:

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

接口说明

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
QueryArgsstring

查询条件,JSON 序列化后的字符串。 格式如下:QueryArgs={"PolicyIds":"防护策略 ID 范围","RuleIds":"防护规则 ID 范围","RuleNameLike":"防护规则名称","DomainNames":"防护域名","DefenseScenes":"waf_group","RuleStatus":"on","OrderBy":"GmtModified","Desc":"false"}

说明 不传默认查询所有防护规则。
{"RuleIds":"100001,200002"}
PageNumberinteger

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

1
PageSizeinteger

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

20

QueryArgs 取值说明

名称类型是否必选示例值描述
PolicyIdsstring10000001,10000100防护策略 ID 范围,精确查询,多个 ID 用英文逗号(,)分隔。
RuleIdsstring100001,200002防护规则 ID 范围,精确查询,多个 ID 用英文逗号(,)分隔。
RuleNameLikestringrule_1防护规则名称,模糊查询。支持输入中文字符、英文字符(大小写)、数字(0~9)及下划线(_),最大输入 64 个字符。
DomainNamesstringexample.com防护域名列表,精确查询,最多输入 50 个,多个域名用英文逗号(,)分隔。
DefenseScenesstringcustom_acl防护策略精确查询,多个用英文逗号(,)分隔。目前支持以下场景:waf_group:Web 基础防护。custom_acl:自定义防护策略。whitelist:白名单。
RuleStatusstringon策略状态。on:开启。off:关闭。
OrderBystringGmtModified排序列,支持排序的字段:GmtModified、RuleName、RuleStatus、RuleId 和 PolicyId。
DescBooleanfalse排列顺序。true:倒序。false(默认):正序。

返回参数

名称类型描述示例值
object
PageSizeinteger

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

20
RequestIdstring

请求 ID。

66A98669-CC6E-4F3E-80A6-3014697B11AE
PageNumberinteger

页码,同请求参数中 PageNumber。

1
TotalCountinteger

防护规则总数。

121
Rulesarray<object>

防护规则信息。

RuleItemobject
RuleStatusstring

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

on
DefenseScenestring

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

custom_acl
PolicyIdlong

防护策略 ID。

200001
GmtModifiedstring

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

2021-12-29T17:08:45Z
RuleIdlong

防护规则 ID。

100001
RuleNamestring

防护规则名称。

rule_1
RuleConfigstring

防护规则配置信息。

{"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}}

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "PageNumber": 1,
  "TotalCount": 121,
  "Rules": [
    {
      "RuleStatus": "on",
      "DefenseScene": "custom_acl",
      "PolicyId": 200001,
      "GmtModified": "2021-12-29T17:08:45Z",
      "RuleId": 100001,
      "RuleName": "rule_1",
      "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}}\n"
    }
  ]
}

错误码

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