1)接口功能介绍
查询负载均衡列表。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取。
3)URI
GET /v1/describeLoadBalancers。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘集群id | cn-guangzhou6 | |
name | 否 | String | 负载均衡器名称 | slb-042a3d | |
vpcId | 否 | String | 虚拟私有云ID | 542 | |
type | 否 | String | 查询负载均衡网络类型 SearchSlbAll: 查询全部,SearchExternal: 查询外网SLB,SearchInternal: 查询内网SLB,不填默认查询全部 | SearchSlbAll | |
page | 否 | Integer | 当前页数,默认1 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,默认10 | 10 |
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 | 每页显示的记录条数 | |
slbList | 是 | List | * | 获取负载均衡数据列表 | slbList |
表 slbList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | String | SLB id | 223 | |
name | 是 | String | 负载均衡器名称 | slb-084a | |
internalIp | 否 | String | 内网IP | 198.19.0.2 | |
state | 是 | String | SLB_STATE_BROKEN-故障, SLB_STATE_RUNNING-运行中,Enum-SLB_STATE_UNSPECIFIED | SLB_STATE_RUNNING | |
vpcName | 是 | String | 虚拟私有云名称 | vpc-xxx | |
eipIp | 否 | String | 弹性公网IP | 1.1.1.1 | |
type | 是 | String | SLB类型,EXTERNAL-外网SLB,INTERNAL-内网SLB | INTERNAL | |
description | 是 | String | 描述 | test | |
listeners | 否 | List | 监听器 | * | listeners |
表 listeners
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
protocol | 是 | String | 协议类型 (目前只是支持PROTOCOL_TCP,PROTOCOL_HTTP,PROTOCOL_UDP, PROTOCOL_HTTPS) PROTOCOL_UNSPECIFIED: 未指定 | PROTOCOL_HTTP | |
name | 是 | String | 监听器名称 | slb-test | |
port | 是 | String | 前端协议端口 | 22 |
6)请求示例
GET https://{host}/v1/describeLoadBalancers?nodeCode=hn-changde-1
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"totalPage": 1,
"slbList": [
{
"name": "slb-创建1",
"internalIp": "198.19.0.2",
"listeners": [],
"slbUid": "slb-ce25k1mi15ho6kq6qki0",
"state": "SLB_STATE_RUNNING",
"vpcName": "vpc-eop-test2",
"eipIp": "",
"isDeletable": true,
"type": "INTERNAL",
"id": "3171",
"description": "test"
},
{
"name": "slb",
"internalIp": "",
"listeners": [
{
"protocol": "PROTOCOL_HTTP",
"name": "slb-123",
"port": 22
}
],
"slbUid": "slb-cdq8qnui15hjgj0e6i80",
"state": "SLB_STATE_RUNNING",
"vpcName": "test-do-not-delete",
"eipIp": "",
"isDeletable": false,
"type": "EXTERNAL",
"id": "3016",
"description": ""
}
],
"total": 3,
"page": 1,
"perPageNum": 10
},
"requestId": "a9a6d685-b152-4073-951f-b0226a39c5ba"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |