1)接口功能介绍
查询HTTP监听器。
2)接口约束
负载均衡器ID参数正确请求。
3)URI
GET /v1/describeLoadBalancerHTTPListenerAttribute。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbId | 是 | String | 负载均衡器ID | 22 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | string | 状态描述 | Success | |
code | 是 | string | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 1 | 总页数 | |
total | 是 | Integer | 6 | 记录总个数 | |
page | 是 | Integer | 1 | 当前页数 | |
perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
listenerList | 是 | List | * | 获取可用主机IP响应数据列表 | listenerList |
表 listenerList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbListenerId | 是 | String | 监听器ID | 343 | |
name | 是 | String | 监听器名称 | listener-084a | |
uuid | 是 | String | 监听器UID | e0fb12d4-a189-4d82-8426-c0714da6ed10 | |
protocol | 是 | String | 前端协议类型 | PROTOCOL_HTTPS | |
port | 是 | Integer | 前端协议端口 | 443 | |
certName | 是 | String | SSL证书名称 | ssl-ro98 | |
createTime | 是 | String | 创建时间 | 1618214099 | |
description | 是 | String | 监听器描述 | sdk-test | |
routeInfoList | 是 | List | 转发策略列表 | * | routeInfoList |
certificateId | 是 | String | 证书id | 1547 |
表 routeInfoList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 转发策略名称 | forwarding-policy-xmy0 | |
routeId | 是 | String | 转发策略ID | 53 | |
domain | 是 | String | 域名 | abc.com | |
url | 是 | String | 匹配URL | https://www.ctyun.cn | |
matchType | 是 | String | Url匹配类型。Url匹配类型 MATCH_TYPE_EXACT: 精确匹配,MATCH_TYPE_PREFIX: 前缀匹配,MATCH_TYPE_REGULAR: 正则匹配 | MATCH_TYPE_EXACT | |
state | 是 | String | 转发策略状态 ROUTE_STATE_BROKEN: 故障 - ROUTE_STATE_RUNNING: 运行中 | ROUTE_STATE_RUNNING | |
description | 是 | String | 转发策略描述 | sdk-test | |
isDefault | 是 | Integer | 是否为默认转发策略,0是,1不是。 | 1 | |
backendGroupName | 是 | String | 后端服务器组名称 | server-group-yq46 |
6)请求示例
GET https://{host}/v1/describeLoadBalancerHTTPListenerAttribute?slbId=3016
7)响应示例
{
"data": {
"listenerList": [
{
"name": "listener-5h5u",
"slbListenerId": "50",
"uuid": "e0fb12d4-a189-4d82-8426-c0714da6ed10",
"protocol": "PROTOCOL_HTTP",
"port": 23,
"certName": "",
"createTime": "1616404976",
"description": "",
"certificateId": 0,
"routeInfoList": [
{
"name": "listener-5h5u",
"routeId": "53",
"url": "",
"state": "ROUTE_STATE_RUNNING",
"matchType": "MATCH_TYPE_UNSPECIFIED",
"domain": "",
"description": "",
"isDefault": 0,
"backendGroupName": "server-group-sx14"
},
{
"name": "forwarding-policy-24s2",
"routeId": "54",
"url": "https://www.ctyun.cn",
"state": "ROUTE_STATE_RUNNING",
"matchType": "MATCH_TYPE_EXACT",
"domain": "abc.com",
"description": "sdk-test",
"isDefault": 1,
"backendGroupName": "server-group-sx15"
}
]
},
{
"name": "listener-7h7u",
"slbListenerId": "51",
"uuid": "ad2c12d4-a189-4d82-8426-c0714da6ec23",
"protocol": "PROTOCOL_HTTP",
"port": 25,
"certName": "",
"createTime": "1616404120",
"description": "sdk-test",
"routeInfoList": [
{
"name": "listener-7h7u",
"routeId": "55",
"url": "",
"state": "ROUTE_STATE_RUNNING",
"matchType": "MATCH_TYPE_UNSPECIFIED",
"domain": "",
"description": "",
"isDefault": 0,
"backendGroupName": "server-group-sx16"
},
{
"name": "forwarding-policy-027a",
"routeId": "56",
"url": "https://www.ctyun.cn",
"state": "ROUTE_STATE_RUNNING",
"matchType": "MATCH_TYPE_EXACT",
"domain": "abc.com",
"description": "sdk-test",
"isDefault": 1,
"backendGroupName": "server-group-sx17"
}
]
}
]
},
"requestId": "814c9c87-3e90-4004-b0f6-7e874f820855",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |