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

使用说明

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

调试

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

请求参数

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

系统规定参数。取值:DescribeDcdnWafPolicies

QueryArgs String {"PolicyNameLIike":"test_policy"}

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

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

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

PageSize Integer 20

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

QueryArgs取值说明

名称

类型

是否必选

示例值

描述

PolicyIds

string

10000001,10000002

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

RuleIds

string

20000001,20000055

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

PolicyNameLike

string

policy_test

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

DomainNames

string

example.com

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

PolicyType

string

default

是否为默认防护策略。default:默认防护策略。custom:非默认防护策略。

DefenseScenes

string

custom_acl

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

PolicyStatus

string

on

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

OrderBy

string

GmtModified

排序列,支持排序的字段:GmtModified、PolicyId、PolicyName、PolicyStatus

Desc

Boolean

false

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

返回数据

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

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

RequestId String 153ca2cd-3c01-44be-2e83-64dbc6c88630

请求ID。

PageNumber Integer 1

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

TotalCount Integer 15

防护策略个数。

Policies Array of PolicyItem

防护策略列表。

PolicyStatus String on

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

DefenseScene String custom_acl

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

DomainCount Integer 22

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

PolicyName String policy_test

防护策略名称。

PolicyId Long 100001

防护策略ID。

RuleCount Long 9

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

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

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

PolicyType String default

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

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeDcdnWafPolicies
&QueryArgs={"PolicyNameLIike":"test_policy"}
&公共请求参数

正常返回示例

XML格式

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

<DescribeDcdnWafPoliciesResponse>
    <RequestId>153ca2cd-3c01-44be-2e83-64dbc6c88630</RequestId>
    <TotalCount>15</TotalCount>
    <Policies>
        <GmtModified>2021-12-29T17:08:45Z</GmtModified>
        <PolicyId>100001</PolicyId>
        <PolicyName>policy_test</PolicyName>
        <PolicyType>default</PolicyType>
        <PolicyStatus>on</PolicyStatus>
        <DomainCount>22</DomainCount>
        <RuleCount>9</RuleCount>
        <DefenseScene>custom_acl</DefenseScene>
    </Policies>
    <Policies>
        <GmtModified>2021-12-29T17:09:45Z</GmtModified>
        <PolicyId>100002</PolicyId>
        <PolicyName>policy_test2</PolicyName>
        <PolicyType>custom</PolicyType>
        <PolicyStatus>off</PolicyStatus>
        <DomainCount>25</DomainCount>
        <RuleCount>10</RuleCount>
        <DefenseScene>waf_group</DefenseScene>
    </Policies>
    <PageNumber>1</PageNumber>
    <PageSize>20</PageSize>
</DescribeDcdnWafPoliciesResponse>

JSON格式

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

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

错误码

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