ListListeners - 查詢監聽列表 - Server Load Balancer

查詢負載平衡監聽列表。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

gwlb:ListListeners

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
ListenerIds	array	否	監聽 ID 列表，最多支援 20 個監聽 ID。
	string	否	監聽 ID。	lsn-w3t3vpgjj12b2i****
LoadBalancerIds	array	否	網關型Server Load Balancer執行個體 ID。最多支援 20 個執行個體 ID。
	string	否	網關型Server Load Balancer執行個體 ID。	gwlb-rbtjolkkbudmrr****
NextToken	string	否	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	d209f4e63ec942c967c50c888a13****
MaxResults	integer	否	使用 NextToken 方式查詢時，每次最多返回的結果數。取值範圍：1~1000。預設值：20。	20
Tag	array<object>	否	標籤列表。一次調用最多支援 20 個標籤。
	object	否	標籤。
Key	string	否	標籤鍵。一旦傳入該值，則不允許為空白字串。一個標籤健最多支援 128 個字元，不能以`aliyun`和`acs:`開頭，不能包含`http://`或者`https://`。	tagKey
Value	string	否	標籤值。最多支援 256 個字元，不能包含`http://`或`https://`。	tagValue
Skip	integer	否	分頁查詢時，跳過的條目數。	10

返回參數

名稱	類型	描述	樣本值
	object	請求的傳回值。
Listeners	array<object>	網關型負載平衡監聽列表。
	object	監聽資訊。
ListenerDescription	string	監聽描述。	listener-description
ListenerId	string	監聽 ID。	lsn-vu7folhh5ntm8u****
ListenerStatus	string	當前監聽的狀態，取值： Provisioning：建立中。 Running：運行中。 Configuring：配置中。 Deleting：刪除中。	Running
LoadBalancerId	string	網關型Server Load Balancer執行個體的 ID。	gwlb-uf6hbeh795xlqln7g****
ServerGroupId	string	伺服器組 ID。	sgp-5yapcb422i51ru****
TcpIdleTimeout	integer	TCP 串連空閑逾時時間。	350
Tags	array<object>	標籤列表。
	object	標籤列表。
Key	string	標籤鍵。	testKey
Value	string	標籤值。	testValue
MaxResults	integer	使用 NextToken 方式查詢時，每次最多返回的結果數。取值範圍：1~1000。預設值：20。	20
NextToken	string	是否擁有下一次查詢的令牌（Token）。取值：如果 NextToken 為空白表示沒有下一次查詢。如果 NextToken 有傳回值，該取值表示下一次查詢開始的令牌。	5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****
RequestId	string	請求 ID。	7DBFC67C-A272-5952-8287-6C3EBE4E04D9
TotalCount	integer	列表條目總數。	8

樣本

正常返回樣本

JSON格式

{
  "Listeners": [
    {
      "ListenerDescription": "listener-description",
      "ListenerId": "lsn-vu7folhh5ntm8u****",
      "ListenerStatus": "Running",
      "LoadBalancerId": "gwlb-uf6hbeh795xlqln7g****",
      "ServerGroupId": "sgp-5yapcb422i51ru****",
      "TcpIdleTimeout": 350,
      "Tags": [
        {
          "Key": "testKey",
          "Value": "testValue"
        }
      ]
    }
  ],
  "MaxResults": 20,
  "NextToken": "5c281c0a0d6bfb6355ed088c2108aca8e0b5e8707e68****",
  "RequestId": "7DBFC67C-A272-5952-8287-6C3EBE4E04D9",
  "TotalCount": 8
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParam.TagKey	The param of TagKey is missing.	標籤鍵參數缺失
400	DuplicatedParam.TagKey	The param of %s is duplicated.	標籤鍵參數重複

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

變更歷史

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