全部產品
Search

搜尋本產品

    Web Application Firewall：CreateDefenseTemplate

    文件中心

    Web Application Firewall：CreateDefenseTemplate

    更新時間：Sep 09, 2026

    建立防護範本。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    yundun-waf:CreateDefenseTemplate

    create

    *全部資源。

    *
    • acs:ResourceGroupId
    		 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    WAF 執行個體的 ID。

    說明

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

    waf_cdnsdf3****
    TemplateName

    string

    是

    要建立的防護範本名稱。長度為 1~255 個字元，可以包含中文、英文、數字、底線（_）、半形句號（.）或短橫線（-）。

    說明

    相同防護場景（DefenseScene）的範本名稱不能重複。

    test221
    TemplateType

    string

    是

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

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

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

    user_default
    TemplateStatus

    integer

    是

    要建立的防護範本狀態。取值：

    • 0：表示關閉。

    • 1：表示開啟。

    1
    DefenseScene

    string

    是

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

    waf_group
    TemplateOrigin

    string

    是

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

    custom
    DefenseSubScene

    string

    否

    防護範本子場景。僅 BOT 管理進階場景支援設定。

    枚舉值：

    • app :

      表示 app 場景範本。

    • web :

      表示 web 場景範本。

    • bot_custom_acl :

      表示進階自訂規則範本。

    web
    Description

    string

    否

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

    test
    RegionId

    string

    否

    具體範本資訊，JSON 格式的字串，不同的鍵值組表示防護物件不同的屬性，詳見 Detail 說明。

    說明

    該參數僅適用於新版基礎防護（waf_base）和新版 BOT 管理（bot_manager）防護場景。在新版 BOT 管理（bot_manager）防護場景下，必須傳入該參數。

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

    string

    否

    是否開啟 DryRun 預檢模式。如果不輸入該參數，表示發起正常請求。取值：

    • true：表示發起預檢請求，僅檢查請求是否滿足執行條件，不執行請求指定的操作。預檢未通過時傳回相應錯誤碼；預檢通過時傳回錯誤碼 Defense.Control.DryRunOperation。

    • false：表示發起正常請求；檢查通過後執行請求指定的操作。

    false
    UnbindResources

    array

    否

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

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

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

    cn-hangzhou

    string

    否

    解除綁定的防護物件。

    abc
    UnbindResourceGroups

    array

    否

    阿里雲資源群組 ID。

    rg-acfm***q

    string

    否

    解除綁定的防護物件群組。

    group1

    否

    建立預設防護範本時解除綁定的防護物件，使用["XX1","XX2",……]格式。

    說明

    該參數只在建立預設範本（TemplateType 取值為user_default）時生效。

    否

    建立預設防護範本時解除綁定的防護物件群組，使用["group1","group2",……]格式。

    說明

    該參數只在建立預設範本（TemplateType 取值為user_default）時生效。

    Detail 參數說明

    防護範本在不同的防護場景（DefenseScene），Detail 參數內容不同。

    新版 Web 核心防護（waf_base）

    參數說明

    名稱類型是否必選範例值說明
    aiWhitelistStatusinteger選填1新版基礎防護的智慧加白引擎狀態。取值：
    - 0（預設）：表示關閉。
    - 1：表示開啟。




    範例

    {
  "aiWhitelistStatus": 1
}

    新版 BOT 管理（bot_manager）

    參數說明

    名稱類型是否必選範例值說明
    trafficFeatureString選填{"global":1,"excludeStatus":1,"staticFile":".css,.js,.jpg,……"}BOT 管理防護範本的防護範圍設定，以 JSON 字串格式進行描述。當防護場景（DefenseScene）為 bot_manager 時必選。具體設定資訊，請參見trafficFeature 詳細設定。

    trafficFeature 詳細設定

    名稱類型是否必選範例值說明
    globalInteger必選1防護範圍是否為全站。取值：
    - 0：表示自訂防護範圍，需透過 conditions 指定生效的流量特徵。
    - 1：表示全域防護，即範本對該防護物件的全部請求生效。




    excludeStatusInteger選填1是否排除靜態資源，即命中 staticFile 中靜態檔案副檔名的請求不進入 BOT 防護。取值：
    - 0：表示不排除靜態資源。
    - 1：表示排除靜態資源，需透過 staticFile 指定要排除的靜態檔案副檔名。




    staticFileString選填.7z,.aac,.css,.js,.jpg,.png,.pdf,.zip,……要排除的靜態檔案副檔名清單，以半形逗號（,）分隔的字串表示，每個副檔名以半形句號（.）開頭。僅 excludeStatus 設定為 1 時，設定該資訊。
    conditionsArray選填[{"key":"URL","opValue":"not-contain","values":"test"}]自訂防護範圍的流量特徵，以 JSON 字串格式進行描述。僅 global 設定為 0 時，允許設定該資訊。具體設定資訊，請參見防護規則參數設定說明中 conditions 設定說明。

    範例

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

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    請求傳回結構。

    RequestId

    string

    請求 ID。

    F48ABDF7-D777-5F26-892A-57349765D7A9
    TemplateId

    integer

    防護範本 ID。

    2212

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "F48ABDF7-D777-5F26-892A-57349765D7A9",
  "TemplateId": 2212
}

    錯誤碼

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

    變更歷史

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