調用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"
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。