GetListenerAttribute - 查詢監聽的屬性 - Server Load Balancer

查詢網路型Server Load Balancer執行個體的監聽詳情。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

nlb:GetListenerAttribute

get

*LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

無

請求參數

名稱	類型	必填	描述	樣本值
ListenerId	string	是	監聽 ID。	lsn-bp1bpn0kn908w4nbw****@233
DryRun	boolean	否	是否只預檢此次請求。取值： true：發送檢查請求，不會查詢監聽詳情。檢查項包括是否填寫了必需參數、請求格式、業務限制。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼`DryRunOperation`。 false（預設值）：發送正常請求，通過檢查後返回 HTTP 2xx 狀態代碼並直接進行操作。	false
ClientToken	string	否	用戶端 Token，用於保證請求的等冪性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 不一樣。	123e4567-e89b-12d3-a456-426655440000
RegionId	string	否	網路型Server Load Balancer執行個體所在的地區 ID。您可以通過調用 DescribeRegions 介面擷取地區 ID。	cn-hangzhou

返回參數

名稱	類型	描述	樣本值
	object	查詢監聽屬性。
RequestId	string	請求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionId	string	網路型Server Load Balancer執行個體所在的地區 ID。	cn-hangzhou
LoadBalancerId	string	網路型Server Load Balancer執行個體 ID。	nlb-83ckzc8d4xlp8o****
ListenerId	string	監聽 ID。	lsn-bp1bpn0kn908w4nbw****@233
ListenerProtocol	string	監聽協議。取值：TCP、UDP 或 TCPSSL。	TCPSSL
ListenerPort	integer	監聽連接埠。取值範圍：0~65535。0：表示使用全連接埠監聽。當設定為 0 時，您需要配置 StartPort 和 EndPort。	233
StartPort	string	全連接埠監聽開始端點口。取值範圍：0 ~ 65535。	233
EndPort	string	全連接埠監聽結束連接埠。取值範圍：0~ 65535。結束連接埠的取值小於開始端點口。	455
ListenerDescription	string	自訂監聽名稱。長度限制為 2~256 個字元，支援中文和英文字母，可包含數字、半形逗號（,）、半形句號（.）、半形分號（;）、正斜線（/）、at（@）、底線（_）和短劃線（-）。	tcpssl_443
ServerGroupId	string	伺服器組 ID。	sgp-ppdpc14gdm3x4o****
IdleTimeout	integer	串連空閑逾時時間。單位：秒。	900
SecurityPolicyId	string	安全性原則 ID。支援系統安全性原則和自訂安全性原則。系統策略取值：tls_cipher_policy_1_0（預設值）、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict或tls_cipher_policy_1_2_strict_with_1_3。自訂安全性原則：輸入自訂安全性原則 ID。建立自訂策略，請參見 CreateSecurityPolicy 。查詢安全性原則，請參見 ListSecurityPolicy 。說明僅對 TCPSSL 監聽生效。	tls_cipher_policy_1_0
CertificateIds	array	伺服器憑證列表資訊。目前僅支援添加 1 個伺服器憑證。說明該參數僅對 TCPSSL 監聽生效。
	string	伺服器憑證列表資訊。目前僅支援添加 1 個伺服器憑證。說明該參數僅對 TCPSSL 監聽生效。	123157******
CaCertificateIds	array	CA 憑證列表資訊。目前僅支援添加 1 個 CA 憑證。說明該參數僅對 TCPSSL 監聽生效。
	string	CA 憑證列表資訊。目前僅支援添加 1 個 CA 憑證。說明該參數僅對 TCPSSL 監聽生效。	139a00******
CaEnabled	boolean	是否啟動雙向認證。取值： true：啟動。 false：關閉。	false
AlpnEnabled	boolean	是否開啟 ALPN。取值： true：開啟。 false：關閉。	false
AlpnPolicy	string	ALPN 策略。取值： HTTP1Only HTTP2Only HTTP2Preferred HTTP2Optional	HTTP1Only
ProxyProtocolEnabled	boolean	是否開啟通過 Proxy Protocol 協議攜帶用戶端源地址到後端伺服器。取值： true：開啟。 false：關閉。	false
ProxyProtocolV2Config	object	通過 Proxy Protocol 協議攜帶 VpcId、PrivateLinkEpId、PrivateLinkEpsId 資訊到後端伺服器配置。
Ppv2VpcIdEnabled	boolean	是否開啟通過 Proxy Protocol 協議攜帶 VpcId 到後端伺服器。取值： true：開啟。 false：關閉。	false
Ppv2PrivateLinkEpIdEnabled	boolean	是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpId 到後端伺服器。取值： true：開啟。 false：關閉。	false
Ppv2PrivateLinkEpsIdEnabled	boolean	是否開啟通過 Proxy Protocol 協議攜帶 PrivateLinkEpsId 到後端伺服器。取值： true：開啟。 false：關閉。	false
SecSensorEnabled	boolean	是否開啟秒級監控功能。取值： true：開啟。 false：關閉。	false
ListenerStatus	string	當前監聽的狀態，取值： Provisioning：建立中。 Running：運行中。 Configuring：配置中。 Stopping：停止中。 Stopped：已停止。 Starting：啟動中。 Deleting：刪除中。 Deleted：已刪除。	Running
Cps	integer	該監聽在每個可用性區域（VIP）處理的每秒建立串連限速值。取值範圍：0~1000000。0 表示不限速。	1000
Mss	integer	TCP 報文的最大段大小。單位：位元組，取值範圍：0~1500。0 表示不修改使用者 TCP 報文的 MSS 值。說明僅 TCP、TCPSSL 類型的監聽支援該欄位值。	166
Tags	array<object>	標籤列表。
	object	標籤。
TagKey	string	標籤鍵。	ac-cus-tag-4
TagValue	string	標籤值。	ON

樣本

正常返回樣本

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId": "cn-hangzhou",
  "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****@233",
  "ListenerProtocol": "TCPSSL",
  "ListenerPort": 233,
  "StartPort": "233",
  "EndPort": "455",
  "ListenerDescription": "tcpssl_443",
  "ServerGroupId": "sgp-ppdpc14gdm3x4o****",
  "IdleTimeout": 900,
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "CertificateIds": [
    "123157******"
  ],
  "CaCertificateIds": [
    "139a00******"
  ],
  "CaEnabled": false,
  "AlpnEnabled": false,
  "AlpnPolicy": "HTTP1Only",
  "ProxyProtocolEnabled": false,
  "ProxyProtocolV2Config": {
    "Ppv2VpcIdEnabled": false,
    "Ppv2PrivateLinkEpIdEnabled": false,
    "Ppv2PrivateLinkEpsIdEnabled": false
  },
  "SecSensorEnabled": false,
  "ListenerStatus": "Running",
  "Cps": 1000,
  "Mss": 166,
  "Tags": [
    {
      "TagKey": "ac-cus-tag-4",
      "TagValue": "ON"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	SystemBusy	System is busy, please try again later.	系統繁忙，請稍後重試
404	ResourceNotFound.loadBalancer	The specified resource of loadbalancer is not found.	找不到指定的負載平衡器資源，請檢查輸入參數。
404	ResourceNotFound.listener	The specified resource %s is not found.	資源%s不存在。

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

變更歷史

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