全部產品
Search
文件中心

Web Application Firewall:DescribeDefenseTemplate

更新時間:Sep 09, 2026

查詢單個防護範本。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeDefenseTemplate

get

*全部資源。

*

  • acs:ResourceGroupId
無

請求參數

名稱

類型

必填

描述

樣本值

InstanceId

string

是

WAF 執行個體的 ID。

說明

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

waf_cdnsdf3****

TemplateId

integer

是

要查詢的防護範本 ID。

1333

RegionId

string

否

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

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

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

cn-hangzhou

ResourceManagerResourceGroupId

string

否

阿里雲資源群組 ID。

rg-acfm***q

返回參數

名稱

類型

描述

樣本值

object

請求結果。

RequestId

string

請求 ID。

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

Template

object

範本資訊。

DefenseScene

string

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

waf_group

DefenseSubScene

string

防護範本子場景,取值:

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

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

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

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

app

Description

string

要建立的防護範本描述資訊。

test

Detail

object

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

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

GmtModified

integer

防護範本修改時間。

1665283642000

TemplateId

integer

防護規則範本 ID。

10097

TemplateName

string

範本名稱。

test0621

TemplateOrigin

string

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

custom

TemplateStatus

integer

防護範本狀態。取值:

  • 0:表示關閉。

  • 1:表示開啟。

1

TemplateType

string

防護範本類型。取值:

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

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

user_default

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "Template": {
    "DefenseScene": "waf_group",
    "DefenseSubScene": "app",
    "Description": "test",
    "Detail": {
      "trafficFeature": "{\"global\":0,\"excludeStatus\":1,\"conditions\":[{\"key\":\"URL\",\"opValue\":\"not-contain\",\"values\":\"test\"}]}"
    },
    "GmtModified": 1665283642000,
    "TemplateId": 10097,
    "TemplateName": "test0621",
    "TemplateOrigin": "custom",
    "TemplateStatus": 1,
    "TemplateType": "user_default"
  }
}

錯誤碼

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

變更歷史

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