接口约束
4.6 负载均衡器
4.6.2 查询负载均衡器列表
"elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ], "elb_virsubnet_type" : "dualstack",
"ip_target_enable" : false,
"eip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d", "eip_address" : "97.97.2.171",
"ip_version" : 4 } ],
"guaranteed" : true, "billing_info" : null,
"l4_flavor_id" : "636ba721-935a-4ca5-a685-8076ce0e4148", "l4_scale_flavor_id" : null,
201 POST操作正常返回。
错误码
● 分页查询使用的参数为marker、limit、page_reverse。
● marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。
调试
您可以在API Explorer中调试该接口。
URI
GET /v3/{project_id}/elb/loadbalancers
表4-50 路径参数
参数 是否必选 参数类型 描述
project_id 是 String 负载均衡器所在的项目ID。
最小长度：1 最大长度：255
表4-51 Query 参数
参数 是否必选 参数类型 描述
marker 否 String 上一页最后一条记录的ID。
使用说明：
● 必须与limit一起使用。
● 不指定时表示查询第一页。
● 该字段不允许为空或无效的 ID。
limit 否 Integer 每页返回的个数。
最小值：0 最大值：2000 缺省值：2000
page_reverse 否 Boolean 分页的顺序，true表示从后往前 分页，false表示从前往后分 页，默认为false。
使用说明：
● 必须与limit一起使用。
id 否 Array 负载均衡器ID。
支持多值查询，查询条件格式：
id=xxx&id=xxx。
name 否 Array 负载均衡器名称。
支持多值查询，查询条件格式：
name=xxx&name=xxx。 description 否 Array 负载均衡器的描述信息。
支持多值查询，查询条件格式：
description=xxx&description=x xx。
admin_state_
up 否 Boolean 负载均衡器的管理状态。
不支持该字段，请勿使用。
参数 是否必选 参数类型 描述 provisioning_s
tatus 否 Array 负载均衡器的配置状态。取值：
● ACTIVE：使用中。
● PENDING_DELETE：删除 中。
支持多值查询，查询条件格式：
provisioning_status=xxx&provis ioning_status=xxx。
operating_stat
us 否 Array 负载均衡器的操作状态。取值：
● ONLINE：正常运行。
● FROZEN：已冻结。
支持多值查询，查询条件格式：
operating_status=xxx&operatin g_status=xxx。
guaranteed 否 Boolean 是否独享型LB，取值：
● false：共享型
● true：独享型
vpc_id 否 Array 负载均衡器所在的VPC ID。
支持多值查询，查询条件格式：
vpc_id=xxx&vpc_id=xxx。 vip_port_id 否 Array 负载均衡器的IPv4对应的port
ID。
支持多值查询，查询条件格式：
vip_port_id=xxx&vip_port_id=x xx。
vip_address 否 Array 负载均衡器的IPv4虚拟IP地址。
支持多值查询，查询条件格式：
vip_address=xxx&vip_address=
xxx。 vip_subnet_ci
dr_id 否 Array 负载均衡器所在子网的IPv4子网
ID。
支持多值查询，查询条件格式：
vip_subnet_cidr_id=xxx&vip_su bnet_cidr_id=xxx。
ipv6_vip_port_
id 否 Array 双栈类型负载均衡器的IPv6对应
的port ID。
支持多值查询，查询条件格式：
ipv6_vip_port_id=xxx&ipv6_vip _port_id=xxx。
参数 是否必选 参数类型 描述 ipv6_vip_addr
ess 否 Array 双栈类型负载均衡器的IPv6地
址。
支持多值查询，查询条件格式：
ipv6_vip_address=xxx&ipv6_vip _address=xxx。
ipv6_vip_virsu
bnet_id 否 Array 双栈类型负载均衡器所在的子网
IPv6网络ID。
支持多值查询，查询条件格式：
ipv6_vip_virsubnet_id=xxx&ipv 6_vip_virsubnet_id=xxx。
eips 否 Array 负载均衡器绑定的EIP ID。示例
如下： "eips": [ { "eip_id":
"e9b72a9d-4275-455e-a724-853504e4d9c6",
"eip_address": "88.88.14.122",
"ip_version": 4 } ]
支持多值查询，查询条件格式：
● eip_id作为查询条件：
eips=eip_id=xxx&eips=eip_id
=xxx。
● eip_address作为查询条件：
eips=eip_address=xxx&eips=
eip_address=xxx。
● ip_version作为查询条件：
eips=ip_version=xxx&eips=i p_version=xxx。
注：该字段与publicips字段一 致。
参数 是否必选 参数类型 描述
publicips 否 Array 负载均衡器绑定的公网IP。示例 如下：
"publicips": [ { "publicip_id":
"e9b72a9d-4275-455e-a724-853504e4d9c6",
"publicip_address":
"88.88.14.122", "ip_version":
4 } ]
支持多值查询，查询条件格式：
- publicip_id作为查询条件：
publicips=publicip_id=xxx&pub licips=publicip_id=xxx。
● publicip_address作为查询条 件：publicips=publicip_address=
xxx&publicips=publicip_add ress=xxx。
● ip_version作为查询条件：
publicips=ip_version=xxx&p ublicips=ip_version=xxx。 注：该字段与eips字段一致。
availability_zo
ne_list 否 Array 负载均衡器所在可用区列表。
支持多值查询，查询条件格式：
availability_zone_list=xxx&avai lability_zone_list=xxx。
l4_flavor_id 否 Array 四层Flavor ID。
支持多值查询，查询条件格式：
l4_flavor_id=xxx&l4_flavor_id=
xxx。 l4_scale_flavo
r_id 否 Array 四层弹性Flavor ID。
支持多值查询，查询条件格式：
l4_scale_flavor_id=xxx&l4_scal e_flavor_id=xxx。
不支持该字段，请勿使用。
l7_flavor_id 否 Array 七层Flavor ID。
支持多值查询，查询条件格式：
l7_flavor_id=xxx&l7_flavor_id=
xxx。 l7_scale_flavo
r_id 否 Array 七层弹性Flavor ID。
支持多值查询，查询条件格式：
l7_scale_flavor_id=xxx&l7_scal e_flavor_id=xxx。
不支持该字段，请勿使用。
参数 是否必选 参数类型 描述
billing_info 否 Array 资源账单信息。admin权限才能 更新此字段。 er_device_id=xxx。
member_addr r_address=xxx。
enterprise_pro
ject_id 否 Array 负载均衡器所属的企业项目ID。
支持多值查询，查询条件格式：
enterprise_project_id=xxx&ent erprise_project_id=xxx。 ip_version 否 Array IP版本信息。 取值：4代表
IPv4，6代表IPv6。
支持多值查询，查询条件格式：
ip_version=xxx&ip_version=xxx
。 deletion_prot
ection_enable 否 Boolean 是否开启删除保护，false不开 启，true开启。
elb_virsubnet_
type 否 Array 下联面子网类型。取值：
● ipv4：ipv4。
● dualstack：双栈。
支持多值查询，查询条件格式：
elb_virsubnet_type=ipv4&elb_v irsubnet_type=dualstack。 autoscaling 否 Array 是否开启弹性扩缩容。示例如
下： "autoscaling": { "enable":
"true" }
支持多值查询，查询条件格式：
autoscaling=enable=true&auto scaling=enable=false。
请求参数
表4-52 请求 Header 参数
参数 是否必选 参数类型 描述
X-Auth-Token 否 String IAM鉴权Token。
响应参数
状态码： 200
表4-53 响应 Body 参数
参数 参数类型 描述
loadbalancers Array of LoadBalancer objects
Loadbalancer的列表。
page_info PageInfo
object 负载均衡器分页信息。
request_id String 请求ID。
注：自动生成 。
表4-54 LoadBalancer
参数 参数类型 描述
id String 负载均衡器ID。
description String 负载均衡器描述信息。
最小长度：1 最大长度：255 provisioning_s
tatus String 负载均衡器的配置状态。取值：
● ACTIVE：使用中。
● PENDING_DELETE：删除中。
admin_state_
up Boolean 负载均衡器的管理状态。固定为true。
provider String 负载均衡器的生产者名称。固定为vlb。
参数 参数类型 描述 pools Array of
PoolRef objects
负载均衡器直接关联的后端云服务器组的ID列 表。
listeners Array of ListenerRef objects
负载均衡器关联的监听器的ID列表。
operating_stat
us String 负载均衡器的操作状态。取值：
● ONLINE：在线。
name String 负载均衡器的名称。
project_id String 负载均衡器所属的项目ID。
vip_subnet_ci
dr_id String 负载均衡器所在子网的IPv4子网ID。
vip_address String 负载均衡器的IPv4虚拟IP地址。
vip_port_id String 负载均衡器的IPv4对应的port ID。
tags Array of Tag
objects 负载均衡的标签列表。
created_at String 负载均衡器的创建时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'
updated_at String 负载均衡器的更新时间。格式：yyyy-MM-dd'T'HH:mm:ss'Z'
guaranteed Boolean 是否独享型LB，取值：
● false：共享型。
● true：独享型。
vpc_id String 负载均衡器所在VPC ID。
eips Array of EipInfo objects
负载均衡器绑定的EIP。只支持绑定一个EIP。
注：该字段与publicips一致。
ipv6_vip_addr
ess String 双栈类型负载均衡器的IPv6地址。
ipv6_vip_virsu
bnet_id String 双栈类型负载均衡器所在子网的IPv6网络ID。
ipv6_vip_port_
id String 双栈类型负载均衡器的IPv6对应的port ID。
availability_zo
ne_list Array of
strings 负载均衡器所在的可用区列表。
enterprise_pro String 企业项目ID。
参数 参数类型 描述
billing_info String 资源账单信息，取值：
● 空：按需计费。
● 非空：包周期计费，
包周期计费billing_info字段的格式为：
order_id:product_id:region_id:project_id，如：
CS2107161019CDJZZ:OFFI56970212178976358 4:eu-de:057ef081eb00d2732fd1c01a9be75e6f 使用说明：
● admin权限才能更新此字段。
最小长度：1 最大长度：1024 l4_flavor_id String 四层Flavor ID。
hcso场景下所有LB实例共享带宽，该字段无效，
请勿使用。
最小长度：1 最大长度：255 l4_scale_flavo
r_id String 四层弹性Flavor ID。
不支持该字段，请勿使用。
最小长度：1 最大长度：255 l7_flavor_id String 七层Flavor ID。
hcso场景下所有LB实例共享带宽，该字段无效，
请勿使用。
最小长度：1 最大长度：255 l7_scale_flavo
r_id String 七层弹性Flavor ID。
不支持该字段，请勿使用。
最小长度：1 最大长度：255 publicips Array of
PublicIpInfo objects
负载均衡器绑定的公网IP。只支持绑定一个公网 IP。
注：该字段与eips一致。
参数 参数类型 描述 elb_virsubnet_
ids Array of
strings 下联面子网的网络ID列表。可以通过GET https://
{VPC_Endpoint}/v1/{project_id}/subnets 响应参 数中的id得到。
type String 下联面子网类型
● ipv4：ipv4
● dualstack：双栈 ip_target_ena
ble Boolean 是否启用跨VPC后端转发。取值：
● true：开启。
frozen_scene String 负载均衡器的冻结场景。若负载均衡器有多个冻 结场景，用逗号分隔。取值：
● POLICE：公安冻结场景。
● ILLEGAL：违规冻结场景。
● VERIFY：客户未实名认证冻结场景。
● RTNER：合作伙伴冻结（合作伙伴冻结子客户 资源）。
● REAR：欠费冻结场景。
ipv6_bandwid
th BandwidthRe
f object 带宽对象ID，仅在创建或更新公网IPv6负载均衡
器时有效。若选择创建新EIP并指定共享带宽时，
此EIP会被分进共享带宽里面。
deletion_prot
ection_enable Boolean 是否开启删除保护，取值：
● false：不开启。
参数 参数类型 描述 autoscaling AutoscalingR
ef object 弹性扩缩容配置信息。负载均衡器配置并开启弹
性扩缩容后，可根据负载情况自动调整负载均衡 器的规格。
使用说明：
● 仅当局点支持弹性扩缩特性才会返回该字段。
● 开启弹性扩缩容后，l4_flavor_id和 l7_flavor_id不再起作用。
表4-55 PoolRef
参数 参数类型 描述
id String 后端服务器组ID。
表4-56 ListenerRef
参数 参数类型 描述
id String 监听器ID。
表4-57 Tag
参数 参数类型 描述
key String 标签键
最小长度：1 最大长度：36 value String 标签值
最小长度：0 最大长度：43
表4-58 EipInfo
参数 参数类型 描述
eip_id String eip_id eip_address String eip_address
ip_version Integer IP版本号，取值：4表示IPv4,6表示IPv6。
表4-59 PublicIpInfo
参数 参数类型 描述
publicip_id String 弹性公网ip配置id publicip_addr
ess String IP地址
ip_version Integer IP版本信息。 取值：
● 4：IPv4
● 6：IPv6
表4-60 BandwidthRef
参数 参数类型 描述
id String 共享带宽的id
表4-61 AutoscalingRef
参数 参数类型 描述
enable Boolean 当前负载均衡器是否开启弹性扩缩容。 取值：
● true：开启。
● false：不开启。
缺省值：false min_l4_flavor
_id String 弹性扩缩容的最小四层规格ID，有四层监听器 时，该字段不能为空。
最小长度：1 最大长度：36 min_l7_flavor
_id String 弹性扩缩容的最小七层规格ID，有七层监听器 时，该字段不能为空。
最小长度：1 最大长度：36
表4-62 PageInfo
参数 参数类型 描述
previous_mar
ker String 分页查询结果中第一条记录的ID next_marker String 分页查询结果中最后一条记录的ID。
参数 参数类型 描述
current_count Integer 当前的记录数。
请求示例
● 分页查询负载均衡器列表
GET https://{ELB_Endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/elb/loadbalancers?
limit=2&marker=87627cb6-9ff1-4580-984f-cc564fa9fc34
● 多值查询
GET https://{ELB_Endpoint}/v3/b2782e6708b8475c993e6064bc456bf8/elb/loadbalancers?
id=87627cb6-9ff1-4580-984f-cc564fa9fc34&id=09e86f09-03fc-440e-8132-03f3e149e979
响应示例
状态码： 200 操作正常返回。
{ "request_id" : "46b7d911-cece-408c-a2cc-55c78ab025d8", "loadbalancers" : [ {
"id" : "65672f7e-2024-4c39-9198-98249da479c5", "project_id" : "057ef081eb00d2732fd1c01a9be75e6f", "name" : "dxq_2021_07_26_11_12_37",
"description" : "",
"vip_port_id" : "b289f890-a6fa-4405-a9cc-fe62b8a3bed0", "vip_address" : "172.16.0.152",
"admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ {
"id" : "dc9572eb-a5b2-47b3-a982-44892d833892"
} ], "pools" : [ {
"id" : "dc6b01c4-f704-4427-a4c2-21cd5f58d177"
} ], "tags" : [ ], "provider" : "vlb",
"created_at" : "2021-07-26T03:12:37Z", "updated_at" : "2021-07-26T03:12:37Z",
"vpc_id" : "6e0ee31f-7a46-4530-b32f-ce41f30959d4", "enterprise_project_id" : "0",
"availability_zone_list" : [ "eu-de-01" ],
"ipv6_vip_address" : "2001:db8:a583:4cb:d6b8:f8b4:4211:fe72", "ipv6_vip_virsubnet_id" : "0b9e3c5e-3ec8-46b3-bab9-80b1450e59ee", "ipv6_vip_port_id" : "5186bb47-24e5-4171-b795-62d22846db9b", "publicips" : [ ],
"elb_virsubnet_ids" : [ "0b9e3c5e-3ec8-46b3-bab9-80b1450e59ee" ], "elb_virsubnet_type" : "dualstack",
"ip_target_enable" : false, "autoscaling" : {
"l4_flavor_id" : "aa06b26b-9ff9-43c6-92b9-41e0f746bca6", "l4_scale_flavor_id" : null,
"l4_flavor_id" : "aa06b26b-9ff9-43c6-92b9-41e0f746bca6", "l4_scale_flavor_id" : null,