DescribeDomainDetail - 查詢CNAME接入詳情 -

查詢網域名稱接入詳情。

調試

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

授權資訊

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

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體的 ID。說明您可以調用 DescribeInstance 查詢當前 WAF 執行個體的 ID。	waf_cdnsdf3****
DomainId	string	否	網域名稱 ID。	www.aliyundoc.com-waf
Domain	string	否	要查詢的網域名稱名稱。	www.aliyundoc.com
RegionId	string	否	WAF 執行個體所屬地區。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	CNAME 詳情。
RequestId	string	請求 ID。	BAEF9CA9-66A0-533E-BD09-5D5D7AA8****
Domain	string	網域名稱	www.aliyundoc.com
DomainId	string	網域名稱 ID。	www.aliyundoc.com-waf
Status	integer	網域名稱狀態。取值： 1：表示網域名稱處於正常狀態。 2：表示網域名稱建立中。 3：表示網域名稱修改中。 4：表示網域名稱釋放中。 5：表示網域名稱停止轉寄。	1
Cname	string	WAF 為網域名稱分配的 CNAME 地址。	xxxxxcvdaf.****.com
Listen	object	配置監聽資訊。
HttpPorts	array	HTTP 協議的監聽連接埠。
	integer	HTTP 協議的監聽連接埠。	80
HttpsPorts	array	HTTPS 協議的監聽連接埠。
	integer	HTTPS 協議的監聽連接埠。	443
Http2Enabled	boolean	是否開啟 HTTP2。取值： true：表示開啟 HTTP2。 false：表示不開啟 HTTP2。	true
CertId	string	認證的 ID。	123
TLSVersion	string	TLS 的版本。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1.2
EnableTLSv3	boolean	是否支援 TLS1.3 版本。取值： true：表示支援 TLS1.3 版本。 false：表示不支援 TLS1.3 版本。	true
CipherSuite	integer	加密套件類型。取值： 1：表示添加全部加密套件。 2：表示添加強加密套件。 99：表示添加自訂加密套件。	2
CustomCiphers	array	自訂加密套件。
	string	自訂加密套件。	xxx
FocusHttps	boolean	是否開啟 HTTPS 的強制跳轉。取值： true：表示開啟 HTTPS 的強制跳轉。 false：表示不開啟 HTTPS 的強制跳轉。	true
SM2Enabled	boolean	是否開啟國密認證。取值： true：表示開啟國密認證。 false：表示不開啟國密認證。	true
SM2CertId	string	要添加的國密認證的 ID。僅 SM2Enable 取值為 true 時，使用該參數。	123-cn-hangzhou
SM2AccessOnly	boolean	是否僅客端訪問。僅 SM2Enable 取值為 true 時，使用該參數。 true：僅國密用戶端才可以訪問。 false：國密和非國密均可以訪問。	true
XffHeaderMode	integer	WAF 擷取用戶端真實 IP 的方式。取值： 0：表示用戶端訪問流量到 WAF 前沒有經過其他七層代理轉寄。 1：表示 WAF 讀取要求標頭中 X-Forwarded-For（XFF）欄位的第一個值作為用戶端 IP。 2：表示 WAF 讀取要求標頭中由您設定的自訂欄位值作為用戶端 IP。	2
XffHeaders	array	設定用於擷取用戶端 IP 的自訂欄位列表。
	string	設定用於擷取用戶端 IP 的自訂欄位列表。	Client-ip
IPv6Enabled	boolean	是否開啟 IPv6。取值： true：表示開啟 IPv6。 false：表示不開啟 IPv6。	true
ProtectionResource	string	要使用的防護資源類型。取值： share：表示使用共用叢集。 gslb：表示使用共用叢集智能負載平衡。	share
ExclusiveIp	boolean	是否開啟獨享 IP。取值： true：表示開啟獨享 IP。 false：表示不開啟獨享 IP。	true
Redirect	object	配置轉寄資訊。
Backends `deprecated`	array<object>	網域名稱對應的回源地址。說明該參數即將下線，推薦您使用 BackendList 擷取相關資訊。
	object	來源站點伺服器 IP 或伺服器回源網域名稱。
