接口功能介绍
查看后端服务列表
接口约束
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息,如资源池概况信息查询结果为"regionVersion":"v3.0",即可使用;如资源池概况信息结果为"regionVersion":"v4.0",请使用API内接口查看后端服务列表。
URI
GET /v4/elb/list-vm
请求参数
Query 参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
regionID | String | 是 | 区域ID | 81f7728662dd11ec810800155d307d5b |
targetGroupID | String | 是 | 后端服务组ID | xxxxx |
loadBalanceID | String | 是 | 负载均衡 ID | xxxx |
queryContent | String | 否 | 模糊查询 | query |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息,英文 | success |
descritption | String | statusCode为800时的错误信息,中文 | |
errorCode | String | 错误明细 | SUCCESS |
returnObj | Array of Objects | 接口业务数据 |
表 returnObj
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
targetID | String | 后端服务ID | |
description | String | 描述 | |
instanceType | String | 实例类型 | |
instanceID | String | 实例ID | |
protocolPort | Integer | 协议端口 | |
weight | Integer | 权重 | |
healthCheckStatus | String | IPv4的健康检查状态 | |
healthCheckStatusIpv6 | String | IPv6的健康检查状态 | |
status | String | 管理状态 |
请求示例
GET /v4/elb/list-vm?regionID=81f7728662dd11ec810800155d307d5b&targetGroupID=xxxx&loadBalanceID=xxxx
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [
{
"targetID": "target-cjh730fhyz",
"description": "yacos_update",
"instanceType": "VM",
"instanceID": "7c7490ef-7ef4-1df2-f8c9-af1ba6565de5",
"protocolPort": 8000,
"weight": 50,
"healthCheckStatus": "unknown",
"healthCheckStatusIpv6": "unknown",
"status": "ACTIVE",
}
]
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。