负载均衡器列表
更新时间 2026-09-10 11:38:45
最近更新时间: 2026-09-10 11:38:45
接口功能介绍
获取负载均衡器列表
接口约束
无
URI
GET /v1/elb/list
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| appID | 否 | String | 应用ID，用于查询应用关联的VPC | 09db72fa-xxxx-xxxx-a1d8-24a420181216 | |
| name | 否 | String | 负载均衡名称 | my-elb | |
| regionID | 否 | String | 资源池 ID | b342b77ef26b11ecb0ac0242ac110002 | |
| resourceType | 否 | String | 资源类型：internal 内网负载均衡 / external 公网负载均衡 | internal | |
| vpcID | 否 | String | VPC ID，用于过滤指定VPC下的负载均衡 | vpc-123456 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池 ID | bb9fdb42056xxxeda1610242ac1xxxxx | |
| locale | 否 | String | 指定客户端期望的响应语言偏好，默认语言为中文 | en英文，zh-CN中文 |
请求体body参数 无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 业务状态码（800为成功，900为失败） | 800 | |
| message | String | 业务状态码为900时的错误信息; 业务状态码为800时为success, 英文 | success | |
| description | String | 业务状态码为900时的错误描述; 业务状态码为800时为成功, 中文 | 成功 | |
| error | String | 业务状态码为900时为业务细分错误码，CAE_XXXX; 业务状态码为800时省略这个字段 | CAE_5000 | |
| requestID | String | 请求ID | 5fd3e6f7-9229-4fb4-a352-0f91bfd638b1 | |
| returnObj | Object | 业务数据 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| elbList | Array of Objects | 负载均衡列表 | ElbData |
表 ElbData
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ID | String | 负载均衡ID | elb-123456 | |
| adminStatus | String | 管理状态: DOWN / ACTIVE | ACTIVE | |
| azName | String | 可用区名称 | az-1 | |
| createdTime | String | 创建时间，为UTC格式 | 2021-10-18T10:00:00Z | |
| deleteProtection | Boolean | 删除保护。开启，不开启 | false | |
| description | String | 描述 | my elb description | |
| eipInfo | Array of Objects | 弹性公网IP信息 | EipInfo | |
| ipv6Address | String | 负载均衡实例的IPv6地址 | 240e:982:daf5:3701::1 | |
| name | String | 名称 | my-elb | |
| portID | String | 负载均衡实例默认创建port ID | port-123456 | |
| privateIpAddress | String | 负载均衡实例的内网VIP | 10.0.0.10 | |
| projectID | String | 项目ID | 0 | |
| regionID | String | 区域ID | b342b77ef26b11ecb0ac0242ac110002 | |
| resourceType | String | 负载均衡类型: external / internal | internal | |
| slaName | String | 规格名称 | elb.s1.small | |
| status | String | 负载均衡状态: DOWN / ACTIVE | ACTIVE | |
| subnetID | String | 子网ID | subnet-123456 | |
| updatedTime | String | 更新时间，为UTC格式 | 2021-10-18T10:05:00Z | |
| vpcID | String | VPC ID | vpc-123456 |
表 EipInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| bandwidth | Float | 弹性公网IP的带宽 | 10 | |
| eipAddress | String | 弹性公网IP的地址 | 1.2.3.4 | |
| eipID | String | 弹性公网IP的ID | eip-123456 | |
| isTalkOrder | Boolean | 是否按需资源 | false | |
| resourceID | String | 计费类资源ID | eip-123456 |
枚举参数
无
请求示例
请求url
GET /v1/elb/list
请求头header
regionId:20000000***1852
请求体body
无
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"error": "CAE_5000",
"requestID": "5fd3e6f7-9229-4fb4-a352-0f91bfd638b1",
"returnObj": {
"elbList": [
{
"ID": "elb-123456",
"adminStatus": "ACTIVE",
"azName": "az-1",
"createdTime": "2021-10-18T10:00:00Z",
"deleteProtection": false,
"description": "my elb description",
"eipInfo": [
{
"bandwidth": 10,
"eipAddress": "1.2.3.4",
"eipID": "eip-123456",
"isTalkOrder": false,
"resourceID": "eip-123456"
}
],
"ipv6Address": "240e:982:daf5:3701::1",
"name": "my-elb",
"portID": "port-123456",
"privateIpAddress": "10.0.0.10",
"projectID": "0",
"regionID": "b342b77ef26b11ecb0ac0242ac110002",
"resourceType": "internal",
"slaName": "elb.s1.small",
"status": "ACTIVE",
"subnetID": "subnet-123456",
"updatedTime": "2021-10-18T10:05:00Z",
"vpcID": "vpc-123456"
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
