gwlb查看target列表
更新时间 2026-05-26 15:49:35
最近更新时间: 2026-05-26 15:49:35
接口功能介绍
查看target列表
接口约束
无
URI
GET /v4/gwlb/list-target
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 资源池 ID | bb9fdb42056f11eda1610242ac110002 | |
| targetGroupID | 是 | String | 后端服务组 ID | tg-xxx | |
| targetID | 否 | String | 后端服务 ID | target-xxx | |
| pageNumber | 否 | Integer | 列表的页码，默认值为 1。 | 1 | |
| pageSize | 否 | Integer | 分页查询时每页的行数，最大值为 50，默认值为 10。 | 10 |
请求参数
请求头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 | Object | 接口业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| results | Array of Objects | 接口业务数据 | results | |
| totalCount | Integer | 列表条目数 | 1 | |
| currentCount | Integer | 分页查询时每页的行数。 | 1 | |
| totalPage | Integer | 总页数 | 1 |
表 results
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| targetID | String | 后端服务ID | target-xxxx | |
| targetGroupID | String | 后端服务组ID | tg-xxxx | |
| instanceType | String | 实例类型，取值有: VM / BMS/ CBM | VM | |
| instanceID | String | 实例 ID | x-x-x-x- | |
| instanceVpc | String | 实例所在的 vpc | vpc-xxxx | |
| weight | Integer | 权重 | 1 | |
| healthCheckStatus | String | ipv4 健康检查状态，取值: unknown / online / offline | online | |
| healthCheckStatusIpv6 | String | ipv6 健康检查状态，取值: unknown / online / offline | online | |
| createdAt | String | 创建时间 | 2023-12-18 10:00:00 | |
| updatedAt | String | 更新时间 | 2023-12-18 10:00:00 |
枚举参数
无
请求示例
请求url
GET /openapi/v4/gwlb/list-target?regionID=xxx&targetGroupID=xxxx
请求头header
无
请求体body
无
响应示例
#### 成功响应示例
{
"statusCode":800,
"errorCode":"SUCCESS",
"message":"success",
"description": "成功",
"returnObj":{
"results": [{
"targetID": "target-xxx",
"targetGroupID": "tg-xxx",
"instanceType": "VM",
"instanceID": "xxxxx-xxx-xxx-xx",
"instanceVpc": "vpc-xxx",
"weight": 1,
"healthCheckStatus": "online",
"healthCheckStatusIpv6": "online",
"createdAt": "2024-01-08 11:00:00",
"updatedAt": "2024-01-08 11:00:00"
}],
"currentCount": 1,
"totalCount": 1,
"totalPage": 1
}
}
#### 失败响应示例
{
"statusCode": 900,
"message": "request param error",
"description": "参数错误",
"errorCode": "Openapi.Parameter.Error"
}
状态码
请参考 状态码
错误码
请参考 错误码
