接口功能介绍
查看后端服务组列表
接口约束
当前接口使用前使用资源池概况信息查询接口查询待对接的资源池信息，如资源池概况信息查询结果为"regionVersion":"v3.0",即可使用；如资源池概况信息结果为"regionVersion":"v4.0",请使用API内接口查看后端服务组列表。
URI
GET /v4/elb/list-vm-pool
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 区域ID | 81f7728662dd11ec810800155d307d5b |
| targetGroupID | String | 否 | 后端服务组ID | edbe1a3e-bac3-48a5-9357-d9239d7d1577 |
| name | String | 否 | 后端服务组名称 | yacos_test_target_group3 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息，英文 | success |
| descritption | String | statusCode为800时的错误信息，中文 | |
| errorCode | String | 错误明细 | SUCCESS |
| returnObj | Array of Objects | 接口业务数据 |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| regionID | String | 区域ID | |
| azName | String | 可用区名称, 默认为 null | null |
| projectID | String | 项目ID | |
| ID | String | 后端服务组ID | |
| name | String | 后端服务组名称 | |
| description | String | 描述 | |
| vpcID | String | vpc ID, 默认为 null | null |
| healthCheckID | String | 健康检查ID | |
| algorithm | String | 调度算法 | |
| sessionSticty | object | 会话保持配置 | |
| status | String | 状态 | |
| createdTime | String | 创建时间，为UTC格式 | |
| updatedTime | String | 更新时间，为UTC格式, 默认为 null | null |
表 sessionSticty
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| sessionStictyMode | String | 会话保持模式 | |
| cookieExpire | Integer | cookie过期时间 | |
| rewriteCookieName | String | cookie重写名称 | |
| sourceIpTimeout | Integer | 源IP会话保持超时时间。 |
请求示例
GET /v4/elb/list-vm-pool?regionID=81f7728662dd11ec810800155d307d5b
请求体body
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "edbe1a3e-bac3-48a5-9357-d9239d7d1577",
"name": "yacos_test_target_group3",
"description": "yacos_test3",
"vpcID": "vpc-mv4gqflr2x",
"healthCheckID": "",
"algorithm": "lc",
"sessionSticky": {
"sessionStickyMode": "CLOSE",
"cookieExpire": 0,
"rewriteCookieName": "",
"sourceIpTimeout": 0
},
"status": "ACTIVE",
"createdTime": "2022-09-28T07:37:38Z",
"updatedTime": "2022-09-28T07:37:38Z"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
