AI 助理
文档备案控制台
官方文档
输入文档关键字查找
首页

DescribeLoadBalancerListeners - 查询负载均衡监听列表

更新时间：
复制为 MD 格式
产品详情
我的收藏

查询负载均衡监听列表详情。

接口说明

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

slb:DescribeLoadBalancerListeners

get

*LoadBalancer

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

 无 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

否

传统型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

说明

当您所选地域的 Endpoint（服务地址）为 slb.aliyuncs.com 时，RegionId必填。

cn-hangzhou
NextToken

string

否

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。

  • 如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。

FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults

integer

否

分批次查询时每次显示的条目数。

取值范围：1~100，入参为空时，默认值：20。

50
ListenerProtocol

string

否

传统型负载均衡监听协议。取值：

  • tcp

  • udp

  • http

  • https

http
LoadBalancerId

array

否

传统型负载均衡实例的 ID 列表，最多支持 10 个实例 ID。

说明

非 SDK 调用，请使用 LoadBalancerId.N 形式添加参数。

lb-123wrwer

string

否

传统型负载均衡实例的 ID。

lb-uf6so8u4g35prnvsw****
Tag

array<object>

否

标签列表。

object

否

标签列表。

Key

string

否

资源的标签键。N 的取值范围：1~20。一旦输入该值，则不允许为空字符串。

最多支持 64 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

TestKey
Value

string

否

资源的标签值。N 的取值范围：1~20。一旦输入该值，可以为空字符串。 最多支持 128 个字符，不能以aliyun和acs:开头，不能包含http://或者https://。

TestValue
ListenerPort

integer

否

CLB 实例使用的监听端口。

443
Description

string

否

自定义监听名称。

HTTPS_443

返回参数

名称

类型

描述

示例值

object

NextToken

string

是否拥有下一次查询的令牌（Token）。取值：

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。

FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId

string

请求 ID。

365F4154-92F6-4AE4-92F8-7FF34B540710
TotalCount

integer

本次请求条件下的数据总量。

10
MaxResults

integer

分批次查询时每次显示的条目数。

50
Listeners

array<object>

返回传统型负载均衡的监听列表。

说明

实例未配置监听时，不会返回该参数。

array<object>

返回传统型负载均衡的监听列表。

说明

实例未配置监听时，不会返回该参数。

AclType

string

访问控制类型。取值：

  • white：仅转发来自所选访问控制策略组中设置的 IP 地址或地址段的请求，白名单适用于只允许特定 IP 访问的场景。设置白名单存在一定业务风险。一旦设置白名单，就只有白名单中的 IP 可以访问负载均衡监听。

如果开启了白名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。

  • black：来自所选访问控制策略组中设置的 IP 地址或地址段的所有请求都不会转发，黑名单适用于只限制某些特定 IP 访问的场景。

如果开启了黑名单访问，但访问策略组中没有添加任何 IP，则负载均衡监听会转发全部请求。

white
Status

string

监听的状态。取值：

  • running：表示监听正常运行。

  • stopped：表示监听运行停止。

running
VServerGroupId

string

监听绑定的虚拟服务器组 ID。

rsp-cige6j****
ListenerProtocol

string

传统型负载均衡监听协议。

http
LoadBalancerId

string

传统型负载均衡实例的 ID。

lb-bp1b6c719dfa****
ListenerPort

integer

监听端口。

80
AclId

string

访问控制策略组 ID。

acl-a2do9e413e0spzasx****
Scheduler

string

调度算法。取值：

  • wrr：权重值越高的后端服务器，被轮询到的次数（概率）也越高。

  • rr：按照访问顺序依次将外部请求依序分发到后端服务器。

  • sch：基于源 IP 地址的一致性 hash，相同的源地址会调度到相同的后端服务器。

  • tch：基于四元组的一致性 hash（源 IP+目的 IP+源端口+目的端口），相同的流会调度到相同的后端服务器。

  • qch：基于 QUIC Connection ID 一致性 hash，相同的 QUIC Connection ID 会调度到相同的后端服务器。

说明

