全部產品
Search

搜尋本產品

    Edge Security Acceleration：DescribeDcdnWafPolicies - 查詢使用者配置的防護策略

    文件中心

    Edge Security Acceleration：DescribeDcdnWafPolicies - 查詢使用者配置的防護策略

    更新時間：Sep 11, 2025

    調用DescribeDcdnWafPolicies查詢使用者已配置的WAF防護策略詳細資料。

    介面說明

    說明

    單使用者調用頻率：20 次/秒。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dcdn:DescribeDcdnWafPolicies

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    QueryArgs

    string

    否

    按條件查詢，JSON 序列化後的字串。 格式如下：QueryArgs={"PolicyIds":"防護策略 ID","RuleIds":"防護規則 ID 範圍","PolicyNameLike":"防護策略名稱稱","DomainNames":"防護網域名稱","PolicyType":"default","DefenseScenes":"waf_group","PolicyStatus":"on","OrderBy":"GmtModified","Desc":"false"}

    說明

    不傳預設查詢所有防護策略。

    {"PolicyNameLIike":"test_policy"}
    PageNumber

    integer

    否

    頁碼，預設值 1，取值範圍：1~100000。

    1
    PageSize

    integer

    否

    每頁顯示的防護策略個數，預設值 20，取值範圍：1~500 之前的任意整數。

    20

    QueryArgs 取值說明

    名稱類型是否必選樣本值描述
    PolicyIdsstring否10000001,10000002防護策略 ID 列表，精確查詢，多個 ID 用英文逗號（,）分隔。
    RuleIdsstring否20000001,20000055防護規則 ID 範圍，精確查詢，多個 ID 用英文逗號（,）分隔。
    PolicyNameLikestring否policy_test防護策略名稱稱，模糊查詢。支援輸入中文字元、英文字元（大小寫）、數字（0~9）及底線（_）。
    DomainNamesstring否example.com防護網域名稱列表，精確查詢，最多輸入 50 個，多個 ID 用英文逗號（,）分隔。
    PolicyTypestring否default是否為預設防護策略。default：預設防護策略。custom：非預設防護策略。
    DefenseScenesstring否custom_acl防護策略精確查詢，多個用英文逗號（,）分隔。目前支援以下情境：waf_group：Web 基礎防護。custom_acl：自訂防護策略。whitelist：白名單。
    PolicyStatusstring否on策略狀態。on：開啟。off：關閉。
    OrderBystring否GmtModified排序列，支援排序的欄位：GmtModified、PolicyId、PolicyName、PolicyStatus
    DescBoolean否false排列順序，true：倒序。false（預設）：正序。

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    PageSize

    integer

    每頁顯示的防護策略個數，預設值 20，取值範圍：1~500 之前的任意整數。

    20
    RequestId

    string

    請求 ID。

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

    integer

    頁碼。取值範圍為：1~100000。預設值為 1。

    1
    TotalCount

    integer

    防護策略個數。

    15
    Policies

    array<object>

    防護策略列表。

    object

    PolicyStatus

    string

    防護策略狀態，同請求參數 QueryArgs 中 PolicyStatus。

    on
    DefenseScene

    string

    防護策略類型，同請求參數 QueryArgs 中 DefenseScenes。

    custom_acl
    DomainCount

    integer

    使用該防護策略的網域名稱個數。

    22
    PolicyName

    string

    防護策略名稱稱。

    policy_test
    PolicyId

    integer

    防護策略 ID。

    100001
    RuleCount

    integer

    該防護策略下的防護規則個數。

    9
    GmtModified

    string

    修改時間。日期格式按照 ISO8601 標記法，並使用 UTC+0 時間，格式為 yyyy-MM-ddTHH:mm:ssZ。

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

    string

    是否為預設防護策略，同請求參數 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"
    }
  ]
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。