全部產品
Search

搜尋本產品

    Web Application Firewall：DescribeDefenseRule

    文件中心

    Web Application Firewall：DescribeDefenseRule

    更新時間：Jul 13, 2026

    查詢單個防護規則。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:DescribeDefenseRule

    get

    *All Resource

    *
    • acs:ResourceGroupId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    WAF 執行個體 ID。

    說明

    您可以透過呼叫 DescribeInstance 介面檢視您目前的 WAF 執行個體 ID。

    waf_cdnsdf3****
    TemplateId

    integer

    否

    要查詢的防護範本 ID。

    說明

    僅當 DefenseType 為 template 時，需要傳入此參數。

    10318
    RuleId

    integer

    是

    要查詢的防護規則 ID。

    20026192
    DefenseType

    string

    否

    防護規則類型。

    枚舉值：

    • template :

      （預設）表示範本防護規則。

    • resource :

      表示防護物件維度的規則。

    • global :

      表示全域維度的規則。

    template
    RegionId

    string

    否

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

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

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

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfm***q
    Resource

    string

    否

    要查詢規則對應的防護物件。

    說明

    僅當 DefenseType 為 resource 時，需要傳入此參數。

    rencs***-waf

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求結果。

    RequestId

    string

    請求 ID。

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

    object

    規則設定內容，以一系列參數建構的 JSON 格式轉化成字串。

    Status

    integer

    防護規則狀態。取值：

    • 0：表示關閉。

    • 1：表示開啟。

    1
    DefenseOrigin

    string

    防護來源。取值：

    • custom：使用者自訂。

    • system：系統自動產生。

    custom
    Config

    string

    防護規則詳情，以一系列參數建構的 JSON 格式轉化成字串。更多資訊，請參見 CreateDefenseRule 的防護規則參數描述。

    {\"status\":1,\"policyId\":1012,\"action\":\"block\"}
    RuleId

    integer

    防護規則 ID。

    2732975
    DefenseScene

    string

    防護場景。

    當入參防護規則類型 DefenseType 為 template 時，取值：

    • waf_group：表示基礎防護的正則規則。

    • waf_base：表示新版 Web 核心防護。

    • waf_base_compliance：表示基礎防護的通訊協定合規規則。

    • waf_base_sema：表示基礎防護的語意規則。

    • cc：表示 CC 防護。

    • antiscan_dirscan：表示掃描防護中的目錄遍歷封鎖。

    • antiscan_highfreq：表示掃描防護中的高頻掃描封鎖。

    • antiscan_scantools：表示掃描防護中的掃描工具封鎖。

    • ip_blacklist：表示 IP 黑名單。

    • custom_acl：表示自訂規則。

    • region_block：表示區域封鎖。

    • tamperproof：表示網頁防篡改。

    • dlp：表示資訊洩漏防護。

    • custom_response_block：表示自訂回應。

    • spike_throttle：表示洪峰限流。

    當入參防護規則類型 DefenseType 為 resource 時，取值：

    • account_identifier：表示帳號提取。

    • custom_response：表示新版自訂回應。

    • waf_codec：表示解碼。

    當入參防護規則類型 DefenseType 為 global 時，取值：

    • regular_custom：表示自訂正則。

    • address_book：表示位址簿。

    • custom_response：表示新版自訂回應。

    waf_group
    GmtModified

    integer

    防護規則修改時間。

    1665196746000
    RuleName

    string

    防護規則名稱。

    test1
    TemplateId

    integer

    防護規則範本 ID。

    說明

    僅當入參 DefenseType 為 template 時，會返回對應參數。

    9114
    Resource

    string

    規則所屬的防護物件。

    說明

    僅當入參 DefenseType 為 resource 時，會返回對應參數。

    rencs***-waf
    DefenseType

    string

    防護規則類型。取值：

    • template（預設）：表示範本防護規則。

    • resource：表示防護物件維度的規則。

    • global：表示全域維度的規則。

    template

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Rule": {
    "Status": 1,
    "DefenseOrigin": "custom",
    "Config": "{\\\"status\\\":1,\\\"policyId\\\":1012,\\\"action\\\":\\\"block\\\"}",
    "RuleId": 2732975,
    "DefenseScene": "waf_group",
    "GmtModified": 1665196746000,
    "RuleName": "test1",
    "TemplateId": 9114,
    "Resource": "rencs***-waf",
    "DefenseType": "template"
  }
}

    錯誤碼

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

    變更歷史

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