接口功能介绍
调用此接口可根据筛选条件查询资源池下负载均衡的列表。
接口约束
regionID(资源池)存在。
URI
GET /v4/monitor/query-elb-list
请求参数
Query参数
参数 | 参数类型 | 是否必填 | 示例 | 说明 | 下级对象 |
---|---|---|---|---|---|
regionID | String | 是 | 81f7728662dd11ec810800155d307d5b | 资源池ID | |
pageNo | Integer | 否 | 1 | 页码,默认为1 | |
page | Integer | 否 | 1 | 页码,默认为1,建议使用pageNo,该参数后续会下线 | |
pageSize | Integer | 否 | 1 | 页大小,默认为10 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败),默认值:800 | 800 | |
errorCode | String | 失败时的错误代码,参见公共错误码说明 | ||
message | String | 失败时的错误描述,一般为英文描述 | Success | |
msgDesc | String | 失败时的错误描述,一般为中文描述 | 成功 | |
returnObj | Object | 返回对象 | returnObj |
表returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
elbList | Array of Objects | 负载均衡资源列表 | elb | |
totalCount | Integer | 获取对象数据条数 | 138 | |
totalPage | Integer | 总页数 | 1 | |
currentCount | Integer | 当前页记录数 | 2 | |
page | Integer | 页码,建议参考请求参数pageNo,该参数后续会下线 | 1 | |
pageSize | Integer | 页大小,建议参考请求参数pageSize,该参数后续会下线 | 10 |
表elb
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
instanceID | String | 负载均衡实例ID | lb-c93mkom8yw | |
instanceName | String | 负载均衡实例名称 | elbd433 | |
deviceUUID | String | 唯一标识ID | lb-c93mkom8yw |
请求示例
GET /v4/monitor/query-elb-list?regionID=81f7728662dd11ec810800155d307d5b&page=1&pageSize=5
响应示例
{
"statusCode":800,
"returnObj":{
"elbList":[
{
"instanceID":"lb-c93mkom8yw",
"instanceName":"elbd433",
"deviceUUID":"lb-c93mkom8yw"
},
{
"instanceID":"lb-09edhgpqqg",
"instanceName":"elb567a",
"deviceUUID":"lb-09edhgpqqg"
},
{
"instanceID":"lb-uqcj9p4o6j",
"instanceName":"elb5cad",
"deviceUUID":"lb-uqcj9p4o6j"
}
],
"totalCount":3,
"totalPage":1,
"currentCount":3,
"page":1,
"pageSize":5
},
"errorCode":"",
"message":"Success",
"msgDesc":"成功"
}
状态码
状态码 | 描述 |
---|---|
200 | 请求成功 |
错误码
errorCode | 描述 |
---|---|
其他 | 参见公共错误码说明 |