CreateDomain - 添加CNAME接入資源 -

將網域名稱接入WAF執行個體進行防護。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱	類型	必填	描述	樣本值
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：表示開啟 HTTP2。 false（預設）：表示不開啟 HTTP2。	true
CertId	string	否	要添加的認證的 ID。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議）時，使用該參數。	123
SM2Enabled	boolean	否	是否開啟國密認證	true
SM2CertId	string	否	要添加的國密認證的 ID。僅 SM2Enabled 取值為 true 時，使用該參數。	123-cn-hangzhou
SM2AccessOnly	boolean	否	是否僅客端訪問。僅 SM2Enabled 取值為 true 時，使用該參數。 true：僅國密用戶端才可以訪問。 false：國密和非國密均可以訪問。	true
TLSVersion	string	否	要添加的 TLS 版本。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議）時，使用該參數。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1
EnableTLSv3	boolean	否	是否支援 TLS1.3 版本。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議）時，使用該參數。取值： true：表示支援 TLS1.3 版本。 false：表示不支援 TLS1.3 版本。	true
CipherSuite	integer	否	要添加的加密套件類型。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議）時，使用該參數。取值： 1：表示添加全部加密套件。 2：表示添加強加密套件。僅 TLSVersion 取值為tlsv1.2時，可選擇該取值。 99：表示添加自訂加密套件。	2
CustomCiphers	array	否	要添加的具體自訂加密套件。
	string	否	要添加的具體自訂加密套件。僅 CipherSuite 配置為 99 時，使用該參數。	["xxx","ffas"]
FocusHttps	boolean	否	是否開啟 HTTPS 的強制跳轉。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議），且 HttpPorts 取值為空白（表示網域名稱未使用 HTTP 協議）時，使用該參數。取值： true：表示開啟 HTTPS 的強制跳轉。 false：表示不開啟 HTTPS 的強制跳轉。	true
XffHeaderMode	integer	否	WAF 擷取用戶端真實 IP 的方式。取值： 0（預設）：表示用戶端訪問流量到 WAF 前沒有經過其他七層代理轉寄。 1：表示 WAF 讀取要求標頭中 X-Forwarded-For（XFF）欄位的第一個值作為用戶端 IP。 2：表示 WAF 讀取要求標頭中由您設定的自訂欄位值作為用戶端 IP。	1
XffHeaders	array	否	設定用於擷取用戶端 IP 的自訂欄位列表。
	string	否	設定用於擷取用戶端 IP 的自訂欄位列表，使用["header1","header2",……]格式表示。說明僅在 XffHeaderMode 取值為 2（表示 WAF 讀取要求標頭中由您設定的自訂欄位值作為用戶端 IP）時，需要設定該參數。	["Client-ip","cip"]
IPv6Enabled	boolean	否	是否開啟 IPv6。取值： true：表示開啟 IPv6。 false（預設）：表示不開啟 IPv6。	true
ProtectionResource	string	否	要使用的防護資源類型。取值： share（預設）：表示使用共用叢集。 gslb：表示使用共用叢集智能負載平衡。	share
ExclusiveIp	boolean	否	是否開啟獨享 IP。僅 IPv6Enabled 取值為 false（表示不開啟 IPv6），且 ProtectionResource 取值為 share 時（表示使用共用叢集）時，使用該參數。取值： true：表示開啟獨享 IP。 false（預設）：表示不開啟獨享 IP。	true
Redirect	object	是	配置轉寄資訊。
Backends	array	否	網域名稱對應的來源站點伺服器 IP 或伺服器回源網域名稱。
	string	否	網域名稱對應的來源站點伺服器 IP 或伺服器回源網域名稱。您只能選擇設定來源站點伺服器 IP 或伺服器回源網域名稱中的一種，回源地址為網域名稱時，只支援 IPv4，暫不支援 IPv6：設定來源站點伺服器 IP 時，使用["ip1","ip2",……]格式表示。最多支援添加 20 個 IP。設定伺服器回源網域名稱時，使用["domain"]格式表示。最多支援添加 20 個網域名稱地址。	[ "1.1.XX.XX", "2.2.XX.XX" ]
