接口功能介绍
查看后端服务列表
接口约束
无
URI
GET /v4/elb/list-vm
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| targetGroupID | 是 | String | 后端服务组ID | xxxxx | |
| loadBalanceID | 是 | String | 负载均衡 ID | xxxx | |
| queryContent | 否 | String | 模糊查询 | query |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 | |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success | |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 | |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS | |
| returnObj | Array of Objects | 接口业务数据 | returnObj | |
| error | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetID | String | 后端服务ID | ||
| description | String | 描述 | ||
| instanceType | String | 实例类型 | ||
| instanceID | String | 实例ID | ||
| protocolPort | Integer | 协议端口 | 8000 | |
| weight | Integer | 权重 | 50 | |
| healthCheckStatus | String | IPv4的健康检查状态 | ||
| healthCheckStatusIpv6 | String | IPv6的健康检查状态 | ||
| status | String | 管理状态 |
枚举参数
无
请求示例
请求url
GET /v4/elb/list-vm?regionID=81f7728662dd11ec810800155d307d5b&targetGroupID=xxxx&loadBalanceID=xxxx
请求头header
无
请求体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"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
