雲端產品接入 WAF,目前僅支援 ECS 和 CLB。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-waf:CreateCloudResource |
create |
*DefenseResource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
WAF 執行個體的 ID。 說明
您可以呼叫 DescribeInstance 查詢目前 WAF 執行個體的 ID。 |
waf_v3prepaid_public_cn-*** |
| ResourceManagerResourceGroupId |
string |
否 |
阿里雲資源群組 ID。 |
rg-acfm***q |
| Listen |
object |
是 |
設定監聽資訊。 |
|
| TLSVersion |
string |
否 |
要新增的 TLS 版本。僅當 HttpsPorts 取值不為空(表示網域使用 HTTPS 通訊協定)時,才使用此參數。取值:
|
tlsv1 |
| EnableTLSv3 |
boolean |
否 |
是否支援 TLS 1.3 版本。僅當 HttpsPorts 取值不為空(表示網域使用 HTTPS 通訊協定)時,才使用此參數。取值:
|
true |
| CipherSuite |
integer |
否 |
要新增的加密套件類型。僅當 HttpsPorts 取值不為空(表示網域使用 HTTPS 通訊協定)時,才使用此參數。取值:
|
1 |
| CustomCiphers |
array |
否 |
要新增的具體自訂加密套件。僅當 CipherSuite 設定為 99 時,才使用此參數。 |
|
|
string |
否 |
要新增的具體自訂加密套件。僅當 CipherSuite 設定為 99 時,才使用此參數。 |
ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384 |
|
| ResourceProduct |
string |
是 |
雲端產品類型。 枚舉值:
|
clb4 |
| Port |
integer |
否 |
接入 WAF 的雲端產品連接埠。 |
80 |
| ResourceInstanceId |
string |
否 |
雲端產品執行個體的 ID。 |
lb-bp1***** |
| Protocol |
string |
否 |
通訊協定類型。 枚舉值:
|
http |
| Certificates |
array<object> |
否 |
憑證 ID 清單。 |
|
|
object |
否 |
憑證資訊。 |
||
| CertificateId |
string |
否 |
要新增的憑證 ID。 說明
您可以呼叫 DescribeResourceInstanceCerts 查詢雲端產品執行個體關聯的所有 SSL 憑證 ID。 |
123-cn-hangzhou |
| AppliedType |
string |
否 |
HTTPS 通訊協定的憑證類型。取值:
|
default |
| Http2Enabled |
boolean |
否 |
是否啟用 HTTP/2。僅當 HttpsPorts 取值不為空(表示網域使用 HTTPS 通訊協定)時,才使用此參數。取值:
|
true |
| ResourceRegionId |
string |
否 |
雲端產品所屬地域 ID。 說明
若要接入的執行個體 ID 尚未同步至 WAF,則必須輸入此參數。 |
cn-hangzhou |
| Domain |
string |
否 |
接入 WAF 的網域。 說明
僅當雲端產品類型為 ddos 時為必填;其餘產品類型,此欄位為空。 |
www.c**sw.net |
| Redirect |
object |
否 |
設定轉送資訊。 |
|
| RequestHeaders |
array<object> |
否 |
此參數值的格式為 [{"k":"key","v":"value"}]。其中,key 表示指定的自訂請求標頭欄位,value 表示為該欄位設定的值。 說明
如果請求中已存在該自訂標頭欄位,系統將使用設定的流量標記值覆蓋請求中該自訂欄位的值。 |
|
|
object |
否 |
此參數值的格式為 [{"k":"key","v":"value"}]。其中,key 表示指定的自訂請求標頭欄位,value 表示為該欄位設定的值。 |
||
| Key |
string |
否 |
指定的自訂請求標頭欄位。 |
key1 |
| Value |
string |
否 |
自訂請求標頭欄位設定的值。 |
value1 |
| XffHeaderMode |
integer |
否 |
WAF 取得用戶端真實 IP 的方式。取值:
|
1 |
| XffHeaders |
array |
否 |
設定用於取得用戶端 IP 的自訂欄位清單,使用 ["header1","header2",……] 格式表示。 說明
僅當 XffHeaderMode 取值為 2(表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP)時,才需要設定此參數。 |
|
|
string |
否 |
設定用於取得用戶端 IP 的自訂欄位清單,使用 ["header1","header2",……] 格式表示。 說明
僅當 XffHeaderMode 取值為 2(表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP)時,才需要設定此參數。 |
header1 |
|
| ReadTimeout |
integer |
否 |
讀取逾時時間,單位:秒。 取值範圍:1~3600。 |
1 |
| WriteTimeout |
integer |
否 |
寫入逾時時間,單位:秒。 取值範圍:1~3600。 |
1 |
| Keepalive |
boolean |
否 |
是否保持長連線。取值:
|
true |
| KeepaliveRequests |
integer |
否 |
複用長連線的請求數量。取值範圍:60~1000,單位:個。 說明
啟用長連線後,可複用的長連線數量。 |
1000 |
| KeepaliveTimeout |
integer |
否 |
閒置長連線逾時時間,取值範圍:10~3600,預設值為 3600,單位:秒。 說明
複用的長連線閒置多久後釋放。 |
3600 |
| XffProto |
boolean |
否 |
X-Forward-For-Proto 傳遞 WAF 的通訊協定。取值:
|
true |
| MaxBodySize |
integer |
否 |
最大請求主體大小。取值範圍:2~10,預設值:2,單位:G。 說明
僅旗艦版支援。 |
2 |
| Tag |
array<object> |
否 |
標籤清單,最多包含 20 個子項目。 |
|
|
object |
否 |
|||
| Key |
string |
否 |
標籤鍵。 |
TagKey1 |
| Value |
string |
否 |
標籤值。 |
TagValue1 |
| RegionId |
string |
是 |
WAF 執行個體所屬地域。取值:
|
cn-hangzhou |
| OwnerUserId |
string |
否 |
目前資源歸屬 UID。 |
123 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
66A98669-ER12-WE34-23PO-301469*****E |
| CloudResourceId |
string |
接入的資源 ID,由 WAF 自動產生。 |
lb-*** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "66A98669-ER12-WE34-23PO-301469*****E",
"CloudResourceId": "lb-***"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | Waf.Pullin.CertNotExist | Certificate does not exist in SSL Certificate Center, certificate type:%s, certificate ID:%s. | 憑證在 SSL 憑證中心不存在,憑證類型:%s,憑證 ID:%s。 |
| 400 | Waf.Pullin.CertExpired | Certificate expired, certificate ID:%s . | 憑證已過期,憑證 ID:%s。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。