查询负载均衡器列表

project_id

是

String

负载均衡器所在的项目ID。

marker

否

String

上一页最后一条记录的ID。

使用说明：

• 必须与limit一起使用。

• 不指定时表示查询第一页。

• 该字段不允许为空或无效的ID。

limit

否

Integer

参数解释：每页返回的个数。

取值范围：0-2000

默认取值：2000

page_reverse

否

Boolean

是否反向查询。

取值：

• true：查询上一页。

• false：查询下一页，默认。

使用说明：

• 必须与limit一起使用。

• 当page_reverse=true时，若要查询上一页，marker取值为当前页返回值的previous_marker。

id

否

Array of strings

负载均衡器ID。

支持多值查询，查询条件格式：id=xxx&id=xxx。

name

否

Array of strings

负载均衡器名称。

支持多值查询，查询条件格式：name=xxx&name=xxx。

description

否

Array of strings

负载均衡器的描述信息。

支持多值查询，查询条件格式：description=xxx&description=xxx。

admin_state_up

否

Boolean

参数解释：负载均衡器的启用状态。

取值范围：

• true ：启用。

• false：停用。

provisioning_status

否

Array of strings

负载均衡器的配置状态。

取值：

• ACTIVE：使用中。

• PENDING_DELETE：删除中。

支持多值查询，查询条件格式：provisioning_status=xxx&provisioning_status=xxx。

operating_status

否

Array of strings

负载均衡器的操作状态。

取值：

• ONLINE：正常运行。

• FROZEN：已冻结。

支持多值查询，查询条件格式：operating_status=xxx&operating_status=xxx。

guaranteed

否

Boolean

是否独享型LB。

取值：

• false：共享型

• true：独享型

vpc_id

否

Array of strings

负载均衡器所在的VPC ID。

支持多值查询，查询条件格式：vpc_id=xxx&vpc_id=xxx。

vip_port_id

否

Array of strings

负载均衡器的IPv4对应的port ID。

支持多值查询，查询条件格式：vip_port_id=xxx&vip_port_id=xxx。

vip_address

否

Array of strings

负载均衡器的IPv4虚拟IP地址。

支持多值查询，查询条件格式：vip_address=xxx&vip_address=xxx。

vip_subnet_cidr_id

否

Array of strings

负载均衡器所在子网的IPv4子网ID，也称为该负载均衡器实例的前端子网。

支持多值查询，查询条件格式：vip_subnet_cidr_id=xxx&vip_subnet_cidr_id=xxx。

ipv6_vip_port_id

否

Array of strings

双栈类型负载均衡器的IPv6对应的port ID。

支持多值查询，查询条件格式：ipv6_vip_port_id=xxx&ipv6_vip_port_id=xxx。

ipv6_vip_address

否

Array of strings

双栈类型负载均衡器的IPv6地址。

支持多值查询，查询条件格式：ipv6_vip_address=xxx&ipv6_vip_address=xxx。

ipv6_vip_virsubnet_id

否

Array of strings

双栈类型负载均衡器所在的子网IPv6网络ID，也称为该负载均衡器实例的前端子网。

支持多值查询，查询条件格式：ipv6_vip_virsubnet_id=xxx&ipv6_vip_virsubnet_id=xxx。

eips

否

Array of strings

负载均衡器绑定的EIP。例如要查询绑定以下EIP的LB：

"eips": [

{

"eip_id": "e9b72a9d-4275-455e-a724-853504e4d9c6",

"eip_address": "88.88.14.122",

"ip_version": 4

}

]

可以通如下查询：

eips=ip_version%3D4&eips=eip_address%3D88.88.14.122&eips=eip_id%3De9b72a9d-4275-455e-a724-853504e4d9c6

支持多值查询，查询条件格式：

• 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=ip_version=xxx。

注：该字段与publicips字段一致。

publicips

否

Array of strings

负载均衡器绑定的公网IP。例如要查询绑定以下公网IP的LB：

"publicips=": [

{

"public_id": "e9b72a9d-4275-455e-a724-853504e4d9c6",

"public_address": "88.88.14.122",

"ip_version": 4

}

]

可以通如下查询：

publicips=ip_version%3D4&publicips=public_address%3D88.88.14.122&publicips=public_id%3De9b72a9d-4275-455e-a724-853504e4d9c6

支持多值查询，查询条件格式：

• publicip_id作为查询条件：

  publicips=publicip_id=xxx&publicips=publicip_id=xxx

• publicip_address作为查询条件：

  publicips=publicip_address=xxx&publicips=publicip_address=xxx

• ip_version作为查询条件：

  publicips=ip_version=xxx&publicips=ip_version=xxx

注：该字段与eips字段一致。

availability_zone_list

否

Array of strings

负载均衡器所在可用区列表。

支持多值查询，查询条件格式：

availability_zone_list=xxx&availability_zone_list=xxx。

