調用DescribeDcdnWafRules查詢用戶已配置的防護規(guī)則詳細信息。
接口說明
說明
單用戶調用頻率：20 次/秒。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| QueryArgs | string | 否 | 查詢條件，JSON 序列化后的字符串。
格式如下： 說明
不傳默認查詢所有防護規(guī)則。
| {"RuleIds":"100001,200002"} |
| PageNumber | integer | 否 | 頁碼，默認值 1，取值范圍：1~100000。 | 1 |
| PageSize | integer | 否 | 每頁顯示的防護規(guī)則個數，默認值 20，取值范圍：1~500 之間的任意整數。 | 20 |
QueryArgs 取值說明
| 名稱 | 類型 | 是否必選 | 示例值 | 描述 |
|---|---|---|---|---|
| PolicyIds | string | 否 | 10000001,10000100 | 防護策略 ID 范圍，精確查詢，多個 ID 用英文逗號（,）分隔。 |
| RuleIds | string | 否 | 100001,200002 | 防護規(guī)則 ID 范圍，精確查詢，多個 ID 用英文逗號（,）分隔。 |
| RuleNameLike | string | 否 | rule_1 | 防護規(guī)則名稱，模糊查詢。支持輸入中文字符、英文字符（大小寫）、數字（0~9）及下劃線（_），最大輸入 64 個字符。 |
| DomainNames | string | 否 | example.com | 防護域名列表，精確查詢，最多輸入 50 個，多個域名用英文逗號（,）分隔。 |
| DefenseScenes | string | 否 | custom_acl | 防護策略精確查詢，多個用英文逗號（,）分隔。目前支持以下場景：waf_group：Web 基礎防護。custom_acl：自定義防護策略。whitelist：白名單。 |
| RuleStatus | string | 否 | on | 策略狀態(tài)。on：開啟。off：關閉。 |
| OrderBy | string | 否 | GmtModified | 排序列，支持排序的字段：GmtModified、RuleName、RuleStatus、RuleId 和 PolicyId。 |
| Desc | Boolean | 否 | false | 排列順序。true：倒序。false（默認）：正序。 |
返回參數
示例
正常返回示例
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"
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。