文档首页/ 弹性负载均衡 ELB/ API参考（安卡拉区域）/ API（V3）/ 负载均衡器/ 查询负载均衡器列表
更新时间：2024-04-19 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询负载均衡器列表

功能介绍

查询负载均衡器列表。

接口约束

  • 分页查询使用的参数为marker、limit、page_reverse。

  • marker和page_reverse只有和limit一起使用时才会生效，单独使用无效。

调用方法

请参见如何调用API。

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

网络型规格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

应用型规格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。

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

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。

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

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。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

IAM鉴权Token。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

loadbalancers

Array of LoadBalancer objects

Loadbalancer的列表。

page_info

PageInfo object

负载均衡器分页信息。

request_id

String

请求ID。

注：自动生成 。
表5 LoadBalancer

参数

参数类型

描述

id

String

负载均衡器ID。

description

String

负载均衡器描述信息。

最小长度：1

最大长度：255

provisioning_status

String

负载均衡器的配置状态。

取值：

  • ACTIVE：使用中。

  • PENDING_DELETE：删除中。

admin_state_up

Boolean

负载均衡器的启用状态。取值：false停用，true启用。

provider

String

负载均衡器的生产者名称。固定为vlb。

pools

Array of PoolRef objects

负载均衡器直接关联的后端云服务器组的ID列表。

listeners

Array of ListenerRef objects

负载均衡器关联的监听器的ID列表。

operating_status

String

负载均衡器的操作状态。

取值：

  • ONLINE：在线。

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

资源账单信息。

取值：

  • 空：按需计费。

  • 非空：包周期计费，

包周期计费billing_info字段的格式为：order_id:product_id:region_id:project_id，如：

CS2107161019CDJZZ:OFFI569702121789763584: az:057ef081eb00d2732fd1c01a9be75e6f

不支持该字段，请勿使用

最小长度：1

最大长度：1024

l4_flavor_id

String

网络型规格ID。

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

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

hsco场景下所有LB实例共享带宽，该字段无效，请勿使用。

最小长度：1

最大长度：255

l4_scale_flavor_id

String

四层弹性Flavor ID。

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

最小长度：1

最大长度：255

l7_flavor_id

String

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

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

hsco场景下所有LB实例共享带宽，该字段无效，请勿使用。

最小长度：1

最大长度：255

l7_scale_flavor_id

String

七层弹性Flavor ID。

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

最小长度：1

最大长度：255

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

负载均衡器的冻结场景。

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组

charge_mode

String

收费模式。取值：

  • flavor：按规格计费

  • lcu：按使用量计费

waf_failure_action

String

WAF故障时的流量处理策略。discard:丢弃，forward: 转发到后端（默认）

使用说明：只有绑定了waf的LB实例，该字段才会生效。

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

log_group_id

String

LB所绑定的logtank对应的group id

log_topic_id

String

LB所绑定的logtank对应的topic id
表6 PoolRef

参数

参数类型

描述

id

String

后端服务器组ID。
表7 ListenerRef

参数

参数类型

描述

id

String

监听器ID。
表8 Tag

参数

参数类型

描述

key

String

标签键

最小长度：1

最大长度：36

value

String

标签值

最小长度：0

最大长度：43
表9 EipInfo

参数

参数类型

描述

eip_id

String

eip_id

eip_address

String

eip_address

ip_version

Integer

IP版本号。

取值：4表示IPv4,6表示IPv6。
表10 PublicIpInfo

参数

参数类型

描述

publicip_id

String

弹性公网ip配置id

publicip_address

String

IP地址

ip_version

Integer

IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6
表11 GlobalEipInfo

参数

参数类型

描述

global_eip_id

String

global eip的id

global_eip_address

String

global eip的ip地址

ip_version

Integer

IP版本信息。 取值范围：4和6 4：IPv4 6：IPv6
表12 BandwidthRef

参数

参数类型

描述

id

String

共享带宽的id
表13 AutoscalingRef

参数

参数类型

描述

enable

Boolean

当前负载均衡器是否开启弹性扩缩容。

取值：

  • true：开启。

  • false：不开启，默认值。

min_l7_flavor_id

String

弹性扩缩容的最小七层规格ID（规格类型L7_elastic），有七层监听器时，该字段不能为空。

该字段已经废弃，但仍然保留兼容性支持，建议不要使用该字段。如果传入该字段，创建的弹性实例将会有保底规格并产生对应保底规格的费用。

最小长度：1

最大长度：36
表14 PageInfo

参数

参数类型

描述

previous_marker

String

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

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" : [ "az1" ],
    "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" : {
      "enable" : false,
      "min_l7_flavor_id" : ""
    },
    "frozen_scene" : null,
    "eips" : [ ],
    "guaranteed" : true,
    "billing_info" : null,
    "l4_flavor_id" : "aa06b26b-9ff9-43c6-92b9-41e0f746bca6",
    "l4_scale_flavor_id" : null,
    "l7_flavor_id" : "e2a5675c-a181-444e-b9a5-17b052dc7fb9",
    "l7_scale_flavor_id" : null,
    "vip_subnet_cidr_id" : "96e52038-7983-462f-8a96-415d8a280b13",
    "public_border_group" : "center",
    "log_topic_id" : null,
    "log_group_id" : null
  }, {
    "id" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe",
    "project_id" : "057ef081eb00d2732fd1c01a9be75e6f",
    "name" : "elb-reset",
    "description" : "",
    "vip_port_id" : null,
    "vip_address" : null,
    "admin_state_up" : true,
    "provisioning_status" : "ACTIVE",
    "operating_status" : "ONLINE",
    "listeners" : [ {
      "id" : "0ae21c37-8b90-4e73-8a35-eedde6d2538c"
    } ],
    "pools" : [ {
      "id" : "904ecca6-8ebb-4974-9c5c-61d1d66fba17"
    } ],
    "tags" : [ ],
    "provider" : "vlb",
    "created_at" : "2021-07-26T02:46:31Z",
    "updated_at" : "2021-07-26T02:46:59Z",
    "vpc_id" : "59cb11ef-f185-49ba-92af-0539e8ff9734",
    "enterprise_project_id" : "0",
    "availability_zone_list" : [ "az1" ],
    "ipv6_vip_address" : null,
    "ipv6_vip_virsubnet_id" : null,
    "ipv6_vip_port_id" : null,
    "publicips" : [ {
      "publicip_id" : "0c07e04d-e2f9-41ad-b934-f58a65b6734d",
      "publicip_address" : "97.97.2.171",
      "ip_version" : 4
    } ],
    "elb_virsubnet_ids" : [ "7f817f9c-8731-4002-9e47-18cb8d431787" ],
    "elb_virsubnet_type" : "dualstack",
    "ip_target_enable" : false,
    "autoscaling" : {
      "enable" : false,
      "min_l7_flavor_id" : ""
    },
    "frozen_scene" : null,
    "eips" : [ {
      "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,
    "l7_flavor_id" : null,
    "l7_scale_flavor_id" : null,
    "vip_subnet_cidr_id" : null,
    "public_border_group" : "center",
    "log_topic_id" : null,
    "log_group_id" : null
  } ],
  "page_info" : {
    "next_marker" : "cce5318e-c79a-4f68-94a2-9fb285c6efbe",
    "previous_marker" : "65672f7e-2024-4c39-9198-98249da479c5",
    "current_count" : 2
  }
}

状态码

状态码

描述

200

操作正常返回。

错误码

请参见错误码。

父主题： 负载均衡器