Loadbalance	string	是	回源時採用的負載平衡演算法。取值： iphash：表示 IPHash 演算法。 roundRobin：表示輪詢演算法。 leastTime：表示 Least Time 演算法。僅 ProtectionResource 取值為 gslb（表示防護資源類型使用共用叢集智能負載平衡）時，可選擇該取值。	roundRobin
FocusHttpBackend	boolean	否	是否開啟強制 HTTP 回源。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議）時，使用該參數。取值： true：表示開啟強制 HTTP 回源。 false：表示不開啟強制 HTTP 回源。	true
SniEnabled	boolean	否	是否開啟回源 SNI。僅 HttpsPorts 取值不為空白（表示網域名稱使用 HTTPS 協議）時，使用該參數。取值： true：表示開啟回源 SNI。 false（預設）：表示不開啟回源 SNI。	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。預設值：5。	120
ReadTimeout	integer	否	讀逾時時間長度，單位：秒。取值範圍：1~3600。預設值：120。	200
WriteTimeout	integer	否	寫逾時時間長度，單位：秒。取值範圍：1~3600。預設值：120。	200
CnameEnabled	boolean	否	是否開啟公用雲容災。取值： true：表示開啟公用雲容災。 false（預設）：表示不開啟公用雲容災。	true
RoutingRules	string	否	混合雲轉寄規則。使用 JSON 數組轉化的字串格式表示。JSON 數組中的每個元素是一個結構體，包含以下欄位： rs：Array 類型 \| 表示回源 IP 位址或者回源 CNAME 列表 backupRs：Array 類型 \| 表示回源備用 IP 位址或者回源 CNAME 列表，必填，[]表示不設定 location：String 類型 \| 表示防護節點名稱 locationId：Long 類型 \| 表示防護節點 ID	[ { "rs": [ "1.1.XX.XX" ], "backupRs": [ "2.2.XX.XX" ], "locationId": 535, "location": "test1111" } ]
Keepalive	boolean	否	是否保持長串連。取值： true（預設）：表示保持長串連。 false：表示不保持長串連。	true
Retry	boolean	否	WAF 回源失敗時，是否重試。取值： true（預設）：表示重試。 false：表示不重試。	true
KeepaliveRequests	integer	否	複用長串連的請求個數。取值範圍：60~1000，預設值：1000，單位：個。說明開啟長串連後，複用多少個長串連。	1000
KeepaliveTimeout	integer	否	空閑長連線逾時時間，取值範圍：1~60，預設 15，單位：秒。說明複用的長串連空閑多久後釋放。	15
XffProto	boolean	否	X-Forward-For-Proto 傳遞 WAF 的協議。取值： true（預設）：表示傳遞 WAF 的協議。 false：表示不傳遞 WAF 的協議。	false
BackupBackends	array	否	網域名稱對應的備用來源站點伺服器 IP 或伺服器回源網域名稱。
	string	否	網域名稱對應的備用來源站點伺服器 IP 或伺服器回源網域名稱。您只能選擇設定來源站點伺服器 IP 或伺服器回源網域名稱中的一種，回源地址為網域名稱時，只支援 IPv4，暫不支援 IPv6：設定來源站點伺服器 IP 時，使用["ip1","ip2",……]格式表示。最多支援添加 20 個 IP。設定伺服器回源網域名稱時，使用["domain"]格式表示。最多支援添加 20 個網域名稱地址。	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	否	是否允許 WAF 覆蓋 X-Client-IP。取值： true（預設）：表示允許 WAF 覆蓋。 false：表示不允許 WAF 覆蓋。	true
XTrueIp	boolean	否	是否允許 WAF 覆蓋 X-True-IP。取值： true（預設）：表示允許 WAF 覆蓋。 false：表示不允許 WAF 覆蓋。	true
WebServerType	boolean	否	是否允許 WAF 覆蓋 Web-Server-Type。取值： true（預設）：表示允許 WAF 覆蓋。 false：表示不允許 WAF 覆蓋。	true
WLProxyClientIp	boolean	否	是否允許 WAF 覆蓋 WL-Proxy-Client-IP。取值： true（預設）：表示允許 WAF 覆蓋。 false：表示不允許 WAF 覆蓋。	true
MaxBodySize	integer	否	最大請求體大小。取值範圍：2~10，預設值：2，單位：G。說明僅旗艦版支援。	2
Http2Origin	boolean	否	HTTP2 回源。取值： true：表示開啟 HTTP2 回源。 false：表示不開啟 HTTP2 回源。	true
Http2OriginMaxConcurrency	integer	否	HTTP2 回源最大並發數。取值範圍：1-512，預設值：128，單位：個。	128
BackendPorts	array<object>	否	自訂連接埠配置。
	object	否	自訂連接埠配置。
ListenPort	integer	否	監聽連接埠。	80
BackendPort	integer	否	回源連接埠。	80
Protocol	string	否	監聽連接埠的協議。取值： http：表示監聽連接埠的協議為 HTTP。 https：表示監聽連接埠的協議 HTTPS。	http
RegionId	string	是	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
AccessType	string	否	WAF 執行個體的接入類型。取值： share（預設）：表示 CNAME 接入。 hybrid_cloud_cname：表示混合雲 CNAME 接入。	share
Tag	array<object>	否	標籤列表，最多包含 20 個子項
	object	否	資源的標籤，最多支援 20 個子項。
Key	string	否	標籤鍵。	Tagkey1
Value	string	否	標籤值	TagValue1

返回參數

名稱	類型	描述	樣本值
	object	添加網域名稱後的返回結果。
RequestId	string	請求 ID。	D7861F61-5B61-46CE-A47C-6B19160D5EB0
DomainInfo	object	已添加的網域名稱資訊。
Cname	string	WAF 為網域名稱分配的 CNAME 地址。	xxxxxwww.****.com
Domain	string	已添加的網域名稱名稱。	www.aliyundoc.com
DomainId	string	網域名稱 ID	www.aliyundoc.com-waf

樣本

正常返回樣本

JSON格式

{
  "RequestId": "D7861F61-5B61-46CE-A47C-6B19160D5EB0",
  "DomainInfo": {
    "Cname": "xxxxxwww.****.com",
    "Domain": "www.aliyundoc.com",
    "DomainId": "www.aliyundoc.com-waf"
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	Waf.Pullin.ResourceExsit	Access resource already exists, resource:%s.	接入資源已存在，已存在的資源：%s。
400	Waf.Pullin.BusinessViolation	The web services are suspected of violating regulations. If you have any questions, please submit a work order. Violating resource: %s.
400	Waf.Pullin.Http2OriginMustOnHttp2Enable	When HTTP2 origin is enabled, HTTP2 listening must be enabled.	開啟HTTP2回源時，HTTP2監聽必須開啟。
400	Waf.Pullin.Http2OriginMustOnKeepaliveEnable	When the HTTP2 origin is turned on, the keepalive must be turned on.	開啟HTTP2回源時，長串連必須開啟。
400	Waf.Pullin.Http2OriginEnabledFocusHttpBackendForbidden	When HTTP2 origin is enabled, HTTP origin cannot be enabled.	開啟HTTP2回源時，不能開啟HTTP回源。

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

變更歷史

更多資訊，參考變更詳情。