查询负载均衡器列表

project_id

是

String

参数解释：项目ID。获取方式请参见获取项目ID。

约束限制：不涉及

取值范围：长度为32个字符，由小写字母和数字组成。

默认取值：不涉及

marker

否

String

参数解释：上一页最后一条记录的ID。

约束限制：

• 必须与limit一起使用。

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

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

取值范围：不涉及

默认取值：不涉及

limit

否

Integer

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

约束限制：不涉及

取值范围：0-2000

默认取值：2000

page_reverse

否

Boolean

参数解释：是否反向查询。

约束限制：

• 必须与limit一起使用。

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

取值范围：

• true：查询上一页。

• false：查询下一页。

默认取值：false

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：停用。

默认取值：不涉及

include_recycle_bin

否

Boolean

参数解释：查询结果是否包含回收站负载均衡器

约束限制：不涉及

取值范围：

• true ：包含回收站elb。

• false：不包含回收站elb。

默认取值：不涉及

provisioning_status

否

Array of strings

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

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

provisioning_status=xxx&provisioning_status=xxx。

约束限制：不涉及

取值范围：

• ACTIVE：使用中。

• PENDING_DELETE：删除中。

默认取值：不涉及

operating_status

否

Array of strings

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

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

operating_status=xxx&operating_status=xxx。

约束限制：不涉及

取值范围：

• ONLINE：正常运行。

• FROZEN：已冻结。

默认取值：不涉及

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作为查询条件：

• publicip_address作为查询条件：

• ip_version作为查询条件：

publicips=publicip_id=xxx&publicips=publicip_id=xxx

publicips=publicip_address=xxx&publicips=publicip_address=xxx

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=xxx&enterprise_project_id=xxx。

约束限制：

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

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

取值范围：不涉及

默认取值：不涉及

ip_version

否

Array of integers

参数解释：IP版本信息。

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

ip_version=xxx&ip_version=xxx。

约束限制：不涉及

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

默认取值：不涉及

deletion_protection_enable

否

Boolean

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

约束限制：不涉及

取值范围：false 不开启，true 开启。

默认取值：不涉及

elb_virsubnet_type

否

Array of strings

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

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

elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack。

约束限制：不涉及

取值范围：

• ipv4：ipv4。

• dualstack：双栈，同时支持IPv4和IPv6的子网。

默认取值：不涉及

autoscaling

否

Array of strings

参数解释：是否开启弹性扩缩容。示例如下：

"autoscaling": {

"enable": "true"

}

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

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

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

X-Auth-Token

否

String

参数解释：IAM鉴权Token。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

loadbalancers

Array of LoadBalancer objects

参数解释：负载均衡器列表。

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。

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企业项目。

• UUID格式的字符串，表示非默认企业项目。

billing_info

String

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

取值范围：

• 空：按需计费。

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

l4_flavor_id

String

参数解释：负载均衡器4层规格ID。

若当前负载均衡器是弹性规格实例，则该字段表示4层上限规格。

取值范围：不涉及

l4_scale_flavor_id

String

参数解释：四层弹性规格ID。

取值范围：不涉及

l7_flavor_id

String

参数解释：负载均衡器7层规格ID。

若当前负载均衡器是弹性规格实例，则该字段表示7层上限规格。

取值范围：不涉及

l7_scale_flavor_id

String

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

取值范围：不涉及

gw_flavor_id

String

参数解释：网关型负载均衡器的规格ID。

取值范围：不涉及

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

loadbalancer_type

String

参数解释：负载均衡器类别。

取值范围：

• gateway 表示网关类型负载均衡器。

• null 表示其他非网关类型负载均衡器。

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

publicips

Array of PublicIpInfo objects

参数解释：负载均衡器绑定的公网IP。

global_eips

Array of GlobalEipInfo objects

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

elb_virsubnet_ids

Array of strings

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

取值范围：不涉及

elb_virsubnet_type

String

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

取值范围：

• ipv4：仅支持IPv4

• dualstack：双栈，同时支持IPv4和IPv6。

ip_target_enable

Boolean

参数解释：是否启用IP类型后端转发。

取值范围：

• true：开启。

• false：不开启。

frozen_scene

String

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

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

取值范围：

• ILLEGAL：违规冻结场景。

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

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

• ARREAR：欠费冻结场景。

deletion_protection_enable

Boolean

参数解释：是否开启删除保护。仅当前局点启用删除保护特性后才会返回该字段。

取值范围：

• false：不开启。

• true：开启。

autoscaling

AutoscalingRef object

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

public_border_group

String

参数解释：公网边界组。

取值范围：

• center：表示中心站点的公网边界组

• 边缘站点名称：表示边缘站点的公网边界组

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

charge_mode

String

参数解释：负载均衡器实例的计费模式。

取值范围：

• flavor：按规格计费。

• lcu：按使用量计费。

• 空值：若是共享型表示免费实例。若是独享型则与flavor模式一致，都是按规格计费。

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

service_lb_mode

String

参数解释：LB模式。

取值范围：

• lb：默认模式，不支持跨租户访问。

• ep：ep模式，LB支持跨租户访问。

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

instance_type

String

参数解释：标识实例归属哪个内部服务。

取值范围：不涉及

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

instance_id

String

参数解释：标识实例绑定内部服务的实例id。

取值范围：不涉及

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

proxy_protocol_extensions

Array of ProxyProtocolExtension objects

参数解释：pp扩展。

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

waf_failure_action

String

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

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

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

custom_qos_limit

CustomQosLimit object

参数解释：弹性负载均衡器的规格的自定义限速信息。

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

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

参数解释：弹性公网EIP的ID。

取值范围：不涉及

publicip_address

String

参数解释：EIP的IP地址。

取值范围：不涉及

ip_version

Integer

参数解释：IP版本信息。

取值范围：

• 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

enable

Boolean

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

取值范围：

• true：开启。

• false：不开启。

min_l7_flavor_id

String

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

取值范围：不涉及

vip_address

String

参数解释：ipv4 vip地址。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

ipv6_vip_address

String

参数解释：ipv6 vip地址。

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

extension

Extension object

参数解释：pp 扩展。

约束限制：不涉及

ep_id

String

参数解释：EP ID.

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

ep_service_id

String

参数解释：EP Service ID.

约束限制：不涉及

取值范围：不涉及

默认取值：不涉及

l4

L4Limit object

参数解释：负载均衡实例的四层规格自定义限速信息。

l7

L7Limit object

参数解释：负载均衡实例的七层规格自定义限速信息。

connection

Integer

参数解释：负载均衡实例的四层规格的最大并发连接数限速值。

取值范围：不涉及

cps

Integer

参数解释：负载均衡实例的四层规格的每秒新建连接数限速值。

取值范围：不涉及

connection

Integer

参数解释：负载均衡实例的七层规格的最大并发连接数限速值。

取值范围：不涉及

cps

Integer

参数解释：负载均衡实例的七层规格的每秒新建连接数限速值。

取值范围：不涉及

previous_marker

String

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

取值范围：不涉及

next_marker

String

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

取值范围：不涉及

current_count

Integer

参数解释：当前页返回记录数。

取值范围：不涉及

200

操作正常返回。