负载均衡
负载均衡
传统型负载均衡CLB
请输入
- 文档首页
负载均衡API参考CLB-监听器DescribeListenerAttributes - 查询监听器详细信息
复制全文
下载 pdfDescribeListenerAttributes - 查询监听器详细信息
文档反馈
问问助手调用 DescribeListenerAttributes 接口，查看指定监听器的详细信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action String 必选 示例值：DescribeListenerAttributes
要执行的操作，取值：DescribeListenerAttributes。
Version String 必选 示例值：2020-04-01
API的版本信息，当前版本为 2020-04-01。
返回参数
RequestId String 示例值：20210811152539010225146063030****
请求ID。
LoadBalancerId String 示例值：clb-bp1o94dp5i6ea****
监听器所属的负载均衡实例ID。
ListenerId String 示例值：lsn-2fek3rgsxhrsw5oxruwec****
监听器的ID。
ListenerName String 示例值：mylistener
监听器的名称。
Description String 示例值：test
监听器的描述。
Protocol String 示例值：TCP
监听器的协议。
- TCP
- UDP
- HTTP
- HTTPS
Port Integer 示例值：80
监听端口。
- 0：开启全端口监听。全端口监听正在邀测中，如需试用，请联系客户经理。
- 其他端口：具体的监听端口。
StartPort Integer 示例值：80
全端口监听的起始端口。
仅开启全端口监听时，返回此参数。
EndPort Integer 示例值：100
全端口监听的结束端口。
仅开启全端口监听时，返回此参数。
Scheduler String 示例值：wrr
监听器使用的调度算法。
- wrr （默认值）：加权轮询，权重值越高的后端服务器，被轮询到的次数（概率）越高。
- wlc：加权最小连接数，在最少连接数的基础上，根据服务器的不同处理能力，给每个服务器分配不同的权重，使其能够接受相应权值数的服务请求。
- sh：源地址哈希，基于源IP地址的一致性哈希，相同的源地址会调度到相同的后端服务器。
Cps Integer 示例值：10
监听器的新建连接数上限。
MaxConnections Integer 示例值：10
监听器的最大连接数上限。
Bandwidth Integer 示例值：10
监听器的带宽峰值，单位为Mbps。
返回为-1，表示监听器不指定限速。此时监听器的带宽峰值默认为CLB实例规格的剩余带宽。
ServerGroupId String 示例值：rsp-bp1o94dp5i6ea****
TCP/UDP监听器关联的后端服务器组的ID。HTTP/HTTPS监听器关联的默认后端服务器组ID。
CertificateSource String 示例值：clb
证书的来源。
- clb ：CLB侧证书管理模块。
- cert_center：证书中心。
CertCenterCertificateId String 示例值：cert-bp1o94dp5i6eb****
证书中心的证书的ID。
CertificateId String 示例值：cert-bp1o94dp5i6ea****
CLB侧证书管理模块的证书的ID。
CAEnabled String 示例值：off
是否开启双向认证。
- on：开启。
- off：不开启。
CACertificateId String 示例值：pca_leaf_M6gaihuZRcO****
双向认证的CA证书。
HealthCheck Object 示例值：-
健康检查相关信息。
Enabled String 示例值：off
监听器是否开启健康检查功能。
- on ：开启。
- off：不开启。
UdpRequest String 示例值：Request123
执行健康检查的请求字符串。
仅当UDP监听器指定请求字符串时返回该参数。
UdpExpect String 示例值：Expect123
健康检查的预期响应字符串。
仅当UDP监听器指定请求字符串时返回该参数。
Interval Integer 示例值：2
执行健康检查的时间间隔。
Timeout Integer 示例值：2
健康检查的响应超时时间，表示如果后端服务器在指定的时间内没有正确响应，则判定为健康检查异常。
HealthyThreshold Integer 示例值：3
健康检查的健康阈值，表示连续执行指定次数的健康检查，结果均为“正常”的后端服务器将被判定为健康检查“正常”。
UnHealthyThreshold Integer 示例值：3
健康检查的不健康阈值，表示连续执行指定次数的健康检查，结果均为“异常”的后端服务器将被判定为健康检查“异常”。
Method String 示例值：GET
监听器健康检查的方法。
- GET：服务器需支持GET方法。
- HEAD：服务器仅返回HEAD头部信息，可以降低后端开销，但要求服务器支持HEAD方法。
说明
TCP/UDP监听器不返回该参数。
Uri String 示例值：/
健康检查的路径。
说明
TCP/UDP监听器不返回该参数。
Domain String 示例值：www.test.com
健康检查的域名。
说明
TCP/UDP监听器不返回该参数。
HttpCode String 示例值：http_2xx
健康检查正常的HTTP状态码。
- http_2xx
- http_3xx
- http_4xx
- http_5xx
说明
TCP/UDP监听器不返回该参数。
Port Integer 示例值：80
健康检查的后端服务器端口。
- 开启全端口监听时，返回该参数表示健康检查使用的端口。
- 未开启全端口监听时，不返回该参数，健康检查使用后端服务器的业务端口。
ProxyProtocolType String 示例值：off
是否启用Proxy-Protocol协议。
- off：关闭。
- standard：开启。
PersistenceType String 示例值：off
会话保持的类型。
- off：表示不启用会话保持。
- source_ip：表示源地址IP。
- insert：表示植入Cookie。
- server：表示重写Cookie。
AclStatus String 示例值：off
是否开启访问控制功能。
- on：开启。
- off ：不开启。
AclType String 示例值：black
访问控制的方式。
- white ：白名单。监听器监听CLB的流量时，CLB仅转发其白名单关联访问控制策略组中IP地址的请求。
- black：黑名单。监听器监听CLB的流量时，对于白名单关联访问控制策略组中IP地址的请求，CLB拒绝转发。
说明
仅AclStatus参数为 on 时返回。
AclIds String[] 示例值：["acl-2fe5excqgk6ww5oxruvcv****","acl-2febxt4pu0zy85oxruw0t****"]
监听器绑定的访问控制策略组ID。
说明
仅AclStatus参数为 on 时返回。
PersistenceTimeout Integer 示例值：10
会话保持的超时时间，单位为秒。
Cookie String 示例值：cookie123
后端服务器配置的会话保持的Cookie名称。
ConnectionDrainEnabled String 示例值：on
监听器是否开启连接优雅中断功能。
- on：开启。
- off：不开启。
说明
参数Protocol返回为HTTP或HTTPS时，该参数固定返回off。
ConnectionDrainTimeout Integer 示例值：2
连接优雅中断的超时时间，单位为秒。
说明
参数ConnectionDrainEnabled返回为off时，该参数返回0。
Http2Enabled String 示例值：off
HTTPS协议监听器是否开启前端HTTP 2.0协议。
- on：开启。
- off：不开启。
说明
TCP、UDP和HTTP协议监听器不返回该参数。
EstablishedTimeout Integer 示例值：100
监听器的连接超时时间。
说明
仅TCP/UDP监听器会返回本参数。
ClientHeaderTimeout Integer 示例值：60
读取客户端请求头的超时时间。客户端向CLB发起请求，若在超时时间内客户端没有传输整个报头，CLB将返回408错误码给客户端，表示请求超时。
仅HTTP/HTTPS监听器返回此参数。
ClientBodyTimeout Integer 示例值：60
读取客户端请求正文的超时时间。客户端向CLB发起请求，若在超时时间内客户端没有发送任何请求体，CLB将返回408错误码给客户端，表示请求超时。
- 此超时时间仅针对两个连续的读操作之间设置，而非整个请求的传输过程。
- 仅HTTP/HTTPS监听器返回此参数。
KeepaliveTimeout Integer 示例值：60
客户端与CLB之间的长连接超时时间。若在超时时间内一直没有访问请求，CLB会中断当前连接，直到下一次请求到来时重新建立新的连接。
- 0表示禁用长连接。
- 仅HTTP/HTTPS监听器返回此参数。
ProxyConnectTimeout Integer 示例值：60
CLB与后端服务器之间的连接建立超时时间。若超时时间内CLB与后端服务器连接未建立，则终止建立连接操作。
仅HTTP/HTTPS监听器返回此参数。
ProxySendTimeout Integer 示例值：60
CLB将请求传输到后端服务器的超时时间。CLB向后端服务器发起请求，若后端服务器在超时时间内未收到任何内容，则会关闭此连接。
- 此超时仅针对两个连续的写操作之间设置，而非整个请求的传输过程。
- 仅HTTP/HTTPS监听器返回此参数。
ProxyReadTimeout Integer 示例值：60
CLB从后端服务器读取响应的超时时间。CLB向后端服务器发起请求，若超时时间内接收请求的后端服务器无响应，则会关闭此连接。
- 此超时时间仅针对两个连续的读操作之间设置，而非整个响应的传输过程。
- 仅HTTP/HTTPS监听器返回此参数。
SendTimeout Integer 示例值：60
CLB向客户端发送响应的超时时间。CLB向客户端发送响应，若客户端在超时时间内未收到任何内容，则连接会被关闭。
- 此超时仅针对两个连续的写操作之间设置，而非整响应的传输过程。
- 仅HTTP/HTTPS监听器返回此参数。
SecurityPolicyId String 示例值：default_policy
HTTPS监听器的TLS安全策略。仅HTTPS监听器返回此参数。
- default_policy：支持SSL v3、TLS v1.0、TLS v1.1、TLS v1.2。
- tls_cipher_policy_1_0：支持TLS v1.0、TLS v1.1、TLS v1.2。
- tls_cipher_policy_1_1：支持TLS v1.1、TLS v1.2。
- tls_cipher_policy_1_2：支持TLS v1.2。
- tls_cipher_policy_1_2_strict：支持TLS v1.2。
说明
- 除default_policy外，以上TLS安全策略支持的加密套件详情请参见创建HTTPS协议监听器。
- 传入default_policy时，按照ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5配置生效。
Status String 示例值：Active
监听器的状态。
- Creating：创建中。
- Active：运行中。
- Deleting: 删除中。
- Disabled: 已停用。
Enabled String 示例值：off
是否启用监听器。
- on：开启。
- off：不开启。
WafProtectionEnabled String 示例值：off
是否将经过七层监听器的流量送至Web应用防火墙进行检测和过滤。
- on：是。
- off：否。
Tags Object[] 示例值：-
标签信息。
Key String 示例值：k1
标签的标签键。
Value String 示例值：v1
标签的标签值。
CreateTime String 示例值：2021-08-11T16:37:37Z
监听器的创建时间。
UpdateTime String 示例值：2021-08-11T16:37:37Z
监听器的最近操作时间。
DomainExtensions Object[] 示例值：--
符合条件的监听器关联的扩展域名列表。
Domain String 示例值：www.test.com
域名。
CertificateSource String 示例值：cert_center
证书来源。
- cert_center：火山引擎证书中心的SSL 证书。
DomainExtensionId String 示例值：de-***
扩展域名ID。
CertCenterCertificateId String 示例值：cert-***
证书ID。
请求示例
GET /?Action=DescribeListenerAttributes&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec****
Host: clb.cn-beijing.volcengineapi.com
X-Date: 20251121T094038Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "DescribeListenerAttributes",
"Version": "2020-04-01",
"Service": "clb",
"Region": "cn-beijing"
},
"Result": {
"AclIds": [
"acl-2fe5excqgk6ww5oxruvcv****",
"acl-2febxt4pu0zy85oxruw0t****"
],
"AclStatus": "off",
"AclType": "black",
"Bandwidth": 10,
"CACertificateId": "pca_leaf_M6gaihuZRcO****",
"CAEnabled": "off",
"CertCenterCertificateId": "cert-bp1o94dp5i6eb****",
"CertificateId": "cert-bp1o94dp5i6ea****",
"CertificateSource": "clb",
"ClientBodyTimeout": 60,
"ClientHeaderTimeout": 60,
"ConnectionDrainEnabled": "on",
"ConnectionDrainTimeout": 2,
"Cookie": "cookie123",
"Cps": 10,
"CreateTime": "2021-08-11T16:37:37Z",
"Description": "test",
"DomainExtensions": [
{
"Domain": "www.test.com",
"CertificateSource": "cert_center",
"DomainExtensionId": "de-***",
"CertCenterCertificateId": "cert-***"
}
],
"Enabled": "off",
"EndPort": 100,
"EstablishedTimeout": 100,
"HealthCheck": {
"Uri": "/",
"Port": 80,
"Domain": "www.test.com",
"Method": "GET",
"Enabled": "off",
"Timeout": 2,
"HttpCode": "http_2xx",
"Interval": 2,
"UdpExpect": "Expect123",
"UdpRequest": "Request123",
"HealthyThreshold": 3,
"UnHealthyThreshold": 3
},
"Http2Enabled": "off",
"KeepaliveTimeout": 60,
"ListenerId": "lsn-2fek3rgsxhrsw5oxruwec****",
"ListenerName": "mylistener",
"LoadBalancerId": "clb-bp1o94dp5i6ea****",
"MaxConnections": 10,
"PersistenceTimeout": 10,
"PersistenceType": "off",
"Port": 80,
"Protocol": "TCP",
"ProxyConnectTimeout": 60,
"ProxyProtocolType": "off",
"ProxyReadTimeout": 60,
"ProxySendTimeout": 60,
"RequestId": "20210811152539010225146063030****",
"Scheduler": "wrr",
"SecurityPolicyId": "default_policy",
"SendTimeout": 60,
"ServerGroupId": "rsp-bp1o94dp5i6ea****",
"StartPort": 80,
"Status": "Active",
"Tags": [
{
"Key": "k1",
"Value": "v1"
}
],
"UpdateTime": "2021-08-11T16:37:37Z",
"WafProtectionEnabled": "off"
}
}
错误码
最近更新时间：2026.02.13 10:32:58
这个页面对您有帮助吗？
有用
有用
无用
无用