Backend	string	網域名稱對應的來源站點伺服器 IP 或伺服器回源網域名稱。	1.1.XX.XX
Loadbalance	string	回源時採用的負載平衡演算法。取值： iphash：表示 IP Hash 演算法。 roundRobin：表示輪詢演算法。 leastTime：表示 Least Time 演算法。	iphash
FocusHttpBackend	boolean	是否開啟強制 HTTP 回源。取值： true：表示開啟強制 HTTP 回源。 false：表示不開啟強制 HTTP 回源。	true
SniEnabled	boolean	是否開啟回源 SNI。取值： true：表示開啟回源 SNI。 false（預設）：表示不開啟回源 SNI。	true
SniHost	string	設定自訂 SNI 擴充欄位的值。	www.aliyundoc.com
RequestHeaders	array<object>	網域名稱的流量標記欄位和值，用於標記經過 WAF 處理的流量。
	object	網域名稱的流量標記欄位和值，用於標記經過 WAF 處理的流量。
Key	string	指定的自訂要求標頭部欄位。	aaa
Value	string	指定的自訂要求標頭部欄位設定的值。	bbb
ConnectTimeout	integer	連線逾時時間長度。單位：秒。取值範圍：5~120。	120
WriteTimeout	integer	寫逾時時間長度，單位：秒。取值範圍：5~1800。	200
ReadTimeout	integer	讀逾時時間長度，單位：秒。取值範圍：5~1800。	200
Keepalive	boolean	是否保持長串連。取值： true（預設）：表示保持長串連。 false：表示不保持長串連。	true
Retry	boolean	WAF 回源失敗時，是否重試。取值： true（預設）：表示重試。 false：表示不重試。	true
KeepaliveRequests	integer	複用長串連的請求個數。取值範圍：60~1000，單位：個。說明開啟長串連後，複用多少個長串連。	1000
KeepaliveTimeout	integer	空閑長連線逾時時間，取值範圍：1~60，預設 15，單位：秒。說明複用的長串連空閑多長時間後釋放。	15
XffProto	boolean	X-Forward-For-Proto 傳遞 WAF 的協議。取值： true（預設）：表示傳遞 WAF 的協議。 false：表示不傳遞 WAF 的協議。	true
BackupBackends `deprecated`	array<object>	網域名稱對應的備用回源地址。說明該參數即將下線，推薦您使用 BackUpBackendList 擷取相關資訊。
	object	來源站點伺服器 IP 或伺服器回源網域名稱。
