describeListeners
描述
查询监听器
请求方式
GET
请求地址
https://cps.jdcloud-api.com/v1/regions/{regionId}/listeners
名称 |
类型 |
是否必需 |
默认值 |
描述 |
regionId |
String |
True |
|
地域ID,可调用接口(describeCPSLBRegions)获取云物理服务器支持的地域 |
请求参数
名称 |
类型 |
是否必需 |
默认值 |
描述 |
pageNumber |
Integer |
False |
1 |
页码;默认为1 |
pageSize |
Integer |
False |
20 |
分页大小;默认为20;取值范围[20, 100] |
name |
String |
False |
|
名称 |
loadBalancerId |
String |
False |
|
负载均衡实例ID,精确匹配 |
filters |
Filter[ ] |
False |
|
listenerId - 监听器ID,精确匹配,支持多个 |
Filter
名称 |
类型 |
是否必需 |
默认值 |
描述 |
name |
String |
True |
|
过滤条件的名称 |
operator |
String |
False |
|
过滤条件的操作符,默认eq |
values |
String[ ] |
True |
|
过滤条件的值 |
返回参数
名称 |
类型 |
描述 |
result |
Result |
|
requestId |
String |
|
Result
名称 |
类型 |
描述 |
listeners |
Listener[ ] |
|
pageNumber |
Integer |
页码;默认为1 |
pageSize |
Integer |
分页大小;默认为20;取值范围[20, 100] |
totalCount |
Integer |
查询结果总数 |
Listener
名称 |
类型 |
描述 |
listenerId |
String |
监听器ID |
loadBalancerId |
String |
负载均衡ID |
protocol |
String |
协议 |
port |
Integer |
端口 |
algorithm |
String |
调度算法 |
stickySession |
String |
会话保持状态,取值on |
realIp |
String |
获取真实ip |
status |
String |
状态 |
name |
String |
名称 |
description |
String |
描述 |
healthCheck |
String |
健康检查状态,取值on |
healthCheckTimeout |
Integer |
健康检查响应的最大超时时间,单位s |
healthCheckInterval |
Integer |
健康检查响应的最大间隔时间,单位s |
healthyThreshold |
Integer |
健康检查结果为success的阈值 |
unhealthyThreshold |
Integer |
健康检查结果为fail的阈值 |
healthCheckIp |
String |
健康检查ip |
serverGroupId |
String |
服务器组id |
返回码
返回码 |
描述 |
200 |
OK |
400 |
Bad request |
404 |
Not found |
500 |
Internal server error |
503 |
Service unavailable |