將域名接入WAF實例進行防護。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-waf:CreateDomain | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | WAF 實例的 ID。 說明
您可以調用 DescribeInstance 查詢當前 WAF 實例的 ID。
| waf_cdnsdf3**** |
ResourceManagerResourceGroupId | string | 否 | 阿里云資源組 ID。 | rg-acfm***q |
Domain | string | 是 | 要查詢的域名名稱。 | www.aliyundoc.com |
Listen | object | 是 | 配置監聽信息。 | |
HttpsPorts | array | 否 | HTTPS 協議的監聽端口。 | |
integer | 否 | HTTPS 協議的監聽端口,使用 [port1,port2,......,portN] 格式。 | [443,8443] | |
HttpPorts | array | 否 | HTTP 協議的監聽端口。 | |
integer | 否 | HTTP 協議的監聽端口,使用[port1,port2,……]格式。 | [80,81] | |
Http2Enabled | boolean | 否 | 是否開啟 HTTP2。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。取值:
| true |
CertId | string | 否 | 要添加的證書的 ID。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。 | 123 |
SM2Enabled | boolean | 否 | 是否開啟國密證書 | true |
SM2CertId | string | 否 | 要添加的國密證書的 ID。僅 SM2Enabled 取值為 true 時,使用該參數。 | 123-cn-hangzhou |
SM2AccessOnly | boolean | 否 | 是否僅客端訪問。僅 SM2Enabled 取值為 true 時,使用該參數。
| true |
TLSVersion | string | 否 | 要添加的 TLS 版本。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。取值:
| tlsv1 |
EnableTLSv3 | boolean | 否 | 是否支持 TLS1.3 版本。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。取值:
| true |
CipherSuite | integer | 否 | 要添加的加密套件類型。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。取值:
| 2 |
CustomCiphers | array | 否 | 要添加的具體自定義加密套件。 | |
string | 否 | 要添加的具體自定義加密套件。僅 CipherSuite 配置為 99 時,使用該參數。 | ["xxx","ffas"] | |
FocusHttps | boolean | 否 | 是否開啟 HTTPS 的強制跳轉。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議),且 HttpPorts 取值為空(表示域名未使用 HTTP 協議)時,使用該參數。取值:
| true |
XffHeaderMode | integer | 否 | WAF 獲取客戶端真實 IP 的方式。取值:
| 1 |
XffHeaders | array | 否 | 設置用于獲取客戶端 IP 的自定義字段列表。 | |
string | 否 | 設置用于獲取客戶端 IP 的自定義字段列表,使用["header1","header2",……]格式表示。 說明
僅在 XffHeaderMode 取值為 2(表示 WAF 讀取請求頭中由您設置的自定義字段值作為客戶端 IP)時,需要設置該參數。
| ["Client-ip","cip"] | |
IPv6Enabled | boolean | 否 | 是否開啟 IPv6。取值:
| true |
ProtectionResource | string | 否 | 要使用的防護資源類型。取值:
| share |
ExclusiveIp | boolean | 否 | 是否開啟獨享 IP。僅 IPv6Enabled 取值為 false(表示不開啟 IPv6),且 ProtectionResource 取值為 share 時(表示使用共享集群)時,使用該參數。取值:
| true |
Redirect | object | 是 | 配置轉發信息。 | |
Backends | array | 否 | 域名對應的源站服務器 IP 或服務器回源域名。 | |
string | 否 | 域名對應的源站服務器 IP 或服務器回源域名。您只能選擇設置源站服務器 IP 或服務器回源域名中的一種,回源地址為域名時,只支持 IPv4,暫不支持 IPv6:
| [ "1.1.XX.XX", "2.2.XX.XX" ] | |
Loadbalance | string | 是 | 回源時采用的負載均衡算法。取值:
| roundRobin |
FocusHttpBackend | boolean | 否 | 是否開啟強制 HTTP 回源。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。取值:
| true |
SniEnabled | boolean | 否 | 是否開啟回源 SNI。僅 HttpsPorts 取值不為空(表示域名使用 HTTPS 協議)時,使用該參數。取值:
| true |
SniHost | string | 否 | 設置自定義 SNI 擴展字段的值。如果不設置該參數,則默認使用請求頭中 Host 字段的值作為 SNI 擴展字段的值。 一般情況無需自定義 SNI,除非您的業務有特殊配置要求,希望 WAF 在回源請求中使用與實際請求 Host 不一致的 SNI(即此處設置的自定義 SNI)。 說明
僅在 SniEnabled 取值為 true(表示開啟回源 SNI),需要設置該參數。
| www.aliyundoc.com |
RequestHeaders | array<object> | 否 | 域名的流量標記字段和值,用于標記經過 WAF 處理的流量。 通過指定自定義請求頭部字段和對應的值,當域名的訪問流量經過 WAF 時,WAF 自動在請求頭部中添加所設定的自定義字段值作為流量標記,便于后端服務統計相關信息。 | |
object | 否 | 該參數值的格式為[{"k":"key","v":"value"}]。其中,key表示所指定的自定義請求頭部字段,value表示為該字段設定的值。 | ||
Key | string | 否 | 指定的自定義請求頭部字段。 | aaa |
Value | string | 否 | 自定義請求頭部字段設定的值。 | bbb |
ConnectTimeout | integer | 否 | 連接超時時長。單位:秒。 取值范圍:1~3600。 | 120 |
ReadTimeout | integer | 否 | 讀超時時長,單位:秒。 取值范圍:1~3600。 | 200 |
WriteTimeout | integer | 否 | 寫超時時長,單位:秒。 取值范圍:1~3600。 | 200 |
CnameEnabled | boolean | 否 | 是否開啟公共云容災。取值:
| true |
RoutingRules | string | 否 | 混合云轉發規則。使用 JSON 數組轉化的字符串格式表示。JSON 數組中的每個元素是一個結構體,包含以下字段:
| [ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ] |
Keepalive | boolean | 否 | 是否保持長連接。取值:
| true |
Retry | boolean | 否 | WAF 回源失敗時,是否重試。取值:
| true |
KeepaliveRequests | integer | 否 | 復用長連接的請求個數。取值范圍:60~1000,單位:個。 說明
開啟長連接后,復用多少個長連接。
| 1000 |
KeepaliveTimeout | integer | 否 | 空閑長連接超時時間,取值范圍:1~60,默認 15,單位:秒。 說明
復用的長連接空閑多久后釋放。
| 15 |
XffProto | boolean | 否 | X-Forward-For-Proto 傳遞 WAF 的協議。取值:
| false |
BackupBackends | array | 否 | 域名對應的備用源站服務器 IP 或服務器回源域名。 | |
string | 否 | 域名對應的備用源站服務器 IP 或服務器回源域名。您只能選擇設置源站服務器 IP 或服務器回源域名中的一種,回源地址為域名時,只支持 IPv4,暫不支持 IPv6:
| [ "1.1.XX.XX", "2.2.XX.XX" ] | |
RegionId | string | 是 | WAF 實例所屬地域。取值:
| cn-hangzhou |
AccessType | string | 否 | WAF 實例的接入類型。取值:
| share |
Tag | array<object> | 否 | 標簽列表,最多包含 20 個子項 | |
object | 否 | 資源的標簽,最多支持 20 個子項。 | ||
Key | string | 否 | 標簽鍵。 | Tagkey1 |
Value | string | 否 | 標簽值 | TagValue1 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
"DomainInfo": {
"Cname": "xxxxxwww.****.com",
"Domain": "www.aliyundoc.com",
"DomainId": "www.aliyundoc.com-waf"
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-12-12 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2024-11-28 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2024-01-30 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2023-04-27 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-18 | OpenAPI 入參發生變更 | 查看變更詳情 |
2023-03-31 | OpenAPI 入參發生變更 | 查看變更詳情 |