文档

DescribeDcdnWafPolicies - 查询用户配置的防护策略

更新时间:

调用DescribeDcdnWafPolicies查询用户已配置的WAF防护策略详细信息。

接口说明

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dcdn:DescribeDcdnWafPoliciesList
  • 全部资源
    *

请求参数

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

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

说明 不传默认查询所有防护策略。
{"PolicyNameLIike":"test_policy"}
PageNumberinteger

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

1
PageSizeinteger

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

20

QueryArgs 取值说明

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

返回参数

名称类型描述示例值
object
PageSizeinteger

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

20
RequestIdstring

请求 ID。

153ca2cd-3c01-44be-2e83-64dbc6c88630
PageNumberinteger

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

1
TotalCountinteger

防护策略个数。

15
Policiesobject []

防护策略列表。

PolicyStatusstring

防护策略状态,同请求参数 QueryArgs 中 PolicyStatus。

on
DefenseScenestring

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

custom_acl
DomainCountinteger

使用该防护策略的域名个数。

22
PolicyNamestring

防护策略名称。

policy_test
PolicyIdlong

防护策略 ID。

100001
RuleCountlong

该防护策略下的防护规则个数。

9
GmtModifiedstring

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

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

是否为默认防护策略,同请求参数 QueryArgs 中 PolicyType。

default

示例

正常返回示例

JSON格式

{
  "PageSize": 20,
  "RequestId": "153ca2cd-3c01-44be-2e83-64dbc6c88630",
  "PageNumber": 1,
  "TotalCount": 15,
  "Policies": [
    {
      "PolicyStatus": "on",
      "DefenseScene": "custom_acl",
      "DomainCount": 22,
      "PolicyName": "policy_test",
      "PolicyId": 100001,
      "RuleCount": 9,
      "GmtModified": "2021-12-29T17:08:45Z",
      "PolicyType": "default"
    }
  ]
}

错误码

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

  • 本页导读 (1)
文档反馈