接口功能介绍
查看负载均衡实例
接口约束
无
URI
GET /v4/elb/show-loadbalancer
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionID | 是 | String | 区域ID | ||
| ID | 否 | String | 负载均衡ID, 该字段后续废弃 | ||
| elbID | 是 | String | 负载均衡ID, 推荐使用该字段 |
请求参数
请求头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 | 可用区名称 | ||
| ID | String | 负载均衡ID | ||
| projectID | String | 项目ID | ||
| name | String | 名称 | ||
| description | String | 描述 | ||
| vpcID | String | VPC ID | ||
| subnetID | String | 子网ID | ||
| portID | String | 负载均衡实例默认创建port ID | ||
| privateIpAddress | String | 负载均衡实例的内网VIP | ||
| ipv6Address | String | 负载均衡实例的IPv6地址 | ||
| slaName | String | 规格名称 | ||
| eipInfo | Array of Objects | 弹性公网IP信息 | eipInfo | |
| deleteProtection | Boolean | 删除保护。开启，不开启 | ||
| adminStatus | String | 管理状态: DOWN / ACTIVE | ||
| status | String | 负载均衡状态: DOWN / ACTIVE | ||
| resourceType | String | 负载均衡类型: external / internal | ||
| createdTime | String | 创建时间，为UTC格式 | ||
| updatedTime | String | 更新时间，为UTC格式 |
表 eipInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceID | String | 计费类资源ID | ||
| eipID | String | 弹性公网IP的ID | ||
| bandwidth | Integer | 弹性公网IP的带宽 | 1 | |
| isTalkOrder | Boolean | 是否按需资源 |
枚举参数
无
请求示例
请求url
GET /v4/elb/show-loadbalancer?regionID=81f7728662dd11ec810800155d307d5b&ID=lb-xxx
请求头header
无
请求体body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"regionID": "73f321ea-62ff-11ec-a8bc-005056898fe0",
"azName": null,
"projectID": "0",
"ID": "lb-ai7x5ulq4t",
"name": "yacos_lb_test_ipv4",
"description": "yacos_lb_test_ipv4",
"vpcID": "vpc-krd9nz9wsc",
"subnetID": "subnet-mr9j7i1rnr",
"portID": "port-t6gm5lbphw",
"privateIpAddress": "10.0.0.20",
"ipv6Address": "",
"eipInfo": [
{
"resourceID": "04be13e8826046d4ab20d233a5e2c349",
"eipID": "eip-poxi4vls1v",
"eipAddress": "100.124.1.40",
"bandwidth": 100,
"isTalkOrder": false
}
],
"slaName": "elb.s1.small",
"deleteProtection": false,
"adminStatus": "ACTIVE",
"status": "ACTIVE",
"resourceType": "external",
"createdTime": "2022-09-28T07: 27: 31Z",
"updatedTime": "2022-09-28T07: 27: 31Z"
}
]
}
状态码
请参考 状态码
错误码
请参考 错误码
