使用DescribeHybridCloudResourceDetail API查詢混合雲網域名稱詳情-Web Application Firewall-阿里雲 - Web Application Firewall

查詢混合雲端網域詳細資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

yundun-waf:DescribeHybridCloudResourceDetail

get

*全部資源。

*

acs:ResourceGroupId

無

請求參數

名稱	類型	必填	描述	樣本值
InstanceId	string	是	WAF 執行個體 ID。說明您可以透過呼叫 DescribeInstance 介面查看目前 WAF 執行個體 ID。	waf-cn-0xldbqt****
Domain	string	是	網域。	www.*****.com
Backend	string	否	回源位址。	1.1.XX.XX
PageNumber	integer	否	查詢頁碼，預設值為 1。	1
PageSize	integer	否	每頁顯示筆數。	10
CnameEnabled	boolean	否	是否啟用公共雲端容災。取值： true：表示啟用公共雲端容災。 false：表示不啟用公共雲端容災。	true
RegionId	string	否	WAF 執行個體所屬地域。取值： cn-hangzhou：表示中國內地。 ap-southeast-1：表示非中國內地。	cn-hangzhou
ResourceManagerResourceGroupId	string	否	阿里雲資源群組 ID。	rg-acfm***q

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	66A98669-CC6E-4F3E-80A6-3014697B11AE
Domain	object	網域資訊。
Status	integer	資源狀態。	1
ResourceManagerResourceGroupId	string	資源群組 ID。	rg-***aby
Uid	string	使用者 ID。	1046011128270720
Listen	object	監聽資訊。
HttpsPorts	array	HTTPS 通訊協定的連接埠。
	integer	HTTPS 通訊協定的連接埠。	443
ProtectionResource	string	要使用的防護資源類型。取值： share：表示使用共用叢集。 gslb：表示使用共用叢集智慧負載平衡。	share
CustomCiphers	array	自訂加密套件。
	string	自訂加密套件。	ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384
TLSVersion	string	TLS 的版本。取值： tlsv1 tlsv1.1 tlsv1.2	tlsv1
Http2Enabled	boolean	是否啟用 HTTP2。取值： true：表示啟用 HTTP2。 false：表示不啟用 HTTP2。	true
CertId	string	憑證的 ID。	19312542-cn-hangzhou
CipherSuite	integer	加密套件類型。取值： 1：表示新增全部加密套件。 2：表示新增強加密套件。 99：表示新增自訂加密套件。	0
EnableTLSv3	boolean	是否支援 TLS1.3 版本。取值： true：表示支援 TLS1.3 版本。 false：表示不支援 TLS1.3 版本。	true
IPv6Enabled	boolean	啟用 IPv6 是否啟用 IPv6。取值： true：表示啟用 IPv6。 false：表示不啟用 IPv6。	true
FocusHttps	boolean	是否啟用 HTTPS 強制重新導向。取值： true：表示啟用 HTTPS 強制重新導向。 false：表示不啟用 HTTPS 強制重新導向。	true
XffHeaders	array	設定用於取得用戶端 IP 的自訂欄位清單，使用 ["header1","header2",……] 格式表示。說明僅在 XffHeaderMode 取值為 2（表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP）時，需要設定此參數。
	string	設定用於取得用戶端 IP 的自訂欄位清單，使用 ["header1","header2",……] 格式表示。說明僅在 XffHeaderMode 取值為 2（表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP）時，需要設定此參數。	["test"]
XffHeaderMode	integer	WAF 取得用戶端真實 IP 的方式。取值： 0：表示用戶端存取流量到 WAF 前沒有經過其他七層代理轉送。 1：表示 WAF 讀取請求標頭中 X-Forwarded-For（XFF）欄位的第一個值作為用戶端 IP。 2：表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP。	1
ExclusiveIp	boolean	是否支援獨享 IP。取值： true：表示支援。 false：表示不支援。	true
HttpPorts	array	HTTP 通訊協定的可用連接埠清單。取值為字串，多個連接埠時，使用 port1,port2,port3 的格式傳回。
	integer	HTTP 通訊協定的可用連接埠清單。取值為字串，多個連接埠時，使用 port1,port2,port3 的格式傳回。	80
Id	integer	接入 ID。	31323
Redirect	object	返回回應標頭值的規則。
ConnectTimeout	integer	連線逾時時間：單位毫秒。	1
Keepalive	boolean	是否保持長連線。取值： true（預設）：表示保持長連線。 false：表示不保持長連線。	true
SniEnabled	boolean	是否啟用回源 SNI。取值： true：表示啟用回源 SNI。 false：表示不啟用回源 SNI。	true
CnameEnabled	boolean	是否啟用公有雲容災。取值： true：表示啟用公有雲容災。 false：表示不啟用公有雲容災。	true
KeepaliveTimeout	integer	長連線的空閒逾時時間。	1
ReadTimeout	integer	請求的 read 逾時時間。	1
Backends	array	來源伺服器 IP 或伺服器回源網域。
	string	來源伺服器 IP 或伺服器回源網域。	1.1.1.1
SniHost	string	SNI 擴充欄位的自訂值。取值為空表示未自訂 SNI 值，預設使用請求標頭中 Host 欄位的值作為 SNI 擴充欄位的值。說明僅在 SniStatus 取值為 1（表示啟用 SNI 回源）時，傳回此參數。	eew111
FocusHttpBackend	boolean	是否啟用強制 HTTP 回源。取值： true：表示啟用強制 HTTP 回源。 false：表示不啟用強制 HTTP 回源。	true
WriteTimeout	integer	寫入逾時時長，單位：毫秒。	1
RoutingRules	string	混合雲端轉送規則。使用 JSON 陣列轉換的字串格式表示。JSON 陣列中的每個元素是一個結構體，包含以下欄位： rs：Array 類型	[{\"backupRs\":[],\"location\":\"v3-test\",\"locationId\":1148,\"rs\":[\"39.98.217.197\",\"2.2.2.2\"]}]
Retry	boolean	WAF 回源失敗時，是否重試。取值： true：表示重試。 false：表示不重試。	true
RequestHeaders	array<object>	HTTP 請求標頭。
	object	指定的自訂請求標頭欄位。
Value	string	數值。	9506360478730
Key	string	標籤的 Key。	L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z
KeepaliveRequests	integer	複用長連線的請求個數。取值範圍：60~1000，單位：個。說明啟用長連線後，複用多少個長連線。	1000
Loadbalance	string	回源時採用的負載平衡演算法。取值： iphash：表示 IP Hash 演算法。 roundRobin：表示輪詢演算法。 leastTime：表示 Least Time 演算法。	iphash
ProxyProtocol	boolean	是否啟用了保持用戶端來源 IP 功能。 true：啟用了保持用戶端來源 IP 功能。啟用後，支援後端服務檢視用戶端的原始 IP 位址。 false：未啟用保持用戶端來源 IP 功能。	false
BackendPorts	array<object>	自訂連接埠設定，預設與監聽連接埠一致。
	object	自訂連接埠設定，預設與監聽連接埠一致。
ListenPort	integer	監聽連接埠。	80
BackendPort	integer	回源連接埠。	80
Protocol	string	監聽連接埠的通訊協定類型。取值： http：表示 HTTP 通訊協定。 https：表示 HTTPS 通訊協定。	http
Domain	string	網域。	www.*****.com
Cname	string	WAF 為網域分配的 CNAME 位址。說明僅在 CnameEnabled 取值為 true（表示啟用公共雲端容災）時，返回此參數。	kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com

樣本

正常返回樣本

JSON格式

{
  "RequestId": "66A98669-CC6E-4F3E-80A6-3014697B11AE",
  "Domain": {
    "Status": 1,
    "ResourceManagerResourceGroupId": "rg-***aby",
    "Uid": "1046011128270720",
    "Listen": {
      "HttpsPorts": [
        443
      ],
      "ProtectionResource": "share",
      "CustomCiphers": [
        "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384"
      ],
      "TLSVersion": "tlsv1",
      "Http2Enabled": true,
      "CertId": "19312542-cn-hangzhou",
      "CipherSuite": 0,
      "EnableTLSv3": true,
      "IPv6Enabled": true,
      "FocusHttps": true,
      "XffHeaders": [
        "[\"test\"]"
      ],
      "XffHeaderMode": 1,
      "ExclusiveIp": true,
      "HttpPorts": [
        80
      ]
    },
    "Id": 31323,
    "Redirect": {
      "ConnectTimeout": 1,
      "Keepalive": true,
      "SniEnabled": true,
      "CnameEnabled": true,
      "KeepaliveTimeout": 1,
      "ReadTimeout": 1,
      "Backends": [
        "1.1.1.1"
      ],
      "SniHost": "eew111",
      "FocusHttpBackend": true,
      "WriteTimeout": 1,
      "RoutingRules": "[{\\\"backupRs\\\":[],\\\"location\\\":\\\"v3-test\\\",\\\"locationId\\\":1148,\\\"rs\\\":[\\\"39.98.217.197\\\",\\\"2.2.2.2\\\"]}]",
      "Retry": true,
      "RequestHeaders": [
        {
          "Value": "9506360478730",
          "Key": "L2x1ZmZ5L2NvcmUvYXBwcy9tLnl1bmR1bi53YWYuMS9wbHVnaW5z"
        }
      ],
      "KeepaliveRequests": 1000,
      "Loadbalance": "iphash",
      "ProxyProtocol": false,
      "BackendPorts": [
        {
          "ListenPort": 80,
          "BackendPort": 80,
          "Protocol": "http"
        }
      ]
    },
    "Domain": "www.*****.com",
    "Cname": "kdmqyi3ck7xogegxpiyfpb0fj21mgkxn.****.com"
  }
}

錯誤碼

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

變更歷史

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