1)接口功能介绍
获取某一个后端服务器组的实例列表。
2)接口约束
后端服务器组id必须正确请求。
3)URI
GET /v1/getBackendGroupInstances。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbId | 是 | String | slbId。必填 | 5 | |
slbBackendGroupId | 是 | String | 后端服务器组id | 129 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | list | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 否 | String | 虚机用户名称 | test | |
status | 否 | String | 状态 | Running | |
weight | 否 | String | 私网IP地址 | 70 | |
ip | 否 | String | 权重 | 192.168.0.1 | |
port | 否 | String | 业务端口 | 9008 | |
slbBackendGroupBindingId | 否 | String | 后端服务器与后端服务器组绑定Id,可用于更新权重 | 12 | |
healthCheckState | 否 | String | 健康检查状态 | HEALTH_CHECK_STATE_UNNORMAL |
6)请求示例
GET https://{host}/v1/getBackendGroupInstances?slbBackendGroupId=5105&slbId=3313
7)响应示例
{
"data": [
{
"name": "i-test",
"status": "Running",
"weight": 70,
"ip": "192.168.0.1",
"port": 9008,
"slbBackendGroupBindingId": "12",
"healthCheckState": "HEALTH_CHECK_STATE_UNNORMAL"
}
],
"requestId": "e8498aa4-dcd5-49f9-8be3-f74c9856122c",
"status": {
"code": "Success",
"message": "Success"
}
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |