建立防護對象。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-waf:CreateDefenseResource |
create |
*DefenseResource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Resource |
string |
否 |
防護對象名稱。 說明
|
abctest.com |
| Product |
string |
是 |
雲產品名稱。取值:
|
ecs |
| ResourceGroup |
string |
否 |
防護對象加入防護組的名稱,可選。 |
testGroup |
| ResourceOrigin |
string |
是 |
防護對象來源。只支援取值:
|
custom |
| Pattern |
string |
是 |
防護對象的防護形式。取值:
|
domain |
| Detail |
string |
是 |
防護對象的具體參數資訊,以一系列參數構造的 JSON 格式轉化成字串。 說明
根據所指定的雲產品(Product)和防護形式(Pattern)不同,具體涉及的參數有所不同。詳細資料,請參見防護對象 Detail 參數描述。 |
{\"domain\": \"zhhclb4test096-05111.test.com\"} |
| XffStatus |
integer |
否 |
防護對象是否開啟 xff 代理。取值:
|
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 |
否 |
防護對象描述資訊。 |
test |
| 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 |
防護對象 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 防護的網域名稱。 |
樣本
{
"domain": "ecs.test.com"
}
CLB 網域名稱接入(Product 取值為 clb4 或 clb7,Pattern 取值為 domain)
將已接入 WAF 的 CLB 執行個體中的某個網域名稱添加為防護對象。
參數描述
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| domain | String | 必選 | clb.test.com | 要接入 WAF 防護的網域名稱。 |
樣本
{
"domain": "clb.test.com"
}
NLB 網域名稱接入(Product 取值為 nlb,Pattern 取值為 domain)
將已接入 WAF 的 CLB 執行個體中的某個網域名稱添加為防護對象。
參數描述
| 名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
| domain | String | 必選 | nlb.test.com | 要接入 WAF 防護的網域名稱。 |
樣本
{
"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。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。