調用CreateDefenseResource API建立防護對象-Web Application Firewall-阿里雲 - Web Application Firewall

建立防護物件。

調試

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

調試

授權資訊

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

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:CreateDefenseResource

create

*DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/*

無

請求參數

名稱	類型	必填	描述	樣本值
Resource	string	否	防護物件名稱。說明只有混合雲端服務化的防護物件支援自訂防護物件名稱。	abctest.com
Product	string	是	雲端產品名稱。取值： alb：表示 ALB 產品。 ecs：表示 ECS 產品。 clb4：表示 CLB 產品 4 層接入。 clb7：表示 CLB 產品 7 層接入。 nlb：表示 NLB 產品。 waf：表示 WAF 產品。	ecs
ResourceGroup	string	否	防護物件加入防護組的名稱，可選。	testGroup
ResourceOrigin	string	是	防護物件來源。僅支援取值： custom：使用者自訂。	custom
Pattern	string	是	防護物件的防護形式。取值： domain：表示以網域方式防護。 multi_service：表示以混合雲端服務化的方式防護。說明目前僅支援以下組合：Product 取值為 alb、ecs、clb4、clb7、nlb 時，Pattern 取值為 domain；Product 取值為 waf 時，Pattern 取值為 multi_service。	domain
Detail	string	是	防護物件的具體參數資訊，以一系列參數建構的 JSON 格式轉化成字串。說明根據所指定的雲端產品（Product）和防護形式（Pattern）不同，具體涉及的參數有所不同。詳細資訊，請參見防護物件 Detail 參數描述。重要當 Product 取值為 ecs、clb4、clb7、nlb 時，接入中國內地地域的網域必須已完成 ICP 備案。	{\"domain\": \"zhhclb4test096-05111.test.com\"}
XffStatus	integer	否	防護物件是否開啟 xff 代理。取值： 0：未開啟（預設）。 1：開啟。	0
CustomHeaders	array	否	指定 Header 欄位清單。說明 XffStatus = 1 時，取指定 Header 欄位中的第一個 IP 作為用戶端來源 IP，避免 XFF 偽造，輸入多個 Header 時按順序依次嘗試取得來源 IP，如果第一個取不到則取第二個，以此類推，如果所有指定 Header 都取不到，則取 X-Forwarded-For 中第一個 IP。XffStatus = 1 時，表示從第一個獲取。
	string	否	指定的 Header 欄位。	x-forwarded-for
Description	string	否	防護物件描述資訊。	ResourceTest
InstanceId	string	是	WAF 執行個體的 ID。說明您可以呼叫 DescribeInstance 查詢目前 WAF 執行個體的 ID。	waf_v3prepaid_public_cn-4xl*******
OwnerUserId	string	否	多帳號情境時，防護物件所屬的帳號 ID。預設防護物件屬於 WAF 管理員帳號。	123221XXX
Tag	array<object>	否	標籤清單，最多包含 20 個子項目。
	object	否	資源標籤清單，最多包含 20 個子項目。
Key	string	否	標籤鍵。	demoTagKey
Value	string	否	標籤值。	TagValue1
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q
RegionId	string	否	WAF 執行個體所屬地域。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou

防護物件 Detail 參數描述。

ALB 網域接入（Product 取值為 alb，Pattern 取值為 domain）

將已接入 WAF 的 ALB 執行個體中的某個網域新增為防護物件。

參數描述

名稱	類型	是否必選	範例值	描述
instanceId	String	必選	alb-cj3w3********1x	已接入 WAF 的 ALB 執行個體 ID。
domain	String	必選	alb.test.com	要接入 WAF 防護的網域。

範例

{
    "domain": "alb.test.com",
    "instanceId": "alb-cj3w3********1x"
}

ECS 網域接入（Product 取值為 ecs，Pattern 取值為 domain）

將已接入 WAF 的 ECS 執行個體中的某個網域新增為防護物件。

參數描述

名稱	類型	是否必選	範例值	描述
domain	String	必選	ecs.test.com	要接入 WAF 防護的網域。該網域接入中國內地地域時，必須已完成 ICP 備案。

範例

{
    "domain": "ecs.test.com"
}

CLB 網域接入（Product 取值為 clb4 或 clb7，Pattern 取值為 domain）

將已接入 WAF 的 CLB 執行個體中的某個網域新增為防護物件。

參數描述

名稱	類型	是否必選	範例值	描述
domain	String	必選	clb.test.com	要接入 WAF 防護的網域。該網域接入中國內地地域時，必須已完成 ICP 備案。

範例

{
    "domain": "clb.test.com"
}

NLB 網域接入（Product 取值為 nlb，Pattern 取值為 domain）

將已接入 WAF 的 NLB 執行個體中的某個網域新增為防護物件。

參數描述

名稱	類型	是否必選	範例值	描述
domain	String	必選	nlb.test.com	要接入 WAF 防護的網域。該網域接入中國內地地域時，必須已完成 ICP 備案。

範例

{
    "domain": "nlb.test.com"
}

WAF 混合雲端服務化接入（Product 取值為 waf，Pattern 取值為 multi_service）

將 WAF 混合雲端服務化接入叢集的某個網域路徑建立防護物件。

參數描述

名稱	類型	是否必選	範例值	描述
domain	String	必選	a.test.com	要接入 WAF 防護的網域或 IP。
url	String	必選	/abc	URL 路徑

範例

{
    "domain": "a.test.com",
    "url": "/abc"
}

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	1738C613-D054-5191-888B-DC0CF4C3A4A0
Resource	string	建立的防護物件名稱。	cdX.XXX-call.cn-alb

樣本

正常返回樣本

JSON格式

{
  "RequestId": "1738C613-D054-5191-888B-DC0CF4C3A4A0",
  "Resource": "cdX.XXX-call.cn-alb"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Waf.Pullin.ResourceExsit	Access resource already exists, resource:%s.	接入資源已存在，已存在的資源：%s。

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

變更歷史

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