l4_flavor_id

否

Array of strings

网络型规格ID。

支持多值查询，查询条件格式：l4_flavor_id=xxx&l4_flavor_id=xxx。

l4_scale_flavor_id

否

Array of strings

四层弹性Flavor ID。

支持多值查询，查询条件格式：l4_scale_flavor_id=xxx&l4_scale_flavor_id=xxx。

不支持该字段，请勿使用。

l7_flavor_id

否

Array of strings

应用型规格ID。

支持多值查询，查询条件格式：l7_flavor_id=xxx&l7_flavor_id=xxx。

l7_scale_flavor_id

否

Array of strings

七层弹性Flavor ID。

支持多值查询，查询条件格式：l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx。

不支持该字段，请勿使用。

member_device_id

否

Array of strings

负载均衡器中的后端服务器对应的弹性云服务器的ID。仅用于查询条件，不作为响应参数字段。

支持多值查询，查询条件格式：member_device_id=xxx&member_device_id=xxx。

member_address

否

Array of strings

负载均衡器中的后端服务器对应的弹性云服务器的IP地址。仅用于查询条件，不作为响应参数字段。

支持多值查询，查询条件格式：member_address=xxx&member_address=xxx。

enterprise_project_id

否

Array of strings

参数解释：负载均衡器所属的企业项目ID。

如果enterprise_project_id不传值，默认查询所有企业项目下的资源，鉴权按照细粒度权限鉴权，必须在用户组下分配elb:loadbalancers:list权限。

如果enterprise_project_id传值，鉴权按照企业项目权限鉴权，分为传入具体eps_id和all_granted_eps两种场景，前者查询指定eps_id的eps下的资源，后者查询的是所有有list权限的eps下的资源。

支持多值查询，查询条件格式：

enterprise_project_id=xxx&enterprise_project_id=xxx。

ip_version

否

Array of integers

IP版本信息。

取值：4代表IPv4，6代表IPv6。

支持多值查询，查询条件格式：ip_version=xxx&ip_version=xxx。

deletion_protection_enable

否

Boolean

是否开启删除保护，false不开启，true开启。

elb_virsubnet_type

否

Array of strings

下联面子网类型。

取值：

• ipv4：ipv4。

• dualstack：双栈。

支持多值查询，查询条件格式：

elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack。

autoscaling

否

Array of strings

是否开启弹性扩缩容。示例如下：

"autoscaling": {

"enable": "true"

}

支持多值查询，查询条件格式：

autoscaling=enable=true&autoscaling=enable=false。

X-Auth-Token

否

String

参数解释：IAM鉴权Token。

loadbalancers

Array of LoadBalancer objects

Loadbalancer的列表。

page_info

PageInfo object

负载均衡器分页信息。

request_id

String

请求ID。

注：自动生成 。

id

String

参数解释：负载均衡器ID。

description

String

参数解释：负载均衡器描述信息。

provisioning_status

String

参数解释：负载均衡器的配置状态。

取值范围：

• ACTIVE：使用中。

• PENDING_DELETE：删除中。

admin_state_up

Boolean

参数解释：负载均衡器的启用状态。

取值范围：

• true ：启用。

• false：停用。

provider

String

参数解释：负载均衡器的生产者名称。固定为vlb。

pools

Array of PoolRef objects

参数解释：负载均衡器直接关联的后端服务器组的ID列表。

listeners

Array of ListenerRef objects

参数解释：负载均衡器关联的监听器的ID列表。

operating_status

String

参数解释：负载均衡器的操作状态。

取值范围：

• ONLINE：在线。

• FROZEN：已冻结。

name

String

参数解释：负载均衡器的名称。

project_id

String

参数解释：负载均衡器所属的项目ID。

vip_subnet_cidr_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_address

String

参数解释：双栈类型负载均衡器的IPv6地址。

ipv6_vip_virsubnet_id

String

参数解释：双栈类型负载均衡器所在子网的IPv6网络ID，也称为该负载均衡器实例的前端子网。

ipv6_vip_port_id

String

参数解释：双栈类型负载均衡器的IPv6对应的port ID。

availability_zone_list

Array of strings

参数解释：负载均衡器所在的可用区列表。

enterprise_project_id

String

参数解释：企业项目ID。创建时不传则返回"0"，表示资源属于default企业项目。

注意："0"并不是真实存在的企业项目ID，在创建、更新和查询时不能作为请求参数传入。

billing_info

String

参数解释：资源账单信息。

取值范围：

• 空：按需计费。

• 非空：包周期计费，格式为：order_id:product_id:region_id:project_id。如：CS2107161019CDJZZ:OFFI569702121789763584:az1:057ef081eb00d2732fd1c01a9be75e6f

l4_flavor_id

String

参数解释：网络型规格ID。

对于弹性扩缩容实例，表示上限规格。

约束限制：

