全部產品
Search

搜尋本產品

    Web Application Firewall：DescribeApisecRules - 查詢API安全性原則配置規則

    文件中心

    Web Application Firewall：DescribeApisecRules - 查詢API安全性原則配置規則

    更新時間：Dec 13, 2025

    查詢API安全性原則配置規則。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:DescribeApisecRules

    get

    *全部資源

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    WAF 執行個體的 ID。

    說明

    您可以調用 DescribeInstance 查詢當前 WAF 執行個體的 ID。

    waf_elasticity-cn-0x***
    Type

    string

    是

    規則類型。取值：

    • risk：表示風險檢測。

    • event：表示安全事件。

    • sensitive_word：表示敏感性資料。

    • auth_flag：表示鑒權憑證。

    • api_tag：表示業務用途。

    • desensitization：表示脫敏。

    • whitelist：表示白名單。

    • recognition：表示介面。

    • offline_api：表示生命週期管理。

    risk
    Level

    string

    否

    規則的等級。

    對於風險檢測（risk）、安全事件（event），取值：

    • high：表示高危。

    • medium：表示中危。

    • low：表示低危。

    對于敏感資料（sensitive_word），取值：

    • S1：表示 S1 等級。

    • S2：表示 S2 等級。

    • S3：表示 S3 等級。

    • S4：表示 S4 等級。

    high
    Name

    string

    否

    規則名稱。

    information leakage
    Origin

    string

    否

    規則的來源。取值：

    • custom：表示自訂。

    • default：表示內建。

    custom
    Status

    integer

    否

    規則的開啟狀態。取值：

    • 1：表示開啟。

    • 0：表示關閉。

    1
    PageNumber

    integer

    否

    分頁查詢時，返回第幾頁資料。預設值為 1，表示返回第 1 頁資料。

    1
    PageSize

    integer

    否

    分頁查詢時，每頁包含多少條結果。預設值為 10，表示每頁包含 10 條結果。

    10
    RegionId

    string

    否

    WAF 執行個體所屬地區。取值：

    • cn-hangzhou：表示中國內地。

    • ap-southeast-1：表示非中國內地。

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfm***q
    Lang

    string

    否

    返回規則的語言類型。取值：

    • zh（預設）：中文。

    • en：英文。

    zh

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求結果。

    TotalCount

    integer

    返回結果的總數。

    6
    RequestId

    string

    請求 ID。

    D7861F61-5B61-46CE-A47C-6B19160D5EB0
    Data

    array<object>

    規則的列表。

    object

    規則的資訊。

    Status

    integer

    規則的狀態。取值：

    • 1：表示開啟。

    • 0：表示關閉。

    1
    Type

    string

    規則類型。取值：

    • risk：表示風險檢測。

    • event：表示安全事件。

    • sensitive_word：表示敏感性資料。

    • auth_flag：表示鑒權憑證。

    • api_tag：表示業務用途。

    • desensitization：表示脫敏。

    • whitelist：表示白名單。

    • recognition：表示介面。

    • offline_api：表示生命週期管理。

    risk
    UpdateTime

    integer

    規則的更新時間，格式為 Unix 時間戳記（UTC 時間），單位為秒。

    1721095301
    Id

    integer

    規則的 ID。

    34933
    Rule

    string

    規則詳情，以一系列參數構造的 JSON 格式轉化成字串。

    { "ext": "Date", "regex": "-", "code": "2009", "level": "S1", "origin": "default", "name": "2009" }

    樣本

    正常返回樣本

    JSON格式

    {
  "TotalCount": 6,
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Data": [
    {
      "Status": 1,
      "Type": "risk",
      "UpdateTime": 1721095301,
      "Id": 34933,
      "Rule": "{\n    \"ext\": \"Date\",\n    \"regex\": \"-\",\n    \"code\": \"2009\",\n    \"level\": \"S1\",\n    \"origin\": \"default\",\n    \"name\": \"2009\"\n}\n"
    }
  ]
}

    錯誤碼

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

    變更歷史

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