調用CreateDomain添加網域名稱配置資訊,將您的網域名稱接入WAF執行個體進行防護。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
請求參數
名稱 | 類型 | 是否必選 | 樣本值 | 描述 |
Action | String | 是 | CreateDomain | 要執行的操作。取值:CreateDomain。 |
InstanceId | String | 是 | waf-cn-7pp26f1**** | WAF執行個體的ID。 說明 您可以調用DescribeInstanceInfo查詢當前WAF執行個體的ID。 |
Domain | String | 是 | www.example.com | 要添加到WAF防護的網域名稱。 |
IsAccessProduct | Integer | 是 | 0 | 網域名稱在WAF前是否配置有七層代理(例如高防、CDN等),即用戶端訪問流量到WAF前是否有經過其他七層代理轉寄。取值:
|
AccessHeaderMode | Integer | 否 | 0 | WAF擷取用戶端真實IP的方式。取值:
說明 僅在IsAccessProduct取值為1(表示WAF前有其他七層代理服務)時,需要設定該參數。 |
AccessHeaders | String | 否 | ["X-Client-IP"] | 設定用於擷取用戶端IP的自訂欄位列表,使用 說明 僅在AccessHeaderMode取值為1(表示WAF讀取要求標頭中由您設定的自訂欄位值作為用戶端IP)時,需要設定該參數。 |
LogHeaders | String | 否 | [{"k":"ALIWAF-TAG","v":"Yes"}] | 網域名稱的流量標記欄位和值,用於標記經過WAF處理的流量。 該參數值的格式為 通過指定自訂要求標頭部欄位和對應的值,當網域名稱的訪問流量經過WAF時,WAF自動在要求標頭部中添加所設定的自訂欄位值作為流量標記,便於後端服務統計相關資訊。 說明 如果請求中已存在該自訂頭部欄位,系統將用所設定的流量標記值覆蓋請求中該自訂欄位的值。 |
ResourceGroupId | String | 否 | rg-atstuj3rtop**** | WAF執行個體在資源管理服務中所屬的資源群組ID。預設為空白,即屬於預設資源群組。 關於資源群組的更多資訊,請參見建立資源群組。 |
AccessType | String | 否 | waf-cloud-dns | 網域名稱接入方式。取值:
|
HttpPort | String | 否 | [80] | HTTP協議連接埠列表,使用 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。設定該參數表示網域名稱使用HTTP協議。HttpPort與HttpsPort不允許同時為空白。 |
HttpsPort | String | 否 | [443] | HTTPS協議連接埠列表,使用 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。設定該參數表示網域名稱使用HTTPS協議。HttpPort與HttpsPort不允許同時為空白。 |
HttpsRedirect | Integer | 否 | 0 | 是否開啟HTTPS強制跳轉。開啟強制跳轉後,用戶端的HTTP請求將被強制跳轉成HTTPS請求,預設跳轉連接埠為443。取值:
說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。 |
Http2Port | String | 否 | [443] | HTTP 2.0協議連接埠列表,使用 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。 |
HttpToUserIp | Integer | 否 | 0 | 是否開啟HTTP回源。開啟HTTP回源後,HTTPS訪問請求將通過HTTP協議轉寄回來源站點,預設回源連接埠為80。取值:
說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。 |
IpFollowStatus | Integer | 否 | 1 | 來源站點伺服器位址同時包含IPv4和IPv6地址時,是否開啟IPv4/IPv6回源協議跟隨。開啟回源協議跟隨後,WAF將來自IPv4地址的請求轉寄到IPv4來源站點、將來自IPv6地址的請求轉寄到IPv6來源站點。取值:
說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。 |
SourceIps | String | 否 | ["39.XX.XX.197"] | 網域名稱對應的來源站點伺服器IP或伺服器回源網域名稱。您只能選擇設定來源站點伺服器IP或伺服器回源網域名稱中的一種:
說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。 |
LoadBalancing | Integer | 否 | 0 | 回源時採用的負載平衡演算法。取值:
說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。 |
ClusterType | Integer | 否 | 0 | WAF防護叢集類型。取值:
說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。 |
ConnectionTime | Integer | 否 | 5 | WAF獨享叢集的連線逾時時間長度。單位:秒。 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且ClusterType取值為1(表示網域名稱使用WAF獨享叢集)時,需要設定該參數。 |
ReadTime | Integer | 否 | 120 | WAF獨享叢集的讀連線逾時時間長度。單位:秒。 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且ClusterType取值為1(表示網域名稱使用WAF獨享叢集)時,需要設定該參數。 |
WriteTime | Integer | 否 | 120 | WAF獨享叢集的寫連線逾時時間長度。單位:秒。 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且ClusterType取值為1(表示網域名稱使用WAF獨享叢集)時,需要設定該參數。 |
CloudNativeInstances | String | 否 | [{"ProtocolPortConfigs":[{"Ports":[80],"Protocol":"http"}],"RedirectionTypeName":"ALB","InstanceId":"alb-s65nua68wdedsp****","IPAddressList":["182.XX.XX.113"],"CloudNativeProductName":"ALB"}] | 透明接入的伺服器及連接埠配置列表。使用JSON數組轉化的字串格式表示。JSON數組中的每個元素是一個結構體,包含以下欄位:
說明 僅在AccessType為waf-cloud-native(表示網域名稱使用透明接入方式)時,需要設定該參數。 |
SniStatus | Integer | 否 | 1 | 設定是否開啟回源SNI。回源SNI表示WAF轉寄用戶端請求到來源站點伺服器,在與來源站點進行TLS握手時,通過SNI擴充欄位(Server Name Indicator extension)指定要訪問的主機,並與該主機建立HTTPS串連。如果您的來源站點伺服器有多個虛擬機器主機(對應不同網域名稱),則您需要開啟回源SNI。取值:
中國內地WAF執行個體預設關閉SNI回源;海外地區WAF執行個體預設開啟SNI回源。 說明 僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。 |
SniHost | String | 否 | waf.example.com | 自訂SNI擴充欄位的值。如果不設定該參數,則預設使用要求標頭中Host欄位的值作為SNI擴充欄位的值。 一般情況無需自訂SNI,除非您的業務有特殊配置要求,希望WAF在回源請求中使用與實際請求Host不一致的SNI(即此處設定的自訂SNI)。 說明 僅在SniStatus取值為1(表示開啟SNI回源)時,需要設定該參數。 |
Retry | Boolean | 否 | true | WAF回源失敗時,是否重試。取值:
|
Keepalive | Boolean | 否 | true | 是否保持長串連。取值:
|
KeepaliveRequests | Integer | 否 | 1000 | 複用長串連的請求個數。取值範圍:60~1000,單位:個。 說明 開啟長串連後,複用多少個長串連。 |
KeepaliveTimeout | Integer | 否 | 15 | 空閑長連線逾時時間,取值範圍:1~60,預設15,單位:秒。 說明 複用的長串連空閑多長時間後釋放。 |
調用API時,除了本文中該API的請求參數,還需加入阿里雲API公用請求參數。公用請求參數的詳細介紹,請參見公用參數。
調用API的請求格式,請參見本文樣本中的請求樣本。
返回資料
名稱 | 類型 | 樣本值 | 描述 |
Cname | String | mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com | WAF為網域名稱分配的CNAME地址。 說明 僅當網域名稱使用CNAME接入方式(請求參數AccessType取值為waf-cloud-dns)時,返回該參數。 |
RequestId | String | D7861F61-5B61-46CE-A47C-6B19160D5EB0 | 本次請求的ID。 |
樣本
請求樣本
http(s)://[Endpoint]/?Action=CreateDomain
&InstanceId=waf-cn-7pp26f1****
&Domain=www.example.com
&IsAccessProduct=0
&HttpPort=[\"80\"]
&SourceIps=[\"39.XX.XX.197\"]
&<公用請求參數>
正常返回樣本
XML
格式
<CreateDomainResponse>
<Cname>mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com</Cname>
<RequestId>D7861F61-5B61-46CE-A47C-6B19160D5EB0</RequestId>
</CreateDomainResponse>
JSON
格式
{
"Cname": "mmspx7qhfvnfzggheh1g2wnbhog66vcv.****.com",
"RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。