仅性能保障型实例支持 sch、tch 和 qch 一致性 hash 算法。

wrr
Bandwidth

integer

监听的带宽峰值。单位：Mbps。

-1
Description

string

监听描述。

test
AclStatus

string

是否开启访问控制功能。取值：

  • on：是

  • off：否

off
BackendServerPort

integer

后端服务器的端口。

说明

VServerGroupId和MasterSlaveServerGroupId均为空时，此参数有效。

80
AclIds

array

访问控制策略组 ID 列表。

HTTPListenerConfig

object

HTTP 监听配置。

HealthCheckHttpVersion

string

健康检查 HTTP 协议版本。

HTTP 1.0
XForwardedFor_ClientSrcPort

string

是否通过XForwardedFor_ClientSrcPort头字段获取访问负载均衡实例客户端的端口。取值：

  • on：是

  • off：否

on
Cookie

string

服务器上配置的 Cookie。

B490B5EBF6F3CD402E515D22BCDA****
Gzip

string

是否开启 Gzip 压缩。取值：

  • on：是

  • off：否

on
HealthCheckConnectPort

integer

健康检查的端口。

说明

当 HealthCheck 值为 on 时该参数有效。

8080
HealthCheckTimeout

integer

每次健康检查响应的最大超时间，单位：秒。

3
HealthCheckType

string

健康检查协议。

tcp
CookieTimeout

integer

Cookie 超时时间。单位：秒。

取值：1~86400。

500
HealthCheckDomain

string

健康检查的域名。

www.example.com
UnhealthyThreshold

integer

健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。

取值范围：2~10。

4
XForwardedFor_SLBID

string

是否通过SLB-ID头字段获取负载均衡实例 ID。取值：

  • on：是

  • off：否

on
ForwardPort

integer

HTTP 转发至 HTTPS 的监听端口。

说明

如果 ListenerForward 的值为 off，该参数不显示。

80
HealthCheckHttpCode

string

健康检查正常的 HTTP 状态码。

http_2xx,http_3xx
ListenerForward

string

是否开启 HTTP 至 HTTPS 监听转发。取值：

  • on：是

  • off：否

on
XForwardedFor

string

是否通过XForwardedFor的方式获取来访者真实 IP。取值：

  • on：是。

  • off：否。

on
IdleTimeout

integer

指定连接空闲超时时间。单位：秒。取值范围：1~60。

在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到一下次请求来临时重新建立连接。

15
RequestTimeout

integer

指定请求超时时间。单位：秒。取值范围：1~180。

在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回HTTP 504错误码。

60
HealthCheckInterval

integer

健康检查的时间间隔，单位：秒。

5
XForwardedFor_SLBPORT

string

是否通过XForwardedFor_SLBPORT头字段获取负载均衡实例的监听端口。取值：

  • on：是

  • off：否

on
HealthCheckURI

string

健康检查的 URI。

/test/index.html
StickySessionType

string

Cookie 的处理方式。取值：

  • insert：植入 Cookie。客户端第一次访问时，负载均衡会在返回请求中植入 Cookie（即在 HTTP 和 HTTPS 响应报文中插入 SERVERID），下次客户端携带此 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器上。

  • server：重写 Cookie。负载均衡发现用户自定义了 Cookie，将会对原来的 Cookie 进行重写，下次客户端携带新的 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器。

insert
HealthyThreshold

integer

健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。

取值范围：2~10。

4
XForwardedFor_proto

string

是否通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。取值：

  • on：是

  • off：否

on
XForwardedFor_SLBIP

string

是否通过SLB-IP头字段获取客户端请求的 VIP（Virtual IP address）。取值：

  • on：是

  • off：否

on
StickySession

string

是否开启会话保持。取值：

  • on：是

  • off：否

on
HealthCheckMethod

string

健康检查方式。取值：head 或 get。

get
HealthCheck

string

是否开启健康检查。取值：

  • on：是

  • off：否

on
HTTPSListenerConfig

object

HTTPS 监听配置。

XForwardedFor_ClientCertClientVerify

string

