弹性负载均衡 ELB-查询负载均衡器列表:URI

时间:2023-12-14 10:47:19

URI

GET /v3/{project_id}/elb/loadbalancers

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

最小长度:1

最大长度:255

表2 Query参数

参数

是否必选

参数类型

描述

marker

String

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

使用说明:

  • 必须与limit一起使用。

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

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

limit

Integer

每页返回的个数。

最小值:0

最大值:2000

缺省值:2000

page_reverse

Boolean

是否反向查询。

取值:

  • true:查询上一页。

  • false:查询下一页,默认。

使用说明:

  • 必须与limit一起使用。

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

id

Array

负载均衡器ID。

支持多值查询,查询条件格式:id=xxx&id=xxx

name

Array

负载均衡器名称。

支持多值查询,查询条件格式:name=xxx&name=xxx

description

Array

负载均衡器的描述信息。

支持多值查询,查询条件格式:description=xxx&description=xxx

admin_state_up

Boolean

负载均衡器的管理状态。

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

provisioning_status

Array

负载均衡器的配置状态。

取值:

  • ACTIVE:使用中。

  • PENDING_DELETE:删除中。

支持多值查询,查询条件格式:provisioning_status=xxx&provisioning_status=xxx

operating_status

Array

负载均衡器的操作状态。

取值:

  • ONLINE:正常运行。

  • FROZEN:已冻结。

支持多值查询,查询条件格式:operating_status=xxx&operating_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=xxx

vip_address

Array

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

支持多值查询,查询条件格式:vip_address=xxx&vip_address=xxx

vip_subnet_cidr_id

Array

负载均衡器所在子网的IPv4子网ID。

支持多值查询,查询条件格式:vip_subnet_cidr_id=xxx&vip_subnet_cidr_id=xxx

ipv6_vip_port_id

Array

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

支持多值查询,查询条件格式:ipv6_vip_port_id=xxx&ipv6_vip_port_id=xxx

ipv6_vip_address

Array

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

支持多值查询,查询条件格式:ipv6_vip_address=xxx&ipv6_vip_address=xxx

ipv6_vip_virsubnet_id

Array

双栈类型负载均衡器所在的子网IPv6网络ID。

支持多值查询,查询条件格式:ipv6_vip_virsubnet_id=xxx&ipv6_vip_virsubnet_id=xxx

eips

Array

负载均衡器绑定的EIP。示例如下: "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=ip_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&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

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

支持多值查询,查询条件格式: availability_zone_list=xxx&availability_zone_list=xxx

l4_flavor_id

Array

四层Flavor ID。

支持多值查询,查询条件格式:l4_flavor_id=xxx&l4_flavor_id=xxx

l4_scale_flavor_id

Array

四层弹性Flavor ID。

支持多值查询,查询条件格式:l4_scale_flavor_id=xxx&l4_scale_flavor_id=xxx

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

l7_flavor_id

Array

七层Flavor ID。

支持多值查询,查询条件格式:l7_flavor_id=xxx&l7_flavor_id=xxx

l7_scale_flavor_id

Array

七层弹性Flavor ID。

支持多值查询,查询条件格式:l7_scale_flavor_id=xxx&l7_scale_flavor_id=xxx

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

billing_info

Array

资源账单信息。

支持多值查询,查询条件格式:billing_info=xxx&billing_info=xxx

member_device_id

Array

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

支持多值查询,查询条件格式:member_device_id=xxx&member_device_id=xxx

member_address

Array

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

支持多值查询,查询条件格式:member_address=xxx&member_address=xxx

enterprise_project_id

Array

负载均衡器所属的企业项目ID。 查询时若不传,则查询default企业项目下的资源,鉴权按照default企业项目鉴权。 如果传值,则必须传已存在的企业项目ID(不可为"0")或传all_granted_eps表示查询所有企业项目。

支持多值查询,查询条件格式: enterprise_project_id=xxx&enterprise_project_id=xxx

ip_version

Array

IP版本信息。

取值:4代表IPv4,6代表IPv6。

支持多值查询,查询条件格式:ip_version=xxx&ip_version=xxx

deletion_protection_enable

Boolean

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

elb_virsubnet_type

Array

下联面子网类型。

取值:

  • ipv4:ipv4。

  • dualstack:双栈。

支持多值查询,查询条件格式: elb_virsubnet_type=ipv4&elb_virsubnet_type=dualstack

autoscaling

Array

是否开启弹性扩缩容。示例如下: "autoscaling": { "enable": "true" }

支持多值查询,查询条件格式:

autoscaling=enable=true&autoscaling=enable=false

protection_status

Array

修改保护状态, 取值:

  • nonProtection: 不保护,默认值为nonProtection

  • consoleProtection: 控制台修改保护

global_eips

Array

负载均衡器绑定的公网IP。示例如下:

{ "global_eips": [ { "global_eip_id": "24000000-0000-0000-0000-100000000001", "global_eip_address": "10.10.10.10", "ip_version": 4 } ] }

支持多值查询,查询条件格式:

  • global_eip_id作为查询条件:global_eips=global_eip_id=xxx&global_eips=global_eip_id=xxx

  • global_eip_address作为查询条件:global_eips=global_eip_address=xxx&global_eips=global_eip_address=xxx

  • ip_version作为查询条件:global_eips=ip_version=xxx&global_eips=ip_version=xxx

log_topic_id

String

LB实例绑定的logtank的topic id信息,支持多值查询,查询条件格式:log_topic_id=xxx&log_topic_id=xxx

log_group_id

String

LB实例绑定的logtank的group id信息,支持多值查询,查询条件格式:log_group_id=xxx&log_group_id=xxx

support.huaweicloud.com/api-elb/ListLoadBalancers.html