全部產品
Search
文件中心

:CreateDomain

更新時間:Jul 01, 2024

調用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前是否有經過其他七層代理轉寄。取值:

  • 0:表示否。

  • 1:表示是。

AccessHeaderMode

Integer

0

WAF擷取用戶端真實IP的方式。取值:

  • 0(預設):表示WAF讀取要求標頭中X-Forwarded-For(XFF)欄位的第一個值作為用戶端IP。

  • 1:表示WAF讀取要求標頭中由您設定的自訂欄位值作為用戶端IP。

說明

僅在IsAccessProduct取值為1(表示WAF前有其他七層代理服務)時,需要設定該參數。

AccessHeaders

String

["X-Client-IP"]

設定用於擷取用戶端IP的自訂欄位列表,使用["header1","header2",……]格式表示。

說明

僅在AccessHeaderMode取值為1(表示WAF讀取要求標頭中由您設定的自訂欄位值作為用戶端IP)時,需要設定該參數。

LogHeaders

String

[{"k":"ALIWAF-TAG","v":"Yes"}]

網域名稱的流量標記欄位和值,用於標記經過WAF處理的流量。

該參數值的格式為[{"k":"_key_","v":"_value_"}]。其中,_key_表示所指定的自訂要求標頭部欄位,_value_表示為該欄位設定的值。

通過指定自訂要求標頭部欄位和對應的值,當網域名稱的訪問流量經過WAF時,WAF自動在要求標頭部中添加所設定的自訂欄位值作為流量標記,便於後端服務統計相關資訊。

說明

如果請求中已存在該自訂頭部欄位,系統將用所設定的流量標記值覆蓋請求中該自訂欄位的值。

ResourceGroupId

String

rg-atstuj3rtop****

WAF執行個體在資源管理服務中所屬的資源群組ID。預設為空白,即屬於預設資源群組。

關於資源群組的更多資訊,請參見建立資源群組

AccessType

String

waf-cloud-dns

網域名稱接入方式。取值:

  • waf-cloud-dns(預設):表示CNAME接入。

  • waf-cloud-native:表示透明接入。

HttpPort

String

[80]

HTTP協議連接埠列表,使用[port1,port2,……]格式表示。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。設定該參數表示網域名稱使用HTTP協議。HttpPortHttpsPort不允許同時為空白。

HttpsPort

String

[443]

HTTPS協議連接埠列表,使用[port1,port2,……]格式表示。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。設定該參數表示網域名稱使用HTTPS協議。HttpPortHttpsPort不允許同時為空白。

HttpsRedirect

Integer

0

是否開啟HTTPS強制跳轉。開啟強制跳轉後,用戶端的HTTP請求將被強制跳轉成HTTPS請求,預設跳轉連接埠為443。取值:

  • 0(預設):表示關閉。

  • 1:表示開啟。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。

Http2Port

String

[443]

HTTP 2.0協議連接埠列表,使用[port1,port2,……]格式表示。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。

HttpToUserIp

Integer

0

是否開啟HTTP回源。開啟HTTP回源後,HTTPS訪問請求將通過HTTP協議轉寄回來源站點,預設回源連接埠為80。取值:

  • 0(預設):表示關閉。

  • 1:表示開啟。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)且HttpsPort取值不為空白(表示網域名稱使用HTTPS協議)時,需要設定該參數。

IpFollowStatus

Integer

1

來源站點伺服器位址同時包含IPv4和IPv6地址時,是否開啟IPv4/IPv6回源協議跟隨。開啟回源協議跟隨後,WAF將來自IPv4地址的請求轉寄到IPv4來源站點、將來自IPv6地址的請求轉寄到IPv6來源站點。取值:

  • 0(預設):表示關閉。

  • 1:表示開啟。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。

SourceIps

String

["39.XX.XX.197"]

網域名稱對應的來源站點伺服器IP或伺服器回源網域名稱。您只能選擇設定來源站點伺服器IP或伺服器回源網域名稱中的一種:

  • 設定來源站點伺服器IP時,使用["ip1","ip2",……]格式表示。最多支援添加20個IP。

  • 設定伺服器回源網域名稱時,使用["domain"]格式表示。只能填寫1個網域名稱地址。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。

LoadBalancing

Integer

0

回源時採用的負載平衡演算法。取值:

  • 0:表示IP Hash演算法。

  • 1:表示輪詢演算法。

  • 2:表示Least Time演算法。

說明

僅在AccessType取值為waf-cloud-dns(表示網域名稱使用CNAME接入方式)時,需要設定該參數。

ClusterType

Integer

0

WAF防護叢集類型。取值:

  • 0(預設):表示物理叢集。

  • 1:表示虛擬叢集,即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數組中的每個元素是一個結構體,包含以下欄位:

  • ProtocolPortConfigs:JSON Array類型 | 必選 | 表示協議及連接埠配置列表。JSON數組中的每個元素是一個結構體,包含以下欄位:

    • Ports:Array類型 | 必選 | 表示連接埠列表,格式為[port1,port2,……]

    • Protocol:String類型 | 必選 | 表示協議類型。取值:httphttps

  • CloudNativeProductName:String類型 | 必選 | 表示雲產品執行個體的類型。取值:ECSSLBALB

  • RedirectionTypeName:String類型 | 必選 | 表示引流連接埠的類型。取值:ECS(表示ECS連接埠)、SLB-L4(表示SLB四層連接埠)、SLB-L7(表示SLB七層連接埠)、ALB(表示ALB連接埠)。

  • InstanceId:String類型 | 必選 | 表示雲產品執行個體的ID。

  • IPAddressList:Array類型 | 必選 | 表示雲產品執行個體的公網IP列表。格式為["ip1","ip2",……]

說明

僅在AccessTypewaf-cloud-native(表示網域名稱使用透明接入方式)時,需要設定該參數。

SniStatus

Integer

1

設定是否開啟回源SNI。回源SNI表示WAF轉寄用戶端請求到來源站點伺服器,在與來源站點進行TLS握手時,通過SNI擴充欄位(Server Name Indicator extension)指定要訪問的主機,並與該主機建立HTTPS串連。如果您的來源站點伺服器有多個虛擬機器主機(對應不同網域名稱),則您需要開啟回源SNI。取值:

  • 0:表示關閉。

  • 1:表示開啟。

中國內地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回源失敗時,是否重試。取值:

  • true(預設):表示重試。

  • false:表示不重試。

Keepalive

Boolean

true

是否保持長串連。取值:

  • true(預設):表示保持長串連。

  • false:表示不保持長串連。

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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。