DescribeListener - 查詢監聽 - Global Accelerator

調用DescribeListener介面查詢指定監聽的配置資訊。

介面說明

本介面用於查詢指定監聽的配置資訊，包括監聽的路由類型、狀態、建立的時間戳記、連接埠資訊等。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

ga:DescribeListener

get

*Listener

acs:ga:{#regionId}:{#accountId}:listener/{#listenerId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	Global Acceleration執行個體所在的地區 ID，僅取值cn-hangzhou。	cn-hangzhou
ListenerId	string	是	要查詢的監聽的 ID。	lsr-bp1bpn0kn908w4nbw****

返回參數

名稱	類型	描述	樣本值
	object	返回資訊列表。
Description	string	監聽的描述資訊。	Listener
RequestId	string	請求 ID。	6FEA0CF3-D3B9-43E5-A304-D217037876A8
State	string	監聽的狀態。 configuring：配置中。 init：初始化。 updating：更新中。 deleting：刪除中。	active
CreateTime	string	建立監聽的時間戳記。單位：毫秒。	1577786252000
PortRanges	array<object>	監聽連接埠資訊。
	object	監聽連接埠資訊。
FromPort	integer	用來接收請求並向終端節點進行轉寄的起始監聽連接埠。	20
ToPort	integer	用來接收請求並向終端節點進行轉寄的結束監聽連接埠。	20
BackendPorts	array<object>	後端連接埠資訊。
	object	後端連接埠範圍。
FromPort	string	後端伺服器接收請求的開始端點口。當您的監聽協議為 HTTPS，且監聽的連接埠和後端伺服器提供服務的連接埠一致時才會返回該項。	80
ToPort	string	後端伺服器接收請求的結束連接埠。	80
Certificates	array<object>	SSL 憑證列表。
	object	SSL 憑證列表。
Type	string	認證類型。目前，僅支援返回 Server（服務端認證）。	Server
Id	string	SSL 憑證 ID。	449****-cn-hangzhou
Protocol	string	監聽的網路傳輸協議類型。 TCP：TCP 協議。 UDP：UDP 協議。 HTTP：HTTP 協議。 HTTPS：HTTPS 協議。	TCP
ListenerId	string	監聽 ID。	lsr-bp1bpn0kn908w4nbw****
ClientAffinity	string	用戶端親和性。返回為 NONE 時：不保持用戶端親和性，即不能確保來自同一用戶端的串連請求始終定向到同一終端節點。返回為SOURCE_IP時，保持用戶端親和性。即用戶端訪問有狀態的應用程式時，可以將來自同一用戶端的所有請求都定向到同一終端節點，而不考慮源連接埠和協議。	SOURCE_IP
Name	string	監聽的名稱。	Listener
RelatedAcls	array<object>	監聽綁定的存取控制策略組資訊。
	object	監聽綁定的存取控制策略組資訊。
AclId	string	監聽綁定的存取原則組 ID。	123
Status	string	是否開啟了存取控制功能。 Associated：已開啟。	Associated
AclType	string	存取控制類型： white：僅轉寄來自所選存取控制策略組中設定的 IP 位址或位址區段的請求，白名單適用於應用只允許特定 IP 訪問的情境。設定白名單存在一定業務風險。一旦設定白名單，就只有白名單中的 IP 可以訪問Global Acceleration監聽。如果開啟了白名單訪問，但存取原則組中沒有添加任何 IP，則Global Acceleration監聽不會轉寄請求。 black：來自所選存取控制策略組中設定的 IP 位址或位址區段的所有請求都不會轉寄，黑名單適用於應用只限制某些特定 IP 訪問的情境。如果開啟了黑名單訪問，但存取原則組中沒有添加任何 IP，則Global Acceleration監聽會轉寄全部請求。當 Status 參數的值為 on 時，返回該項。	white
AcceleratorId	string	Global Acceleration執行個體 ID。	ga-bp1odcab8tmno0hdq****
ProxyProtocol `deprecated`	boolean	是否開啟了保持用戶端源 IP 功能。 true：開啟了保持用戶端源 IP 功能。開啟後，支援後端服務查看用戶端的原始 IP 位址。 false：未開啟保持用戶端源 IP 功能。	false
XForwardedForConfig	object	`XForward`欄位配置資訊。
XForwardedForGaIdEnabled	boolean	是否通過`GA-ID`頭欄位擷取Global Acceleration執行個體 ID。 true：是。 false：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XForwardedForGaApEnabled	boolean	是否通過`GA-AP`欄位擷取加速地區資訊。 true：是。 false：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XForwardedForProtoEnabled	boolean	是否通過`GA-X-Forward-Proto`欄位擷取Global Acceleration執行個體的監聽協議。 true：是。 false：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XForwardedForPortEnabled	boolean	是否通過`GA-X-Forward-Port`欄位擷取Global Acceleration執行個體的監聽連接埠。 true：是。 false：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
XRealIpEnabled	boolean	是否通過`X-Real-IP`欄位擷取真實的用戶端 IP。 true：是。 false：否。說明僅 HTTP 和 HTTPS 監聽支援此參數。	false
SecurityPolicyId	string	安全性原則執行個體 ID。 tls_cipher_policy_1_0 支援的 TLS 版本：TLSv1.0、TLSv1.1 和 TLSv1.2。支援的密碼編譯演算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。 tls_cipher_policy_1_1 支援的 TLS 版本： TLSv1.1 和 TLSv1.2。支援的密碼編譯演算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。 tls_cipher_policy_1_2 支援的 TLS 版本：TLSv1.2。支援的密碼編譯演算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、AES128-GCM-SHA256、AES256-GCM-SHA384、AES128-SHA256、AES256-SHA256、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA、AES128-SHA、AES256-SHA 和 DES-CBC3-SHA。 tls_cipher_policy_1_2_strict 支援的 TLS 版本：TLSv1.2。支援的密碼編譯演算法套件：ECDHE-RSA-AES128-GCM-SHA256、ECDHE-RSA-AES256-GCM-SHA384、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-RSA-AES128-SHA 和 ECDHE-RSA-AES256-SHA。 tls_cipher_policy_1_2_strict_with_1_3 支援的 TLS 版本：TLSv1.2 及 TLSv1.3。支援的密碼編譯演算法套件：TLS_AES_128_GCM_SHA256、TLS_AES_256_GCM_SHA384、TLS_CHACHA20_POLY1305_SHA256、TLS_AES_128_CCM_SHA256、TLS_AES_128_CCM_8_SHA256、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、ECDHE-RSA-AES128-SHA256、ECDHE-RSA-AES256-SHA384、ECDHE-ECDSA-AES128-SHA、ECDHE-ECDSA-AES256-SHA、ECDHE-RSA-AES128-SHA、ECDHE-RSA-AES256-SHA。說明僅 HTTPS 監聽支援此參數。	tls_cipher_policy_1_0
Type	string	監聽的路由類型。 Standard：智能路由類型。 CustomRouting：自訂路由類型。	Standard
ServiceId	string	受管理的執行個體所屬的服務方 ID。說明僅在 ServiceManaged 參數為 True 時有效。	ALB
ServiceManaged	boolean	是否為受管理的執行個體。取值： true：是受管理的執行個體。 false：不是受管理的執行個體。	true
ServiceManagedInfos	array<object>	使用者在此受管理的執行個體下可執行檔動作策略列表。說明僅在 ServiceManaged 參數為 True 時有效。當執行個體處於託管狀態時，使用者對執行個體的操作會受到限制，某些操作行為會被禁止。
	object	使用者在此受管理的執行個體下可執行檔動作策略列表。
Action	string	託管策略動作名稱，取值： Create：建立執行個體。 Update：更新當前執行個體。 Delete：刪除當前執行個體。 Associate：引用/被引用當前執行個體。 UserUnmanaged：使用者解受管理的執行個體。 CreateChild：在當前執行個體下建立子資源。	Update
ChildType	string	子資源類型，取值： Listener：監聽資源。 IpSet：加速地區資源。 EndpointGroup：終端節點群組資源。 ForwardingRule：轉寄策略資源。 Endpoint：終端節點資源。 EndpointGroupDestination：自訂路由監聽下的終端節點群組協議映射資源。 EndpointPolicy：自訂路由監聽下的終端節點通行策略資源。說明僅在 Action 參數為 CreateChild 時有效。	Listener
IsManaged	boolean	託管策略動作是否被託管，取值： true：託管策略動作被託管，使用者無權在受管理的執行個體下執行 Action 指定的操作。 false：託管策略動作未被託管，使用者可在受管理的執行個體下執行 Action 指定的操作。	false
IdleTimeout	integer	串連空閑逾時時間。單位：秒。	900
RequestTimeout	integer	HTTP/HTTPS 的串連請求逾時時間。單位：秒。說明僅對 Protocol（網路傳輸協議類型）為 HTTP 或 HTTPS 的監聽有效。如果在逾時時間內後端伺服器一直沒有響應，Global Acceleration將放棄等待，並給用戶端返回 HTTP 504 錯誤碼。	60
HttpVersion	string	HTTP 協議的最大版本，取值： http3：HTTP/3。 http2：HTTP/2。 http1.1：HTTP/1.1。說明僅 HTTPS 監聽支援此參數。	http2

樣本

正常返回樣本

JSON格式

{
  "Description": "Listener",
  "RequestId": "6FEA0CF3-D3B9-43E5-A304-D217037876A8\t",
  "State": "active",
  "CreateTime": "1577786252000",
  "PortRanges": [
    {
      "FromPort": 20,
      "ToPort": 20
    }
  ],
  "BackendPorts": [
    {
      "FromPort": "80",
      "ToPort": "80"
    }
  ],
  "Certificates": [
    {
      "Type": "Server",
      "Id": "449****-cn-hangzhou"
    }
  ],
  "Protocol": "TCP",
  "ListenerId": "lsr-bp1bpn0kn908w4nbw****",
  "ClientAffinity": "SOURCE_IP",
  "Name": "Listener",
  "RelatedAcls": [
    {
      "AclId": "123",
      "Status": "Associated"
    }
  ],
  "AclType": "white",
  "AcceleratorId": "ga-bp1odcab8tmno0hdq****",
  "ProxyProtocol": false,
  "XForwardedForConfig": {
    "XForwardedForGaIdEnabled": false,
    "XForwardedForGaApEnabled": false,
    "XForwardedForProtoEnabled": false,
    "XForwardedForPortEnabled": false,
    "XRealIpEnabled": false
  },
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "Type": "Standard",
  "ServiceId": "ALB",
  "ServiceManaged": true,
  "ServiceManagedInfos": [
    {
      "Action": "Update",
      "ChildType": "Listener",
      "IsManaged": false
    }
  ],
  "IdleTimeout": 900,
  "RequestTimeout": 60,
  "HttpVersion": "http2"
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	NotExist.Listener	listener %s is not exist	監聽%s不存在。
500	UnknownError	An error occurred while processing your request. Please try again. If the error persists, please submit a ticket.	處理請求時出現錯誤，請稍後重試。

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

變更歷史

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