调用DescribeDcdnWafPolicies查询用户已配置的WAF防护策略详细信息。
接口说明
说明
单用户调用频率:20 次/秒。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
QueryArgs | string | 否 | 按条件查询,JSON 序列化后的字符串。
格式如下: 说明
不传默认查询所有防护策略。
| {"PolicyNameLIike":"test_policy"} |
PageNumber | integer | 否 | 页码,默认值 1,取值范围:1~100000。 | 1 |
PageSize | integer | 否 | 每页显示的防护策略个数,默认值 20,取值范围:1~500 之前的任意整数。 | 20 |
QueryArgs 取值说明
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PolicyIds | string | 否 | 10000001,10000002 | 防护策略 ID 列表,精确查询,多个 ID 用英文逗号(,)分隔。 |
RuleIds | string | 否 | 20000001,20000055 | 防护规则 ID 范围,精确查询,多个 ID 用英文逗号(,)分隔。 |
PolicyNameLike | string | 否 | policy_test | 防护策略名称,模糊查询。支持输入中文字符、英文字符(大小写)、数字(0~9)及下划线(_)。 |
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(默认):正序。 |
返回参数
示例
正常返回示例
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"
}
]
}
错误码
访问错误中心查看更多错误码。