ListListeners - 查询监听 - 负载均衡

查询网络型负载均衡监听列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
nlb:ListListeners	get	Listener acs:nlb:{#regionId}:{#accountId}:listener/*	无	无

请求参数

名称	类型	必填	描述	示例值
ListenerIds	array	否	监听实例 ID。最多支持 20 个监听 ID。
ListenerId	string	否	监听实例 ID。最多支持 20 个监听 ID。	lsn-bp1bpn0kn908w4nbw****@443
LoadBalancerIds	array	否	网络型负载均衡实例 ID。最多支持 20 个实例 ID。
LoadBalancerId	string	否	网络型负载均衡实例 ID。最多支持 20 个实例 ID。	nlb-83ckzc8d4xlp8o****
ListenerProtocol	string	否	监听协议。取值：TCP、UDP 或 TCPSSL。	TCPSSL
Tag	array<object>	否	标签列表。
	object	否	标签。
Key	string	否	实例的标签键。最多支持输入 20 个标签键。一旦输入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	env
Value	string	否	实例的标签值。最多支持输入 20 个标签值。一旦输入该值，可以为空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	product
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	20
RegionId	string	否	网络型负载均衡实例所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
SecSensorEnabled	string	否	是否开启秒级监控功能。取值： true：开启。 false：关闭。	false

返回参数

名称	类型	描述	示例值
	object	查询监听列表。
RequestId	string	请求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
Listeners	array<object>	网络型负载均衡监听列表。
ListenerInfo	object	网络型负载均衡监听列表。
Tags	array<object>	标签列表。
tagModels	object	标签。
Key	string	标签键。	Created
Value	string	标签值。	TF
LoadBalancerId	string	网络型负载均衡实例 ID。	nlb-83ckzc8d4xlp8o****
ListenerId	string	监听 ID。	lsn-ga6sjjcll6ou34l1et****
ListenerProtocol	string	监听协议。取值：TCP、UDP 或 TCPSSL。	TCPSSL
ListenerPort	integer	监听端口。	443
StartPort	string	全端口监听起始端口。	233
EndPort	string	全端口监听结束端口。	455
ListenerDescription	string	自定义监听名称。长度限制为 2~256 个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。	tcpssl_443
ServerGroupId	string	服务器组 ID。	sgp-ppdpc14gdm3x4o****
IdleTimeout	integer	连接空闲超时时间。单位：秒。	900
SecurityPolicyId	string	安全策略 ID。说明仅对 TCPSSL 监听生效。	tls_cipher_policy_1_1
CertificateIds	array	服务器证书列表信息。说明仅对 TCPSSL 监听生效。
CertificateId	string	服务器证书列表信息。说明仅对 TCPSSL 监听生效。	123157******
CaCertificateIds	array	CA 证书列表信息。说明仅对 TCPSSL 监听生效。
CaCertificateId	string	CA 证书列表信息。说明仅对 TCPSSL 监听生效。	139a00******
CaEnabled	boolean	是否启动双向认证。取值： true：启动。 false：关闭。	false
ListenerStatus	string	当前监听的状态，取值： Provisioning：创建中。 Running：运行中。 Configuring：配置中。 Stopping：停止中。 Stopped：已停止。 Starting：启动中。 Deleting：删除中。 Deleted：已删除。	Running
RegionId	string	网络型负载均衡实例所在的地域 ID。	cn-hangzhou
AlpnEnabled	boolean	是否开启 ALPN。取值： true：开启。 false：关闭。	false
AlpnPolicy	string	ALPN 策略。取值： HTTP1Only HTTP2Only HTTP2Preferred HTTP2Optional	HTTP1Only
SecSensorEnabled	boolean	是否开启秒级监控功能。取值： true：开启。 false：关闭。	false
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
Cps	integer	该监听在每个可用区（VIP）处理的每秒新建连接限速值。取值范围：0~1000000。0 表示不限速。	1000
Mss	integer	TCP 报文的最大段大小。单位：字节，取值范围：0~1500。0 表示不修改用户 TCP 报文的 MSS 值。说明仅 TCP、TCPSSL 类型的监听支持该字段值。	200
TotalCount	integer	列表条目数。	4
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	分批次查询时每次显示的条目数。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "Listeners": [
    {
      "Tags": [
        {
          "Key": "Created",
          "Value": "TF"
        }
      ],
      "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
      "ListenerId": "lsn-ga6sjjcll6ou34l1et****",
      "ListenerProtocol": "TCPSSL",
      "ListenerPort": 443,
      "StartPort": "233",
      "EndPort": "455",
      "ListenerDescription": "tcpssl_443",
      "ServerGroupId": "sgp-ppdpc14gdm3x4o****",
      "IdleTimeout": 900,
      "SecurityPolicyId": "tls_cipher_policy_1_1",
      "CertificateIds": [
        "123157******"
      ],
      "CaCertificateIds": [
        "139a00******"
      ],
      "CaEnabled": false,
      "ListenerStatus": "Running",
      "RegionId": "cn-hangzhou",
      "AlpnEnabled": false,
      "AlpnPolicy": "HTTP1Only",
      "SecSensorEnabled": false,
      "ProxyProtocolEnabled": false,
      "ProxyProtocolV2Config": {
        "Ppv2VpcIdEnabled": false,
        "Ppv2PrivateLinkEpIdEnabled": false,
        "Ppv2PrivateLinkEpsIdEnabled": false
      },
      "Cps": 1000,
      "Mss": 200
    }
  ],
  "TotalCount": 4,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	SystemBusy	System is busy, please try again later.	系统繁忙，请稍后重试
400	IllegalParam	The param of %s is illegal.	输入的参数有值非法，请检查输入。
403	Forbidden.NoPermission	Authentication is failed for NoPermission.	因为账号没有权限，所以鉴权失败。

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

变更历史

变更时间	变更内容概要	操作
2024-02-29	OpenAPI 错误码发生变更	查看变更详情
2023-12-12	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-11-27	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2023-09-26	OpenAPI 错误码发生变更	查看变更详情
2023-09-05	OpenAPI 错误码发生变更	查看变更详情
2023-08-22	OpenAPI 错误码发生变更	查看变更详情
2023-06-29	OpenAPI 入参发生变更、OpenAPI 返回结构发生变更	查看变更详情