查询负载均衡器列表
功能介绍
查询负载均衡器列表。
接口约束
-
分页查询使用的参数为marker、limit、page_reverse。
-
marker和page_reverse只有和limit一起使用时才会生效,单独使用无效。
调用方法
请参见如何调用API。
URI
GET /v3/{project_id}/elb/loadbalancers
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
负载均衡器所在的项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
marker |
否 |
String |
上一页最后一条记录的ID。 使用说明:
|
limit |
否 |
Integer |
参数解释:每页返回的个数。 取值范围:0-2000 默认取值:2000 |
page_reverse |
否 |
Boolean |
是否反向查询。 取值:
使用说明:
|
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 |
参数解释:负载均衡器的启用状态。 取值范围:
|
provisioning_status |
否 |
Array of strings |
负载均衡器的配置状态。 取值:
支持多值查询,查询条件格式:provisioning_status=xxx&provisioning_status=xxx。 |
operating_status |
否 |
Array of strings |
负载均衡器的操作状态。 取值:
支持多值查询,查询条件格式:operating_status=xxx&operating_status=xxx。 |
guaranteed |
否 |
Boolean |
是否独享型LB。 取值:
|
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 支持多值查询,查询条件格式:
注:该字段与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 支持多值查询,查询条件格式:
注:该字段与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。 查询时若不传,则查询default企业项目下的资源,鉴权按照default企业项目鉴权。 如果传值,则必须传已存在的企业项目ID(不可为"0")或传all_granted_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 |
下联面子网类型。 取值:
支持多值查询,查询条件格式: 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。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
loadbalancers |
Array of LoadBalancer objects |
Loadbalancer的列表。 |
page_info |
PageInfo object |
负载均衡器分页信息。 |
request_id |
String |
请求ID。 注:自动生成 。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释:负载均衡器ID。 |
description |
String |
参数解释:负载均衡器描述信息。 |
provisioning_status |
String |
参数解释:负载均衡器的配置状态。 取值范围:
|
admin_state_up |
Boolean |
参数解释:负载均衡器的启用状态。 取值范围:
|
provider |
String |
参数解释:负载均衡器的生产者名称。固定为vlb。 |
pools |
Array of PoolRef objects |
参数解释:负载均衡器直接关联的后端服务器组的ID列表。 |
listeners |
Array of ListenerRef objects |
参数解释:负载均衡器关联的监听器的ID列表。 |
operating_status |
String |
参数解释:负载均衡器的操作状态。 取值范围:
|
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。 取值范围:
|
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 |
参数解释:资源账单信息。 取值范围:
|
l4_flavor_id |
String |
参数解释:网络型规格ID。 对于弹性扩缩容实例,表示上限规格。 约束限制:
|
l4_scale_flavor_id |
String |
参数解释:四层弹性Flavor ID。 不支持该字段,请勿使用。 |
l7_flavor_id |
String |
参数解释:应用型ID。 对于弹性扩缩容实例,表示上限规格ID。 约束限制:
|
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 |
参数解释:下联面子网类型。 取值范围:
|
ip_target_enable |
Boolean |
参数解释:是否启用跨VPC后端转发。 开启跨VPC后端转发后,后端服务器组不仅支持添加云上VPC内的服务器,还支持添加其他VPC、其他公有云、云下数据中心的服务器。 约束限制:
取值范围:
|
frozen_scene |
String |
参数解释:负载均衡器的冻结场景。 若负载均衡器有多个冻结场景,用逗号分隔。 取值范围:
|
ipv6_bandwidth |
BandwidthRef object |
参数解释:带宽对象ID。 约束限制:
|
deletion_protection_enable |
Boolean |
参数解释:是否开启删除保护。 约束限制:
取值范围:
|
autoscaling |
AutoscalingRef object |
参数解释:弹性扩缩容配置信息。负载均衡器开启弹性扩缩容后,可根据负载情况自动调整负载均衡器的规格。 约束限制:
说明:
该字段已经废弃,但仍然保留兼容性支持,建议不要使用该字段。如果传入该字段,创建的弹性实例将会有保底规格并产生对应保底规格的费用。 |
public_border_group |
String |
参数解释:LB所属AZ组。 |
waf_failure_action |
String |
参数解释:WAF故障时的流量处理策略。 约束限制:只有绑定了waf的LB实例,该字段才会生效。 取值范围:discard:丢弃,forward: 转发到后端。 默认取值:forward |
参数 |
参数类型 |
描述 |
---|---|---|
eip_id |
String |
参数解释:弹性IP的ID。 |
eip_address |
String |
参数解释:弹性IP的IP地址。 |
ip_version |
Integer |
参数解释:IP版本号。 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
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版本信息。 取值范围:
|
请求示例
-
分页查询负载均衡器列表
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 } }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.elb.v3.region.ElbRegion; import com.huaweicloud.sdk.elb.v3.*; import com.huaweicloud.sdk.elb.v3.model.*; public class ListLoadBalancersSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); ElbClient client = ElbClient.newBuilder() .withCredential(auth) .withRegion(ElbRegion.valueOf("<YOUR REGION>")) .build(); ListLoadBalancersRequest request = new ListLoadBalancersRequest(); try { ListLoadBalancersResponse response = client.listLoadBalancers(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkelb.v3.region.elb_region import ElbRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkelb.v3 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = ElbClient.new_builder() \ .with_credentials(credentials) \ .with_region(ElbRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListLoadBalancersRequest() response = client.list_load_balancers(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" elb "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/elb/v3/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := elb.NewElbClient( elb.ElbClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListLoadBalancersRequest{} response, err := client.ListLoadBalancers(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
操作正常返回。 |
错误码
请参见错误码。