调用ListListeners API查询监听列表-负载均衡-阿里云

查询负载均衡监听列表。

调试

您可以在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	否	网关型负载均衡实例 ID。最多支持 20 个实例 ID。
	string	否	网关型负载均衡实例 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	网关型负载均衡实例的 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.	标签键参数重复

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。