雲產品接入WAF,當前只支援ECS和CLB。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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 |
否 |
是否支援 TLS1.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 |
| ResourceInstanceId |
string |
是 |
雲產品執行個體的 ID。 |
lb-bp1***** |
| Port |
integer |
是 |
接入 WAF 的雲產品連接埠。 |
80 |
| Protocol |
string |
是 |
協議類型。取值:
|
http |
| Certificates |
array<object> |
否 |
認證 ID 列表。 |
|
|
object |
否 |
認證資訊。 |
||
| CertificateId |
string |
否 |
要添加的認證的 ID。 說明
您可以調用 DescribeResourceInstanceCerts 查詢雲產品執行個體關聯的所有 SSL 憑證的 ID。 |
123-cn-hangzhou |
| AppliedType |
string |
否 |
HTTPS 協議的認證類型。取值:
|
default |
| Http2Enabled |
boolean |
否 |
是否開啟 HTTP2。僅 HttpsPorts 取值不為空白(表示網域名稱使用 HTTPS 協議)時,使用該參數。取值:
|
true |
| ResourceRegionId |
string |
否 |
雲產品歸屬地區 ID。 說明
要接入的執行個體 ID,未同步到 WAF 時,此參數必須輸入。 |
cn-hangzhou |
| 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 . |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。