查看后端主机组列表
更新时间 2025-10-22 18:26:30
最近更新时间: 2025-10-22 18:26:30
接口功能介绍
查看后端主机组列表
接口约束
无
URI
GET /v4/elb/list-target-group
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一 | xxxx | |
| regionID | 是 | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| IDs | 否 | String | 后端主机组ID列表，以,分隔 | tg-75ex90k9v0,tg-r4cfhgrsss | |
| vpcID | 否 | String | vpc ID | vpc-xxx | |
| healthCheckID | 否 | String | 健康检查ID | hc-xxx | |
| name | 否 | String | 后端主机组名称 | test |
请求参数
请求头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 | |
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| regionID | String | 区域ID | 81f7728662dd11ec810800155d307d5b | |
| azName | String | 可用区名称 | az1 | |
| projectID | String | 项目ID | 0 | |
| ID | String | 后端主机组ID | tg-xxx | |
| name | String | 后端主机组名称 | test | |
| description | String | 描述 | desc | |
| vpcID | String | vpc ID | vpc-xxx | |
| healthCheckID | String | 健康检查ID | hc-xxx | |
| algorithm | String | 调度算法 | wrr | |
| sessionSticky | Object | 会话保持配置 | sessionSticky | |
| status | String | 状态: DOWN / ACTIVE | DOWN | |
| createdTime | String | 创建时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| updatedTime | String | 更新时间，为UTC格式 | 2022-10-03T09: 44: 22Z | |
| allPortForward | Integer | 全端口转发功能开关 | 0 | |
| centerHealthCheckLoadBalancerId | String | 集中式健康检查功能绑定的负载均衡ID | lb-xxxx | |
| connectionDrainEnabled | Integer | 优雅中断功能开关 | 0 | |
| connectionDrainTimeout | Integer | 优雅中断功能超时时间 | 300 | |
| protocol | String | 协议类型 | TCP | |
| proxyProtocol | Integer | 获取客户端真实源IP功能开关 | 0 | |
| 表 sessionSticky |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| sessionStickyMode | String | 会话保持模式，支持取值：CLOSE（关闭）、INSERT（插入）、REWRITE（重写 | CLOSE | |
| cookieExpire | Integer | cookie过期时间 | 121 | |
| rewriteCookieName | String | cookie重写名称 | XXX | |
| sourceIpTimeout | Integer | 源IP会话保持超时时间。 | 2222 |
枚举参数
无
请求示例
请求url
GET /openapi/v4/elb/list-target-group?regionID=81f7728662dd11ec810800155d307d5b&ID=tg-01bh5cr7gu
请求头header
无
请求体body
无
响应示例
#### 成功响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "tg-td6uhtxhso",
"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"
}
]
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