是否通过XForwardedFor_ClientCertClientVerify头字段获取对访问负载均衡实例客户端证书的校验结果。取值：

  • on：是

  • off：否

off
HealthCheckHttpVersion

string

健康检查 HTTP 协议版本。

HTTP 1.0
XForwardedFor_ClientSrcPort

string

是否通过XForwardedFor_ClientSrcPort头字段获取访问负载均衡实例客户端的端口。取值：

  • on：是

  • off：否

off
Cookie

string

服务器上配置的 Cookie。

B490B5EBF6F3CD402E515D22BCDA****
Gzip

string

是否开启 Gzip 压缩。取值：

  • on：是

  • off：否

on
EnableHttp2

string

是否开启HTTP 2.0特性。取值：

  • on：是

  • off：否

off
CACertificateId

string

CA 证书 ID。

idkp-234-cn-test-0****
HealthCheckConnectPort

integer

健康检查的端口。

8080
HealthCheckTimeout

integer

每次健康检查响应的最大超时间。单位：秒。

3
HealthCheckType

string

健康检查协议。

tcp
CookieTimeout

integer

Cookie 超时时间。单位：秒。

取值：1~86400。

500
HealthCheckDomain

string

健康检查的域名。

www.example.com
UnhealthyThreshold

integer

健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。

取值范围：2~10。

4
XForwardedFor_SLBID

string

是否通过SLB-ID头字段获取负载均衡实例 ID。取值：

  • on：是

  • off：否

on
XForwardedFor_ClientCertSubjectDN

string

是否通过XForwardedFor_ClientCertSubjectDN头字段获取访问负载均衡实例客户端证书的所有者信息。取值：

  • on：是。

  • off：否。

off
HealthCheckHttpCode

string

健康检查正常的 HTTP 状态码。

http_2xx,http_3xx
XForwardedFor_ClientCertFingerprint

string

是否通过XForwardedFor_ClientCertFingerprint头字段获取访问负载均衡实例客户端证书的指纹。取值：

  • on：是

  • off：否

off
XForwardedFor

string

是否开启通过XForwardedFor的方式获取来访者真实 IP。取值：

  • on：是

  • off：否

on
RequestTimeout

integer

指定请求超时时间，单位：秒。取值范围：1~180。

在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回HTTP 504错误码。

60
IdleTimeout

integer

指定连接空闲超时时间。单位：秒。取值范围：1~60。

在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到一下次请求来临时重新建立连接。

15
ServerCertificateId

string

服务器证书的 ID。

idkp-123-cn-test-0****
HealthCheckInterval

integer

健康检查的时间间隔。单位：秒。

5
XForwardedFor_SLBPORT

string

是否通过XForwardedFor_SLBPORT头字段获取负载均衡实例的监听端口。取值：

  • on：是

  • off：否

off
HealthCheckURI

string

健康检查的 URI。

/test/index.html
StickySessionType

string

Cookie 的处理方式。

  • insert：植入 Cookie。客户端第一次访问时，负载均衡会在返回请求中植入 Cookie（即在 HTTP 和 HTTPS 响应报文中插入 SERVERID），下次客户端携带此 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器上。

  • server：重写 Cookie。负载均衡发现用户自定义了 Cookie，将会对原来的 Cookie 进行重写，下次客户端携带新的 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器。

insert
XForwardedFor_ClientCertIssuerDN

string

是否通过XForwardedFor_ClientCertIssuerDN头字段获取访问负载均衡实例客户端证书的发行者信息。取值：

  • on：是

  • off：否

off
HealthyThreshold

integer

健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。

取值范围：2~10。

4
XForwardedFor_proto

string

是否通过X-Forwarded-Proto头字段获取负载均衡实例的监听协议。取值：

  • on：是

  • off：否

on
XForwardedFor_SLBIP

string

是否通过SLB-IP头字段获取客户端请求的 VIP（Virtual IP address）。取值：

  • on：是

  • off：否

on
StickySession

string

是否开启会话保持。取值：

  • on：是

  • off：否

on
HealthCheckMethod

string

健康检查方式。

get
TLSCipherPolicy

string

