tencent cloud

负载均衡

动态与公告
产品动态
产品公告
产品简介
产品概述
产品优势
使用场景
技术原理
产品对比
使用约束
Service Regions and Service Providers
购买指南
计费概述
计费项
CLB 资源包
购买方式
欠费说明
产品属性选择
快速入门
域名化负载均衡快速入门
负载均衡快速入门
IPv6 负载均衡快速入门
CentOS 下部署 Nginx
CentOS 下部署 Java Web
操作指南
负载均衡实例
负载均衡监听器
后端服务器
健康检查
证书管理
日志管理
监控告警
访问管理
传统型负载均衡
实践教程
部署证书到负载均衡(双向认证)
负载均衡开启 Gzip 配置及检测方法说明
HTTPS 转发配置入门指南
如何获取客户端真实 IP
负载均衡配置监控告警最佳实践
产品高可用说明
均衡算法选择与权重配置示例
配置 WAF 对负载均衡的监听域名进行 Web 安全防护
配置 IAP 对负载均衡的域名和路径的web访问进行身份验证
配置 IAP 对负载均衡的域名和路径的程序化访问进行身份验证
运维指南
客户端 timewait 过多解决方案
负载均衡HTTPS服务性能测试
压力测试常见问题
CLB 证书操作权限问题
故障处理
UDP 健康检查出现异常
API 文档
History
Introduction
API Category
Instance APIs
Listener APIs
Backend Service APIs
Target Group APIs
Redirection APIs
Other APIs
Classic CLB APIs
Load Balancing APIs
Making API Requests
Data Types
Error Codes
CLB API 2017
常见问题
计费相关
负载均衡配置相关
健康检查异常排查
HTTPS 相关
WS/WSS 协议支持相关
HTTP/2 协议支持相关
默认域名阻断提示
服务等级协议
联系我们
词汇表

DescribeLoadBalancerListeners

PDF
聚焦模式
字号
最后更新时间: 2025-11-20 15:21:19

1. API Description

This API is used to get the list of listeners by CLB instance IDs, listener protocol, or port. If no filter is specified, the default number (20) of listeners for the instance will be returned.
Domain name for API access: lb.api.qcloud.com

2. Request Parameters

The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The Action field for this API is DescribeLoadBalancerListeners.
Parameter
Required
Type
Description
loadBalancerId
Yes
String
Unique ID of the CLB instance, which can be queried via the DescribeLoadBalancers API. You can use loadBalancerId or unLoadBalancerId, we recommand using unLoadBalancerId.
listenerIds.n
No
String
ID of the CLB listener.
protocol
No
Int
Protocol type of the listener. 1: HTTP; 2: TCP; 3: UDP; 4: HTTPS.
loadBalancerPort
No
Int
Port of the CLB listener.
status
No
Int
Status of the CLB listener. This field will be ignored when listenerIds.n is specified.

3. Response Parameters

Parameter
Type
Description
code
Int
Common error code. 0: success; other values: failure. For more information, see Common Error Codes.
message
String
API-related module error message description.
codeDesc
String
Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned.
totalCount
Int
Total number of CLB instances that meet the filter criteria.
listenerSet
Array
Returned array of listeners.
Data structure of the returned listener array:
Parameter
Type
Description
unListenerId
String
ID of the CLB listener.
loadBalancerPort
Int
Listening port of the CLB instance.
instancePort
Int
Forwarding port of the listener’s backend.
listenerName
String
Listener name.
protocol
No
Int
sessionExpire
Int
Session persistence duration.
healthSwitch
Int
Whether to enable the health check. 1: enable; 0: disable.
timeOut
Int
Response timeout.
intervalTime
Int
Interval between health checks.
healthNum
Int
Healthy threshold.
unhealthNum
Int
Unhealthy threshold.
httpHash
String
Polling method of the public network HTTP or HTTPS listener with static IP. Valid values: wrr (weighted round robin) ip_hash (forwarding the hash of the source IP to the real server).
httpCode
Int
Health check return code of the public network HTTP or HTTPS listener with static IP.
httpCheckPath
String
Health check path of the public network HTTP or HTTPS listener with static IP.
SSLMode
String
Verification method of public network HTTPS listener with static IP.
certId
String
Server certificate ID of the public network HTTPS listener with static IP.
certCaId
String
Client certificate ID of the public network HTTPS listener with static IP.
status
Int
Listener status. 0: creating. 1: running.

4. Example

Request
https://lb.api.qcloud.com/v2/index.php?Action=DescribeLoadBalancerListeners
&loadBalancerId=lb-abcdefgh
&listenerIds.0=lbl-6hkiqc6c
&listenerIds.1=lbl-6wv071ba
Response
{
"code": 0,
"message": "",
"codeDesc": "Success",
"listenerSet": [
{
"loadBalancerPort": 80,
"instancePort": 80,
"protocol": 4,
"status": 1,
"listenerName": "teaa",
"unListenerId": "lbl-6hkiqc6c",
"sessionExpire": 1000,
"healthSwitch": 1,
"timeOut": 6,
"intervalTime": 6,
"healthNum": 3,
"unhealthNum": 3,
"httpCode": 15,
"httpCheckPath": "/",
"httpHash": "ip_hash",
"SSLMode": "mutual",
"certId": "4b9fc92b",
"certCaId": "ee4c5590"
},
{
"loadBalancerPort": 777,
"instancePort": 798,
"protocol": 4,
"status": 1,
"listenerName": "",
"unListenerId": "lbl-6wv071ba",
"sessionExpire": 0,
"healthSwitch": 1,
"timeOut": 2,
"intervalTime": 5,
"healthNum": 3,
"unhealthNum": 3,
"httpCode": 31,
"httpCheckPath": "/",
"httpHash": "wrr",
"SSLMode": "mutual",
"certId": "e2b6d555",
"certCaId": "dcda0a22"
}
],
"totalCount": 2
}



帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