將域名接入WAF實例進行防護。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
yundun-waf:CreateDomain |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | WAF 實例的 ID。 說明
您可以調用 DescribeInstanceInfo 查詢當前 WAF 實例的 ID。
| waf-cn-7pp26f1**** |
Domain | string | 是 | 要添加到 WAF 防護的域名。 | www.example.com |
SourceIps | string | 否 | 域名對應的源站服務器 IP 或服務器回源域名。您只能選擇設置源站服務器 IP 或服務器回源域名中的一種:
說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)時,需要設置該參數。
| ["39.XX.XX.197"] |
IsAccessProduct | integer | 是 | 域名在 WAF 前是否配置有七層代理(例如高防、CDN 等),即客戶端訪問流量到 WAF 前是否有經過其他七層代理轉發。取值:
| 0 |
AccessHeaderMode | integer | 否 | WAF 獲取客戶端真實 IP 的方式。取值:
說明
僅在 IsAccessProduct 取值為 1(表示 WAF 前有其他七層代理服務)時,需要設置該參數。
| 0 |
AccessHeaders | string | 否 | 設置用于獲取客戶端 IP 的自定義字段列表,使用 說明
僅在 AccessHeaderMode 取值為 1(表示 WAF 讀取請求頭中由您設置的自定義字段值作為客戶端 IP)時,需要設置該參數。
| ["X-Client-IP"] |
LoadBalancing | integer | 否 | 回源時采用的負載均衡算法。取值:
說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)時,需要設置該參數。
| 0 |
LogHeaders | string | 否 | 域名的流量標記字段和值,用于標記經過 WAF 處理的流量。 該參數值的格式為 通過指定自定義請求頭部字段和對應的值,當域名的訪問流量經過 WAF 時,WAF 自動在請求頭部中添加所設定的自定義字段值作為流量標記,便于后端服務統計相關信息。 說明
如果請求中已存在該自定義頭部字段,系統將用所設定的流量標記值覆蓋請求中該自定義字段的值。
| [{"k":"ALIWAF-TAG","v":"Yes"}] |
HttpPort | string | 否 | HTTP 協議端口列表,使用 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)時,需要設置該參數。設置該參數表示域名使用 HTTP 協議。HttpPort 與 HttpsPort 不允許同時為空。
| [80] |
HttpsPort | string | 否 | HTTPS 協議端口列表,使用 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)時,需要設置該參數。設置該參數表示域名使用 HTTPS 協議。HttpPort 與 HttpsPort 不允許同時為空。
| [443] |
Http2Port | string | 否 | HTTP 2.0 協議端口列表,使用 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不為空(表示域名使用 HTTPS 協議)時,需要設置該參數。
| [443] |
HttpToUserIp | integer | 否 | 是否開啟 HTTP 回源。開啟 HTTP 回源后,HTTPS 訪問請求將通過 HTTP 協議轉發回源站,默認回源端口為 80。取值:
說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不為空(表示域名使用 HTTPS 協議)時,需要設置該參數。
| 0 |
HttpsRedirect | integer | 否 | 是否開啟 HTTPS 強制跳轉。開啟強制跳轉后,客戶端的 HTTP 請求將被強制跳轉成 HTTPS 請求,默認跳轉端口為 443。取值:
說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不為空(表示域名使用 HTTPS 協議)時,需要設置該參數。
| 0 |
ClusterType | integer | 否 | WAF 防護集群類型。取值:
說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)時,需要設置該參數。
| 0 |
ResourceGroupId | string | 否 | WAF 實例在資源管理服務中所屬的資源組 ID。默認為空,即屬于默認資源組。 關于資源組的更多信息,請參見創建資源組。 | rg-atstuj3rtop**** |
ConnectionTime | integer | 否 | WAF 獨享集群的連接超時時長。單位:秒。 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值為 1(表示域名使用 WAF 獨享集群)時,需要設置該參數。
| 5 |
ReadTime | integer | 否 | WAF 獨享集群的讀連接超時時長。單位:秒。 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值為 1(表示域名使用 WAF 獨享集群)時,需要設置該參數。
| 120 |
WriteTime | integer | 否 | WAF 獨享集群的寫連接超時時長。單位:秒。 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 ClusterType 取值為 1(表示域名使用 WAF 獨享集群)時,需要設置該參數。
| 120 |
AccessType | string | 否 | 域名接入方式。取值:
| waf-cloud-dns |
CloudNativeInstances | string | 否 | 透明接入的服務器及端口配置列表。使用 JSON 數組轉化的字符串格式表示。JSON 數組中的每個元素是一個結構體,包含以下字段:
說明
僅在 AccessType 為waf-cloud-native(表示域名使用透明接入方式)時,需要設置該參數。
| [{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] |
IpFollowStatus | integer | 否 | 源站服務器地址同時包含 IPv4 和 IPv6 地址時,是否開啟 IPv4/IPv6 回源協議跟隨。開啟回源協議跟隨后,WAF 將來自 IPv4 地址的請求轉發到 IPv4 源站、將來自 IPv6 地址的請求轉發到 IPv6 源站。取值:
說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)時,需要設置該參數。
| 1 |
SniStatus | integer | 否 | 設置是否開啟回源 SNI。回源 SNI 表示 WAF 轉發客戶端請求到源站服務器,在與源站進行 TLS 握手時,通過 SNI 擴展字段(Server Name Indicator extension)指定要訪問的主機,并與該主機建立 HTTPS 連接。如果您的源站服務器有多個虛擬主機(對應不同域名),則您需要開啟回源 SNI。取值:
中國內地 WAF 實例默認關閉 SNI 回源;海外地區 WAF 實例默認開啟 SNI 回源。 說明
僅在 AccessType 取值為waf-cloud-dns(表示域名使用 CNAME 接入方式)且 HttpsPort 取值不為空(表示域名使用 HTTPS 協議)時,需要設置該參數。
| 1 |
SniHost | string | 否 | 自定義 SNI 擴展字段的值。如果不設置該參數,則默認使用請求頭中 Host 字段的值作為 SNI 擴展字段的值。 一般情況無需自定義 SNI,除非您的業務有特殊配置要求,希望 WAF 在回源請求中使用與實際請求 Host 不一致的 SNI(即此處設置的自定義 SNI)。 說明
僅在 SniStatus 取值為 1(表示開啟 SNI 回源)時,需要設置該參數。
| waf.example.com |
Retry | boolean | 否 | WAF 回源失敗時,是否重試。取值:
| true |
Keepalive | boolean | 否 | 是否保持長連接。取值:
| true |
KeepaliveRequests | integer | 否 | 復用長連接的請求個數。取值范圍:60~1000,單位:個。 說明
開啟長連接后,復用多少個長連接。
| 1000 |
KeepaliveTimeout | integer | 否 | 空閑長連接超時時間,取值范圍:1~60,默認 15,單位:秒。 說明
復用的長連接空閑多少長后釋放。
| 15 |
RegionId | string | 否 | WAF 實例所屬地域。取值:
| cn-hangzhou |
調用 API 時,除了本文中該 API 的請求參數,還需加入阿里云 API 公共請求參數。公共請求參數的詳細介紹,請參見公共參數。
調用 API 的請求格式,請參見本文示例中的請求示例。
返回參數
示例
正常返回示例
JSON
格式
{
"Cname": "mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com",
"RequestId": "D7861F61-5B61-46CE-A47C-6B19****5EB0"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-08-28 | API 內部配置變更,不影響調用 | 看變更集 | ||||||||||
| ||||||||||||
2023-05-23 | OpenAPI 入參發生變更 | 看變更集 | ||||||||||
|