接口功能介绍
查看后端服务详情
接口约束
无
URI
GET /v4/elb/show-target
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionID | 是 | String | 区域ID | ||
ID | 否 | String | 后端服务ID, 该字段后续废弃 | ||
targetID | 是 | String | 后端服务ID, 推荐使用该字段, 当同时使用 ID 和 targetID 时,优先使用 targetID |
请求参数
请求头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 | |
error | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
regionID | String | 区域ID | ||
azName | String | 可用区名称 | ||
projectID | String | 项目ID | ||
ID | String | 后端服务ID | ||
targetGroupID | String | 后端服务组ID | ||
description | String | 描述 | ||
instanceType | String | 实例类型: VM / BM | ||
instanceID | String | 实例ID | ||
protocolPort | Integer | 协议端口 | 8000 | |
weight | Integer | 权重 | 50 | |
healthCheckStatus | String | IPv4的健康检查状态: offline / online / unknown | ||
healthCheckStatusIpv6 | String | IPv6的健康检查状态: offline / online / unknown | ||
status | String | 状态: DOWN / ACTIVE | ||
createdTime | String | 创建时间,为UTC格式 | ||
updatedTime | String | 更新时间,为UTC格式 |
枚举参数
无
请求示例
请求url
GET /v4/elb/show-target?regionID=81f7728662dd11ec810800155d307d5b&targetID=target-xxxx
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "81f7728662dd11ec810800155d307d5b",
"azName": null,
"projectID": "0",
"ID": "target-cjh730fhyz",
"targetGroupID": "tg-a0b3nix40g",
"description": "yacos_update",
"instanceType": "VM",
"instanceID": "7c7490ef-7ef4-1df2-f8c9-af1ba6565de5",
"protocolPort": 8000,
"weight": 50,
"healthCheckStatus": "unknown",
"healthCheckStatusIpv6": "unknown",
"status": "ACTIVE",
"createdTime": "2022-10-01T06: 16: 18Z",
"updatedTime": "2022-10-01T06: 19: 35Z"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码