全部產品
Search

搜尋本產品

    Edge Security Acceleration：ListWafRulesets - 列舉WAF規則集

    文件中心

    Edge Security Acceleration：ListWafRulesets - 列舉WAF規則集

    更新時間：Mar 26, 2026

    列舉出當前WAF運行階段下的規則集列表，通過此介面查看分頁查詢規則集的基本資料和狀態。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    esa:ListWafRulesets

    get

    *Site

    acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    SiteId

    integer

    是

    網站 ID，可通過調用 ListSites 介面擷取。

    1
    SiteVersion

    integer

    否

    網站配置的版本號碼。開啟了配置版本管理的網站，可以通過該參數指定配置生效的網站版本，預設為版本 0。

    0
    Phase

    string

    是

    WAF 規則運行階段。

    • http_whitelist：白名單規則

    • http_custom：自訂規則

    • http_managed：託管規則

    • http_anti_scan：掃描防護規則

    • http_ratelimit：頻次控制規則

    • ip_access_rule：IP 訪問規則

    • http_bot：進階模式 Bots

    • http_security_level_rule：安全規則

    http_bot
    QueryArgs

    object

    否

    查詢參數，以 JSON 格式傳遞，包含各種篩選條件。

    http_bot
    NameLike

    string

    否

    模糊查詢規則集名稱。

    example
    AnyLike

    string

    否

    模糊查詢規則集 ID、規則集名稱、規則 ID、規則名稱。

    example
    OrderBy

    string

    否

    指定排序的列。

    id
    Desc

    boolean

    否

    是否倒序排列。

    PageNumber

    integer

    否

    頁面號碼，分頁查詢時指定當前頁碼。

    1
    PageSize

    integer

    否

    頁面大小，分頁查詢時指定每頁的記錄數量。

    20

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    Schema of Response

    RequestId

    string

    請求 ID。

    36af3fcc-43d0-441c-86b1-428951dc8225
    SiteUsage

    integer

    網站在該 WAF 運行階段已使用的 WAF 規則集數量。

    5
    InstanceUsage

    integer

    執行個體在該 WAF 運行階段已使用的 WAF 規則集數量。

    10
    TotalCount

    integer

    過濾後總記錄數。

    5
    Rulesets

    array<object>

    規則集資訊列表，包含規則集的詳細資料。

    object

    規則集資訊

    UpdateTime

    string

    規則集的最後修改時間。

    2024-01-01T00:00:00Z
    Id

    integer

    WAF 規則集的 ID，可通過調用 ListWafRulesets 介面擷取。

    10000001
    Name

    string

    規則集名稱。

    example
    Status

    string

    規則集狀態。

    on
    Phase

    string

    WAF 規則運行階段。

    • http_whitelist：白名單規則

    • http_custom：自訂規則

    • http_managed：託管規則

    • http_anti_scan：掃描防護規則

    • http_ratelimit：頻次控制規則

    • ip_access_rule：IP 訪問規則

    • http_bot：進階模式 Bots

    • http_security_level_rule：安全規則

    http_bot
    Types

    array

    規則類型列表。

    string

    規則類型。

    http_custom_cc
    Target

    string

    http_bot 中防護目標類型。

    web
    Fields

    array

    匹配對象列表。

    string

    匹配對象。

    http.request.headers
    PageNumber

    integer

    當前頁碼。

    1
    PageSize

    integer

    頁面大小。

    20

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "36af3fcc-43d0-441c-86b1-428951dc8225",
  "SiteUsage": 5,
  "InstanceUsage": 10,
  "TotalCount": 5,
  "Rulesets": [
    {
      "UpdateTime": "2024-01-01T00:00:00Z",
      "Id": 10000001,
      "Name": "example",
      "Status": "on",
      "Phase": "http_bot",
      "Types": [
        "http_custom_cc"
      ],
      "Target": "web",
      "Fields": [
        "http.request.headers"
      ]
    }
  ],
  "PageNumber": 1,
  "PageSize": 20
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidParameter The specified parameter is invalid. 輸入參數規範校正失敗。
    400 InternalException Failed to call the service. Try again later or contact technical support. 調用服務失敗，請稍後重試或聯絡客服諮詢詳情。

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

    變更歷史

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