• 当传入的规格类型为L4，表示该实例为固定规格实例，按规格计费；

• 当传入的规格类型为L4_elastic_max，表示该实例为弹性实例，按LCU计费

l4_scale_flavor_id

String

参数解释：四层弹性Flavor ID。

不支持该字段，请勿使用。

l7_flavor_id

String

参数解释：应用型ID。

对于弹性扩缩容实例，表示上限规格ID。

约束限制：

• 当传入的规格类型为L7，表示该实例为固定规格实例，按规格计费；

• 当传入的规格类型为L7_elastic_max，表示该实例为弹性实例，按LCU计费

l7_scale_flavor_id

String

参数解释：七层弹性Flavor ID。

不支持该字段，请勿使用。

publicips

Array of PublicIpInfo objects

参数解释：负载均衡器绑定的公网IP。只支持绑定一个公网IP。

注：该字段与eips一致。

global_eips

Array of GlobalEipInfo objects

参数解释：负载均衡器绑定的global eip。

约束限制：只支持绑定一个globaleip。

elb_virsubnet_ids

Array of strings

参数解释：下联面子网的网络ID列表。

elb_virsubnet_type

String

参数解释：下联面子网类型。

取值范围：

• ipv4：ipv4

• dualstack：双栈

ip_target_enable

Boolean

参数解释：是否启用跨VPC后端转发。

开启跨VPC后端转发后，后端服务器组不仅支持添加云上VPC内的服务器，还支持添加其他VPC、其他公有云、云下数据中心的服务器。

约束限制：

• 开启后不能关闭。

• 使用共享VPC的实例使用此特性时，需确保共享资源所有者已开通VPC对等连接，否则通信异常。

• 仅独享型负载均衡器支持该特性。

取值范围：

• true：开启。

• false：不开启。

frozen_scene

String

参数解释：负载均衡器的冻结场景。

若负载均衡器有多个冻结场景，用逗号分隔。

取值范围：

• POLICE：公安冻结场景。

• ILLEGAL：违规冻结场景。

• VERIFY：客户未实名认证冻结场景。

• PARTNER：合作伙伴冻结（合作伙伴冻结子客户资源）。

• AREAR：欠费冻结场景。

ipv6_bandwidth

BandwidthRef object

参数解释：带宽对象ID。

约束限制：

• 仅在创建或更新公网IPv6负载均衡器时有效。

• 若选择创建新EIP并指定共享带宽时，此EIP会被分进共享带宽里面。

deletion_protection_enable

Boolean

参数解释：是否开启删除保护。

约束限制：

• 仅当前局点启用删除保护特性后才会返回该字段。

• 退场时需要先关闭所有资源的删除保护开关。

取值范围：

• false：不开启。

• true：开启。

autoscaling

AutoscalingRef object

参数解释：弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后，可根据负载情况自动调整负载均衡器的规格。

约束限制：

• 仅当项目白名单放开后该字段才有效

• 开启弹性扩缩容后，l4_flavor_id和l7_flavor_id表示该LB实例弹性规格的上限。

public_border_group

String

参数解释：LB所属AZ组。

waf_failure_action

String

参数解释：WAF故障时的流量处理策略。

约束限制：只有绑定了waf的LB实例，该字段才会生效。

取值范围：discard:丢弃，forward: 转发到后端。

默认取值：forward

id

String

参数解释：后端服务器组ID。

id

String

参数解释：监听器ID。

key

String

参数解释：标签键

value

String

参数解释：标签值

eip_id

String

参数解释：弹性IP的ID。

eip_address

String

参数解释：弹性IP的IP地址。

ip_version

Integer

参数解释：IP版本号。

取值范围：

• 4表示IPv4。

• 6表示IPv6。

publicip_id

String

参数解释：弹性公网ip配置id

publicip_address

String

参数解释：IP地址

ip_version

Integer

参数解释：IP版本信息。

取值范围：4和6 4：IPv4 6：IPv6

global_eip_id

String

参数解释：global eip的id

global_eip_address

String

参数解释：global eip的ip地址

ip_version

Integer

参数解释：IP版本信息。

取值范围：

• 4，表示IPv4

• 6，表示IPv6

id

String

参数解释：共享带宽的ID。

enable

Boolean

参数解释：当前负载均衡器是否开启弹性扩缩容。

取值范围：

• true：开启。

• false：不开启。

默认取值：false

min_l7_flavor_id

String

参数解释：弹性扩缩容的最小七层规格ID（规格类型L7_elastic）。

约束限制：有七层监听器时，该字段不能为空。

previous_marker

String

参数解释：分页查询结果中第一条记录的ID。通常用于配合page_reverse=true查询上一页。

next_marker

String

参数解释：分页查询结果中最后一条记录的ID。通常用于查询下一页。

current_count

Integer

参数解释：当前的记录数。

200

操作正常返回。