Backend	string	網域名稱對應的備用來源站點伺服器 IP 或伺服器回源網域名稱。	[ "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
Http2OriginMaxConcurrency	integer	HTTP2 回源並發串連數	128
BackendList	array	網域名稱對應的來源站點伺服器 IP 或伺服器回源網域名稱列表。
	string	網域名稱對應的來源站點伺服器 IP 或伺服器回源網域名稱。	1.1.XX.XX
BackUpBackendList	array	網域名稱對應的備用來源站點伺服器 IP 或伺服器回源網域名稱列表。
	string	網域名稱對應的備用來源站點伺服器 IP 或伺服器回源網域名稱。	2.2.XX.XX
BackendPorts	array<object>	自訂連接埠配置，預設與監聽連接埠一致。
	object	自訂連接埠配置，預設與監聽連接埠一致。
ListenPort	integer	監聽連接埠	80
BackendPort	integer	回源連接埠。	80
Protocol	string	監聽連接埠的協議類型。取值： http：表示 HTTP 協議。 https：表示 HTTPS 協議。	http
ResourceManagerResourceGroupId	string	阿里雲資源群組 ID。	rg-acfm***q
CertDetail	object	SSL 憑證詳情。
Name	string	認證名稱	test-cert-name
Id	string	SSL 憑證 ID	123-cn-hangzhou
StartTime	integer	認證生效時間，格式為 Unix 時間戳記（UTC 時間），單位為毫秒。	1677772800000
EndTime	integer	認證到期時間，格式為 Unix 時間戳記（UTC 時間），單位為毫秒。	1685590400000
CommonName	string	通用名稱（CN）	test.aliyundoc.com
Sans	array	認證綁定的所有網域名稱。
	string	認證綁定的所有網域名稱。	www.aliyundoc.com
SM2CertDetail	object	國密認證資訊
Name	string	認證名稱	test-sm2-cert-name
Id	string	SSL 憑證 ID	123-cn-hangzhou
StartTime	integer	認證生效時間，格式為 Unix 時間戳記（UTC 時間），單位為毫秒。	1657551525000
EndTime	integer	認證到期時間，格式為 Unix 時間戳記（UTC 時間），單位為毫秒。	1665590400000
CommonName	string	通用名稱（CN）	test.aliyundoc.com
Sans	array	認證綁定的所有網域名稱。
	string	認證綁定的所有網域名稱。	www.aliyundoc.com

樣本

正常返回樣本

JSON格式

{
  "RequestId": "BAEF9CA9-66A0-533E-BD09-5D5D7AA8****",
  "Domain": "www.aliyundoc.com",
  "DomainId": "www.aliyundoc.com-waf",
  "Status": 1,
  "Cname": "xxxxxcvdaf.****.com",
  "Listen": {
    "HttpPorts": [
      80
    ],
    "HttpsPorts": [
      443
    ],
    "Http2Enabled": true,
    "CertId": "123",
    "TLSVersion": "tlsv1.2",
    "EnableTLSv3": true,
    "CipherSuite": 2,
    "CustomCiphers": [
      "xxx"
    ],
    "FocusHttps": true,
    "SM2Enabled": true,
    "SM2CertId": "123-cn-hangzhou",
    "SM2AccessOnly": true,
    "XffHeaderMode": 2,
    "XffHeaders": [
      "Client-ip"
    ],
    "IPv6Enabled": true,
    "ProtectionResource": "share",
    "ExclusiveIp": true
  },
  "Redirect": {
    "Backends": [
      {
        "Backend": "1.1.XX.XX"
      }
    ],
    "Loadbalance": "iphash",
    "FocusHttpBackend": true,
    "SniEnabled": true,
    "SniHost": "www.aliyundoc.com",
    "RequestHeaders": [
      {
        "Key": "aaa",
        "Value": "bbb"
      }
    ],
    "ConnectTimeout": 120,
    "WriteTimeout": 200,
    "ReadTimeout": 200,
    "Keepalive": true,
    "Retry": true,
    "KeepaliveRequests": 1000,
    "KeepaliveTimeout": 15,
    "XffProto": true,
    "BackupBackends": [
      {
        "Backend": "[\n    \"1.1.XX.XX\",\n    \"2.2.XX.XX\"\n]\n"
      }
    ],
    "XClientIp": true,
    "XTrueIp": true,
    "WebServerType": true,
    "WLProxyClientIp": true,
    "MaxBodySize": 2,
    "Http2Origin": true,
    "Http2OriginMaxConcurrency": 128,
    "BackendList": [
      "1.1.XX.XX"
    ],
    "BackUpBackendList": [
      "2.2.XX.XX"
    ],
    "BackendPorts": [
      {
        "ListenPort": 80,
        "BackendPort": 80,
        "Protocol": "http"
      }
    ]
  },
  "ResourceManagerResourceGroupId": "rg-acfm***q",
  "CertDetail": {
    "Name": "test-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1677772800000,
    "EndTime": 1685590400000,
    "CommonName": "test.aliyundoc.com",
    "Sans": [
      "www.aliyundoc.com"
    ]
  },
  "SM2CertDetail": {
    "Name": "test-sm2-cert-name",
    "Id": "123-cn-hangzhou",
    "StartTime": 1657551525000,
    "EndTime": 1665590400000,
    "CommonName": "test.aliyundoc.com\n",
    "Sans": [
      "www.aliyundoc.com\n"
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
400	Waf.Pullin.DomainAndDomainIdBothEmpty	domain and domainId cannot be empty at the same time.
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.

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

變更歷史

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