全部產品
Search

搜尋本產品

    Web Application Firewall：DescribeDefenseTemplates

    文件中心

    Web Application Firewall：DescribeDefenseTemplates

    更新時間：Sep 09, 2026

    分頁查詢防護範本清單。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:DescribeDefenseTemplates

    list

    *全部資源。

    *
    • acs:ResourceGroupId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    TemplateIds

    string

    否

    要查詢的多個防護範本 ID。您可以設定該參數，查詢多個已建立的防護範本生效的防護資源，多個防護範本 ID 之間使用英文逗號（,）分隔。

    189731,189539,189538,189531,189540,189542,189541
    TemplateName

    string

    否

    要查詢的防護範本名稱。

    test
    InstanceId

    string

    是

    WAF 執行個體的 ID。

    說明

    您可以呼叫 DescribeInstance ，查看目前 WAF 執行個體的 ID。

    waf_v3prepaid_public_cn-pe33b****03
    TemplateId

    integer

    否

    防護範本 ID。

    39395
    TemplateType

    string

    否

    要建立的防護範本類型。取值：

    • user_default：表示使用者預設防護。

    • user_custom：表示使用者自訂防護。

    user_default
    DefenseScene

    string

    否

    防護場景。更多資訊，請參見 CreateDefenseRule 的 DefenseScene 參數。

    region_block
    Resource

    string

    否

    防護物件、防護群組名稱或防護資產 ID。

    說明

    和 ResourceType 欄位搭配使用，篩選生效時，兩個欄位都需要有值。

    ruiqiu.cc-ecs
    ResourceType

    string

    否

    防護資源類型。

    說明

    和 Resource 欄位搭配使用，篩選生效時，兩個欄位都需要有值。

    枚舉值：

    • single :

      （預設）表示防護物件。

    • asset :

      表示防護資產。

    • group :

      表示防護物件群組。

    single
    DefenseSubScene

    string

    否

    防護範本子場景，取值：

    • web：表示 BOT 管理網頁防護場景範本。

    • app：表示 BOT 管理 APP 防護場景範本。

    • basic：表示 BOT 管理基礎防護範本。

    • bot_custom_acl：表示 BOT 管理進階自訂規則防護範本。

    basic
    PageNumber

    integer

    否

    分頁查詢請求時返回的頁碼。預設值為 1。

    1
    PageSize

    integer

    否

    分頁查詢時每頁的列數。預設值為 20。

    10
    RegionId

    string

    否

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

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

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

    cn-hangzhou
    ResourceManagerResourceGroupId

    string

    否

    阿里雲資源群組 ID。

    rg-acfmvyknl****fa

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    4F26D2F1-E288-5104-8518-05E240E337A4
    Templates

    array<object>

    防護範本清單。

    array<object>

    防護範本。

    DefenseScene

    string

    要建立的 WAF 防護場景，取值：

    • waf_group：表示基礎防護。

    • antiscan：表示掃描防護。

    • ip_blacklist：表示 IP 黑名單。

    • custom_acl：表示自訂規則。

    • whitelist：表示白名單。

    • region_block：表示區域封鎖。

    • custom_response：表示自訂回應。

    • cc：表示 CC 防護。

    • tamperproof：表示網頁防篡改。

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

    • bot_manager: 表示新版 BOT 管理。

    whitelist
    DefenseSubScene

    string

    防護範本子場景，取值：

    • web：表示 BOT 管理網頁防護場景範本。

    • app：表示 BOT 管理 APP 防護場景範本。

    • basic：表示 BOT 管理基礎防護範本。

    • bot_custom_acl：表示 BOT 管理進階自訂規則防護範本。

    basic
    Description

    string

    該範本的描述資訊。

    testTemplate
    Detail

    object

    具體範本資訊。相關描述，請參見 CreateDefenseTemplate 的 Detail 參數。

    {"trafficFeature":"{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"}
    GmtModified

    integer

    防護範本的建立時間，格式為時間戳記，單位：毫秒。

    1683776070000
    TemplateId

    integer

    防護範本 ID。

    56477
    TemplateName

    string

    防護範本名稱。

    template-blockarea1
    TemplateOrigin

    string

    要建立的防護範本來源。取值為 custom，表示使用者自訂。

    custom
    TemplateStatus

    integer

    防護範本狀態。取值：

    • 0：表示關閉。

    • 1：表示開啟。

    1
    TemplateType

    string

    要建立的防護範本類型。取值：

    • user_default：表示使用者預設防護。

    • user_custom：表示使用者自訂防護。

    user_custom
    TotalCount

    integer

    返回結果的總數。

    100

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "4F26D2F1-E288-5104-8518-05E240E337A4",
  "Templates": [
    {
      "DefenseScene": "whitelist",
      "DefenseSubScene": "basic",
      "Description": "testTemplate",
      "Detail": {
        "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
      },
      "GmtModified": 1683776070000,
      "TemplateId": 56477,
      "TemplateName": "template-blockarea1",
      "TemplateOrigin": "custom",
      "TemplateStatus": 1,
      "TemplateType": "user_custom"
    }
  ],
  "TotalCount": 100
}

    錯誤碼

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

    變更歷史

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