使用DescribeDomainDetail查詢CNAME接入的網域名稱配置詳情-Web Application Firewall-阿里雲 - Web Application Firewall

查詢網域接入詳情。

調試

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

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeDomainDetail

get

DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}

DefenseResource

acs:yundun-waf:{#regionId}:{#accountId}:defenseresource/{#Resource}-waf

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體的 ID。	waf_cdnsdf3****
DomainId	string	否	網域 ID。	www.aliyundoc.com-waf
Domain	string	否	要查詢的網域名稱。	www.aliyundoc.com
RegionId	string	否	WAF 執行個體所屬地域。取值：	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
CertId	string	憑證的 ID。	123
TLSVersion	string	TLS 的版本。取值： tlsv1（支援 TLS 1.0 及以上版本，相容性最高，安全性較低。） tlsv1.1（支援 TLS 1.1 及以上版本，相容性較好，安全性較好。） tlsv1.2（支援 TLS 1.2 及以上版本，相容性較好，安全性最高。） tlsv1.3（僅支援 TLS 1.3 版本，安全性最高，相容性較低。）	tlsv1.2
EnableTLSv3	boolean	是否支援 TLS 1.3 版本。取值： true：表示支援 TLS 1.3 版本。 false：表示不支援 TLS 1.3 版本。說明僅當 HttpsPorts 取值不為空（表示網域使用 HTTPS 通訊協定）時，才使用此參數。當 TLSVersion 為 tlsv1.3 時，此值必須為 true。	true
CipherSuite	integer	加密套件類型。取值： 1：表示新增全部加密套件。 2：表示新增強加密套件。僅當 TLSVersion 取值為 tlsv1.2 時，可選擇此取值。 99：表示新增自訂加密套件。僅當 TLSVersion 取值不為 tlsv1.3 時，可選擇此取值。	2
CustomCiphers	array	自訂加密套件。
	string	自訂加密套件。	ECDHE-ECDSA-AES256-SHA384
FocusHttps	boolean	是否啟用 HTTPS 強制重新導向。取值：	true
SM2Enabled	boolean	是否啟用國密憑證。取值：	true
SM2CertId	string	要新增的國密憑證 ID。僅當 SM2Enable 取值為 true 時，使用此參數。	123-cn-hangzhou
SM2AccessOnly	boolean	是否僅限用戶端存取。僅當 SM2Enable 取值為 true 時，才使用此參數。	true
XffHeaderMode	integer	WAF 取得用戶端真實 IP 的方式。取值： 0：表示用戶端存取流量到 WAF 前沒有經過其他七層代理轉發。 1：表示 WAF 讀取請求標頭中 X-Forwarded-For（XFF）欄位的第一個值作為用戶端 IP。 2：表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP。 3：表示 WAF 讀取 Proxy Protocol 標頭中的 Client IP 作為用戶端 IP。	2
XffHeaders	array	設定用於取得用戶端 IP 的自訂欄位清單。
	string	設定用於取得用戶端 IP 的自訂欄位清單。	Client-ip
IPv6Enabled	boolean	是否啟用 IPv6。取值：	true
ProtectionResource	string	要使用的防護資源類型。取值：	share
ExclusiveIp	boolean	是否啟用獨享 IP。取值：	true
HstsIncludeSubDomain	boolean	HSTS 是否包含子網域。取值：
HstsPreload	boolean	是否啟用 HSTS 預先載入，預設關閉。取值範圍：	false
HstsMaxAge	integer	HSTS 過期時間，單位為秒。	365000
Redirect	object	設定轉送資訊。
Backends `deprecated`	array<object>	網域名稱對應的回源位址。
	object	來源伺服器 IP 或伺服器回源網域名稱。
Backend	string	網域名稱對應的來源伺服器 IP 或伺服器回源網域名稱。	1.1.XX.XX
Loadbalance	string	回源時採用的負載平衡演算法。取值： iphash：表示 IP Hash 演算法。 roundRobin：表示輪詢演算法。 leastTime：表示 Least Time 演算法。	iphash
FocusHttpBackend	boolean	是否啟用強制 HTTP 回源。取值：	true
SniEnabled	boolean	是否啟用回源 SNI。取值：	true
SniHost	string	設定自訂 SNI 擴充欄位的值。	www.aliyundoc.com
RequestHeaders	array<object>	網域名稱的流量標記欄位和值，用於標記經過 WAF 處理的流量。
	object	網域名稱的流量標記欄位和值，用於標記經過 WAF 處理的流量。
Key	string	指定的自訂請求標頭欄位。	aaa
Value	string	指定的自訂請求標頭欄位設定的值。	bbb
ConnectTimeout	integer	連線逾時時長。單位：秒。	120
WriteTimeout	integer	寫入逾時時長，單位：秒。	200
ReadTimeout	integer	讀取逾時時長，單位：秒。	200
Keepalive	boolean	是否保持長連線。取值：	true
Retry	boolean	WAF 回源失敗時，是否重試。取值：	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>	網域對應的備用回源位址。
	object	來源伺服器 IP 或伺服器回源網域名稱。
Backend	string	網域名稱對應的備用來源伺服器 IP 或伺服器回源網域名稱。	[ "1.1.XX.XX", "2.2.XX.XX" ]
XClientIp	boolean	是否允許 WAF 覆蓋 X-Client-IP。取值：	true
XTrueIp	boolean	是否允許 WAF 覆蓋 X-True-IP。取值：	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
ProxyProtocol	boolean	是否啟用保留用戶端來源 IP 功能。 true：已啟用保留用戶端來源 IP 功能。啟用後，支援後端服務檢視用戶端的原始 IP 位址。 false：未啟用保留用戶端來源 IP 功能。	false
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
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,
    "HstsIncludeSubDomain": false,
    "HstsPreload": false,
    "HstsMaxAge": 365000
  },
  "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,
    "ProxyProtocol": false,
    "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.	網域和網域 ID 不能同時為空。
400	Waf.Pullin.DomainAndDomainIdNotMatch	domain and domainId do not match.	輸入參數 Domain 和 DomainId 不匹配。
400	Waf.Pullin.DomainIdIsIllegal	The input parameter, the domainId is illegal.	輸入參數 DomainId 不合法。

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

變更歷史

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