1)接口功能介绍
后端服务器组列表。
2)接口约束
负载均衡slbId必须存在。
3)URI
GET /v1/getBackendGroupList。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
slbId | 是 | String | 负载均衡id .可通过DescribeLoadBalancers接口获取。 | 129 | |
protocol | 否 | String | 后端协议类型 PROTOCOL_TCP,PROTOCOL_HTTP,PROTOCOL_UDP。 | PROTOCOL_HTTP |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
backendGroups | 是 | List | * | 获取可用主机IP响应数据列表 | backendGroups |
表 backendGroups
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 服务器组名称 | server-group-0s35 | |
uuid | 是 | String | 服务器组uuid | 730cbde0-94e3-48ae-9950-5c94e87df1e8 | |
backendGroupId | 是 | String | 后端服务器组id | 204 | |
protocol | 是 | String | 后端协议 | PROTOCOL_HTTP | |
listenerName | 是 | String | 监听器名称 | listener-5bis | |
listenerUuid | 是 | String | 监听器uuid,跳转带参数用。 | 273e437a-c69b-4976-aa08-b59f6a1390d4 | |
listenerId | 是 | String | 监听器id | 141 | |
balancePolicy | 是 | String | 负载均衡策略 | BALANCE_POLICY_ROUND_ROBIN | |
enableHealthCheck | 是 | String | 是否启用健康检查 | true | |
enableSessionPersistence | 是 | String | 是否启用会话保持 | true | |
description | 是 | String | 描述 | test backend-group for ecx | |
vms | 是 | Object | 后端服务器列表 | * | vms |
sessionPersistenceTimeout | 是 | String | 会话保持时间 | 30 | |
cookieName | 是 | String | cookie名称 | my-test-cookie | |
healthCheckPort | 是 | Integer | 健康检查端口 | 4567 | |
healthCheckDomain | 是 | String | 健康检查域名 | ||
sessionPersistenceType | 是 | String | 会话保持类型 | SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE |
表 vms
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
name | 是 | String | 虚机名称 | evm-t5og | |
status | 是 | String | 虚机状态 | Running | |
ip | 是 | String | 虚机私网IP地址 | 100.64.0.67 | |
weight | 是 | String | 虚机负载均衡权重 | 100 | |
port | 是 | String | 虚机业务端口 | 8001 | |
slbBackendGroupBindingId | 是 | String | 虚机与后端服务器组绑定Id | 230 | |
healthCheckState | 是 | String | 健康检查状态 | HEALTH_CHECK_STATE_CHECKING |
6)请求示例
GET https://{host}/v1/getBackendGroupList?slbId=3190
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"backendGroups": [
{
"protocol": "PROTOCOL_UDP",
"listenerUuid": "dcefee92-ccdd-4654-bc87-ff82a461c832",
"balancePolicy": "BALANCE_POLICY_ROUND_ROBIN",
"enableHealthCheck": false,
"description": "",
"sessionPersistenceTimeout": 5,
"backendGroupId": "5161",
"uuid": "8ed5b507-ac97-49ee-a1b5-f1abc64f770a",
"listenerId": "5079",
"enableSessionPersistence": true,
"listenerName": "slb-twst",
"sessionPersistenceType": "SESSION_PERSISTENCE_TYPE_SOURCE_IP_COOKIE",
"cookieName": "cookie-name-b61b",
"healthCheckPort": 0,
"healthCheckDomain": "",
"vms": [],
"name": "server-group-1hau"
},
{
"protocol": "PROTOCOL_HTTP",
"listenerUuid": "",
"balancePolicy": "BALANCE_POLICY_ROUND_ROBIN",
"enableHealthCheck": true,
"description": "test",
"sessionPersistenceTimeout": 66,
"backendGroupId": "5150",
"uuid": "da991c15-919a-4f7a-9e5f-332c5770c7b6",
"listenerId": "0",
"enableSessionPersistence": true,
"listenerName": "",
"sessionPersistenceType": "SESSION_PERSISTENCE_TYPE_APPLICATION_COOKIE",
"cookieName": "cookie-name-av6i",
"healthCheckPort": 66,
"healthCheckDomain": "",
"vms": [
{
"status": "Running",
"name": "evm-7qdg",
"weight": 99,
"slbBackendGroupBindingId": "5834",
"ip": "10.0.0.4",
"healthCheckState": "HEALTH_CHECK_STATE_CHECKING",
"port": 222
},
{
"status": "Running",
"name": "evm-7qbg",
"weight": 95,
"slbBackendGroupBindingId": "5917",
"ip": "10.0.0.2",
"healthCheckState": "HEALTH_CHECK_STATE_CHECKING",
"port": 344
}
],
"name": "test-勿删-勿删"
}
]
},
"requestId": "6553eaab-5610-43c1-b094-8475cbb1932f"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |