查詢混合雲端網域清單。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
yundun-waf:DescribeHybridCloudResources |
get |
*全部資源。
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceId |
string |
是 |
WAF 執行個體的 ID。 說明
您可以呼叫 DescribeInstance ,檢視目前 WAF 執行個體的 ID。 |
waf_v3prepaid_public_cn-*********** |
| Domain |
string |
否 |
要查詢的網域名稱。 |
www.aliyundoc.com |
| Backend |
string |
否 |
網域對應的來源伺服器 IP 或伺服器回源網域。 |
1.1.XX.XX |
| PageNumber |
integer |
否 |
分頁查詢時,返回第幾頁資料。預設值為 1,表示返回第 1 頁資料。 |
1 |
| PageSize |
integer |
否 |
分頁查詢時,每頁包含多少筆結果。預設值為 10,表示每頁包含 10 筆結果。 |
10 |
| CnameEnabled |
boolean |
否 |
是否啟用公共雲端容災。取值:
|
true |
| RegionId |
string |
否 |
WAF 執行個體所屬地域。取值:
|
cn-hangzhou |
| ResourceManagerResourceGroupId |
string |
否 |
阿里雲資源群組 ID。 |
rg-acfmvtc5z52**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Domains |
array<object> |
本次獲取的網域清單。 |
|
|
array<object> |
網域接入詳細資訊。 |
||
| Status |
integer |
網域狀態。取值:
|
1 |
| ResourceManagerResourceGroupId |
string |
阿里雲資源群組 ID。 |
rg-acfmvtc5z52**** |
| Uid |
string |
使用者 ID。 |
130715431409**** |
| Listen |
object |
設定監聽資訊。 |
|
| HttpsPorts |
array |
HTTPS 連接埠列表。 |
|
|
integer |
HTTPS 協定的連接埠。 |
443 |
|
| ProtectionResource |
string |
要使用的防護資源類型。取值:
|
share |
| CustomCiphers |
array |
要新增的具體自訂加密套件。 說明
僅當 CipherSuite 取值為 99 時,返回此參數。 |
|
|
string |
自訂加密套件。 |
ECDHE-ECDSA-AES128-GCM-SHA256 |
|
| TLSVersion |
string |
TLS 的版本。取值:
|
tlsv1.2 |
| Http2Enabled |
boolean |
是否啟用 HTTP2。取值:
|
false |
| CertId |
string |
憑證 ID。 |
72***76-cn-hangzhou |
| CipherSuite |
integer |
加密套件類型。取值:
|
1 |
| EnableTLSv3 |
boolean |
是否支援 TLS1.3 版本。取值:
|
true |
| IPv6Enabled |
boolean |
啟用 IPv6 是否啟用 IPv6。取值:
|
false |
| FocusHttps |
boolean |
是否啟用 HTTPS 的強制重新導向。取值:
|
false |
| XffHeaders |
array |
用於獲取用戶端 IP 的自訂欄位列表,使用 ["header1","header2",……] 格式表示。 說明
僅在 XffHeaderMode 取值為 2(表示 WAF 讀取請求標頭中由您設定的自訂欄位值作為用戶端 IP)時,返回此參數。 |
|
|
string |
用於獲取用戶端 IP 的自訂欄位列表。 |
Client-ip |
|
| XffHeaderMode |
integer |
WAF 獲取用戶端真實 IP 的方式。取值:
|
0 |
| ExclusiveIp |
boolean |
是否支援獨享 IP。取值:
|
true |
| HttpPorts |
array |
HTTP 協定的監聽連接埠列表。 |
|
|
integer |
HTTP 協定的監聽連接埠。 |
80 |
|
| Id |
integer |
接入 ID。 |
12345 |
| Redirect |
object |
設定轉發資訊。 |
|
| ConnectTimeout |
integer |
連線逾時時長。單位:秒。 取值範圍:5~120。 |
120 |
| Keepalive |
boolean |
是否保持長連線。取值:
|
true |
| SniEnabled |
boolean |
是否啟用回源 SNI。取值:
|
true |
| CnameEnabled |
boolean |
是否啟用公共雲端容災。取值:
|
true |
| KeepaliveTimeout |
integer |
閒置長連線逾時時間,取值範圍:1~60,預設 15,單位:秒。 說明
複用的長連線閒置多久後釋放。 |
15 |
| ReadTimeout |
integer |
讀取逾時時長,單位:秒。 取值範圍:5~1800。 |
200 |
| Backends |
array |
網域對應的來源伺服器 IP 或伺服器回源網域。 |
|
|
string |
網域對應的來源伺服器 IP 或伺服器回源網域。 |
1.1.XX.XX |
|
| SniHost |
string |
SNI 擴充欄位的自訂值。取值為空表示未自訂 SNI 值,預設使用請求標頭中 Host 欄位的值作為 SNI 擴充欄位的值。 說明
僅在 SniEnabled 取值為 true(表示啟用 SNI 回源)時,返回此參數。 |
www.aliyundoc.com |
| FocusHttpBackend |
boolean |
是否啟用強制 HTTP 回源。取值:
|
true |
| WriteTimeout |
integer |
寫入逾時時長,單位:秒。 取值範圍:5~1800。 |
200 |
| RoutingRules |
string |
混合雲端轉發規則。使用 JSON 陣列轉換的字串格式表示。JSON 陣列中的每個元素是一個結構體,包含以下欄位:
|
[ { "rs": [ "1.1.XX.XX" ], "locationId": 535, "location": "test1111" } ] |
| Retry |
boolean |
WAF 回源失敗時,是否重試。取值:
|
true |
| RequestHeaders |
array<object> |
網域的流量標記欄位和值,用於標記經過 WAF 處理的流量。 |
|
|
object |
網域的流量標記欄位和值,用於標記經過 WAF 處理的流量。 |
||
| Value |
string |
指定的自訂請求標頭欄位設定的值。 |
bbb |
| Key |
string |
指定的自訂請求標頭欄位。 |
aaa |
| KeepaliveRequests |
integer |
複用長連線的請求個數。取值範圍:60~1000,單位:個。 說明
啟用長連線後,複用多少個長連線。 |
1000 |
| Loadbalance |
string |
回源時採用的負載平衡演算法。取值:
|
iphash |
| Domain |
string |
網域。 |
www.aliyundoc.com |
| Cname |
string |
WAF 為網域分配的 CNAME 位址。 說明
僅在 CnameEnabled 取值為 true(表示啟用公共雲端容災)時,返回此參數。 |
50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com |
| TotalCount |
integer |
返回結果的總數。 |
24 |
| RequestId |
string |
本次請求的 ID。 |
98D2AA9A-5959-5CCD-83E3-B6606232A2BE |
樣本
正常返回樣本
JSON格式
{
"Domains": [
{
"Status": 1,
"ResourceManagerResourceGroupId": "rg-acfmvtc5z52****",
"Uid": "130715431409****",
"Listen": {
"HttpsPorts": [
443
],
"ProtectionResource": "share",
"CustomCiphers": [
"ECDHE-ECDSA-AES128-GCM-SHA256"
],
"TLSVersion": "tlsv1.2",
"Http2Enabled": false,
"CertId": "72***76-cn-hangzhou",
"CipherSuite": 1,
"EnableTLSv3": true,
"IPv6Enabled": false,
"FocusHttps": false,
"XffHeaders": [
"Client-ip"
],
"XffHeaderMode": 0,
"ExclusiveIp": true,
"HttpPorts": [
80
]
},
"Id": 12345,
"Redirect": {
"ConnectTimeout": 120,
"Keepalive": true,
"SniEnabled": true,
"CnameEnabled": true,
"KeepaliveTimeout": 15,
"ReadTimeout": 200,
"Backends": [
"1.1.XX.XX"
],
"SniHost": "www.aliyundoc.com",
"FocusHttpBackend": true,
"WriteTimeout": 200,
"RoutingRules": "[\n {\n \"rs\": [\n \"1.1.XX.XX\"\n ],\n \"locationId\": 535,\n \"location\": \"test1111\"\n }\n]",
"Retry": true,
"RequestHeaders": [
{
"Value": "bbb",
"Key": "aaa"
}
],
"KeepaliveRequests": 1000,
"Loadbalance": "iphash"
},
"Domain": "www.aliyundoc.com",
"Cname": "50fqmu1ci7g0xtiyxnrhgx6qdhmn****.yundunwaf5.com"
}
],
"TotalCount": 24,
"RequestId": "98D2AA9A-5959-5CCD-83E3-B6606232A2BE"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。