安全策略包含 HTTPS 可选的 TLS 协议版本和配套的加密算法套件。

  • 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。

tls_cipher_policy_1_0
HealthCheck

string

是否开启健康检查。取值：

  • on：是。

  • off：否。

on
TCPListenerConfig

object

TCP 监听配置。

HealthCheckHttpCode

string

健康检查正常的 HTTP 状态码。

http_2xx,http_3xx
ConnectionDrainTimeout

integer

设置连接优雅中断超时时间。单位：秒。

取值范围：10~900。

300
PersistenceTimeout

integer

是否开启了会话保持。单位：秒。

取值范围：0~3600。

取值为 0 时，表示未开启。

0
HealthCheckInterval

integer

健康检查的时间间隔，单位为秒。

5
HealthCheckURI

string

健康检查的 URI。

/test/index.html
HealthCheckConnectPort

integer

健康检查使用的端口。

8080
EstablishedTimeout

integer

连接超时时间。单位：秒。

500
HealthCheckType

string

健康检查协议。

tcp
HealthCheckConnectTimeout

integer

健康检查超时时间。单位：秒。

取值范围：1~300。

100
MasterSlaveServerGroupId

string

监听绑定的主备服务器组 ID。

rsp-0bfucw*****
HealthyThreshold

integer

健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。

取值范围：2~10。

4
HealthCheckDomain

string

健康检查的域名。

www.example.com
UnhealthyThreshold

integer

健康检查连续失败多少次后，将后端服务器的健康检查状态由成功判定为失败。

取值范围：2~10。

4
ConnectionDrain

string

是否开启连接优雅中断。取值：

  • on：是

  • off：否

off
HealthCheckMethod

string

健康检查方式。

get
HealthCheck

string

是否开启健康检查。取值：

  • on：是

  • off：否

on
ProxyProtocolV2Enabled

string

是否支持通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值：

  • true：是。

  • false：否。

false
UDPListenerConfig

object

UDP 监听配置。

ConnectionDrainTimeout

integer

设置连接优雅中断超时时间。单位：秒。

取值范围：10~900。

300
HealthCheckInterval

integer

健康检查的时间间隔，单位为秒。

5
HealthCheckExp

string

UDP 监听健康检查的响应串。

ok
HealthCheckConnectPort

integer

健康检查的端口。

8080
HealthCheckConnectTimeout

integer

健康检查响应超时时间。

100
MasterSlaveServerGroupId

string

绑定的主备服务器组 ID。

rsp-0bfucw****
HealthyThreshold

integer

健康检查阈值。

4
UnhealthyThreshold

integer

不健康检查阈值。

4
ConnectionDrain

string

是否开启连接优雅中断。取值：

  • on：是

  • off：否

off
HealthCheckReq

string

UDP 监听健康检查的请求串。

hello
HealthCheck

string

是否开启健康检查。取值：

  • on：是

  • off：否

on
ProxyProtocolV2Enabled

string

是否支持通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值：

  • true：是。

  • false：否。

false
Tags

array<object>

标签列表。

object

标签列表。

TagValue

string

资源的标签值。

TestValue
TagKey

string

资源的标签键。

TestKey

错误码

HTTP status code

错误码

错误信息

描述
400 IllegalParam.ListenerProtocol The param of ListenerProtocol is illegal. 指定的ListenerProtocol无效。请检查参数约束，并在修改后重试。
400 IllegalParam.MaxResults The param of MaxResults is illegal. 指定的MaxResults无效。请检查参数约束，并在修改后重试。
400 IllegalParam.NextToken The param of NextToken is illegal. 指定的NextToken无效。请检查参数约束，并在修改后重试。
400 IllegalParamSize.LoadBalancerId The param size of LoadBalancerId is illegal. 指定的LoadBalancerId无效。请检查参数约束，并在修改后重试。
400 MissingParam.TagKey The param of TagKey is missing.
403 UnauthorizedRegion The specified region of is not authorized. 指定地域不可见。

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

变更历史

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

上一篇：StopLoadBalancerListener - 停止监听下一篇：TCP监听