Viewing Details of a Load Balancer
Function
This API is used to view details of a load balancer.
Calling Method
For details, see Calling APIs.
URI
GET /v3/{project_id}/elb/loadbalancers/{loadbalancer_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Specifies the project ID. |
loadbalancer_id |
Yes |
String |
Specifies the load balancer ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Specifies the token used for IAM authentication. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
request_id |
String |
Specifies the request ID. Note: The value is automatically generated. |
loadbalancer |
LoadBalancer object |
Specifies the load balancer. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Specifies the load balancer ID. |
description |
String |
Provides supplementary information about the load balancer. |
provisioning_status |
String |
Specifies the provisioning status of the load balancer. The value can be:
|
admin_state_up |
Boolean |
Specifies whether the load balancer is enabled. The value can be:
|
provider |
String |
Specifies the provider of the load balancer. The value can only be vlb. |
pools |
Array of PoolRef objects |
Lists the IDs of backend server groups associated with the load balancer. |
listeners |
Array of ListenerRef objects |
Lists the IDs of listeners added to the load balancer. |
operating_status |
String |
Specifies the operating status of the load balancer. The value can be:
|
name |
String |
Specifies the load balancer name. |
project_id |
String |
Specifies the project ID of the load balancer. |
vip_subnet_cidr_id |
String |
Specifies the ID of the frontend IPv4 subnet where the load balancer resides. |
vip_address |
String |
Specifies the private IPv4 address bound to the load balancer. |
vip_port_id |
String |
Specifies the ID of the port bound to the private IPv4 address of the load balancer. |
tags |
Array of Tag objects |
Lists the tags added to the load balancer. |
created_at |
String |
Specifies the time when the load balancer was created, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''. |
updated_at |
String |
Specifies the time when the load balancer was updated, in the format of yyyy-MM-dd''T''HH:mm:ss''Z''. |
guaranteed |
Boolean |
Specifies whether the load balancer is a dedicated load balancer.
|
vpc_id |
String |
Specifies the ID of the VPC where the load balancer resides. |
eips |
Array of EipInfo objects |
Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer. This parameter has the same meaning as publicips. |
ipv6_vip_address |
String |
Specifies the IPv6 address bound to the load balancer. |
ipv6_vip_virsubnet_id |
String |
Specifies the ID of the IPv6 subnet where the load balancer resides. |
ipv6_vip_port_id |
String |
Specifies the ID of the port bound to the IPv6 address of the load balancer. |
availability_zone_list |
Array of strings |
Specifies the list of AZs where the load balancer is created. |
enterprise_project_id |
String |
Specifies the enterprise project ID. If this parameter is not passed during resource creation, "0" will be returned, and the resource belongs to the default enterprise project. "0" is not a valid enterprise project ID and cannot be used in the APIs for creating, updating the load balancer, or querying details of the load balancer. |
billing_info |
String |
Provides resource billing information.
|
l4_flavor_id |
String |
Specifies the ID of a flavor at Layer 4. l4_flavor_id defines the indicates maximum Layer 4 flavor for elastic scaling. Notes and constraints:
|
l4_scale_flavor_id |
String |
Specifies the ID of the reserved flavor at Layer 4. This parameter is unsupported. Please do not use it. |
l7_flavor_id |
String |
Specifies the ID of a flavor at Layer 7. l7_flavor_id defines the indicates maximum Layer 7 flavor for elastic scaling. Notes and constraints:
|
l7_scale_flavor_id |
String |
Specifies the ID of the reserved flavor at Layer 7. This parameter is unsupported. Please do not use it. |
publicips |
Array of PublicIpInfo objects |
Specifies the EIP bound to the load balancer. Only one EIP can be bound to a load balancer. This parameter has the same meaning as eips. |
global_eips |
Array of GlobalEipInfo objects |
Specifies the global EIP bound to the load balancer. Only the first global EIP specified under global_eips will be bound. |
elb_virsubnet_ids |
Array of strings |
Lists the IDs of subnets on the downstream plane. |
elb_virsubnet_type |
String |
Specifies the type of the subnet on the downstream plane. The value can be:
|
ip_target_enable |
Boolean |
Specifies whether to add backend servers that are not in the load balancer's VPC. If you enable this function, you can add servers in a peer VPC connected through a VPC peering connection, or in an on-premises data center at the other end of a Direct Connect or VPN connection, by using their IP addresses. The value can be true (IP as a Backend enabled) or false (IP as a Backend disabled). Notes and constraints:
|
frozen_scene |
String |
Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,). The value can be:
|
ipv6_bandwidth |
BandwidthRef object |
Specifies the ID of the bandwidth used by an IPv6 address. Notes and constraints:
|
deletion_protection_enable |
Boolean |
Specifies whether to enable removal protection for the load balancer. The value can be:
Notes and constraints:
|
autoscaling |
AutoscalingRef object |
Specifies information about elastic scaling. If elastic scaling is enabled, the load balancer specifications can be automatically adjusted based on incoming traffic. Notes and constraints:
|
public_border_group |
String |
Specifies the AZ group to which the load balancer belongs. |
charge_mode |
String |
Specifies the charge mode when creating a load balancer. The value can be one of the following:
Notes and constraints:
|
waf_failure_action |
String |
Specifies traffic distributing policies when the WAF is faulty. The value can be:
Notes and constraints: This parameter takes effect only when WAF is enabled for the load balancer. This parameter is unsupported. Please do not use it. |
protection_status |
String |
Specifies the protection status. The value can be:
|
protection_reason |
String |
Specifies why the modification protection function is enabled. Notes and constraints: This parameter is valid only when protection_status is set to consoleProtection. |
log_group_id |
String |
Specifies the ID of the log group that is associated with the load balancer. |
log_topic_id |
String |
Specifies the ID of the log topic that is associated with the load balancer. |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Specifies the tag key. |
value |
String |
Specifies the tag value. |
Parameter |
Type |
Description |
---|---|---|
eip_id |
String |
eip_id |
eip_address |
String |
eip_address |
ip_version |
Integer |
Specifies the IP version. 4 indicates IPv4, and 6 indicates IPv6. |
Parameter |
Type |
Description |
---|---|---|
publicip_id |
String |
Specifies the EIP ID. |
publicip_address |
String |
Specifies the IP address. |
ip_version |
Integer |
Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6). |
Parameter |
Type |
Description |
---|---|---|
global_eip_id |
String |
Specifies the ID of the global EIP. |
global_eip_address |
String |
Specifies the global EIP. |
ip_version |
Integer |
Specifies the IP version. The value can be 4 (IPv4) or 6 (IPv6). |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Specifies whether to enable elastic scaling for the load balancer. The value can be:
|
min_l7_flavor_id |
String |
Specifies the ID of the minimum Layer-7 flavor for elastic scaling. Notes and constraints:
|
Example Requests
Querying details of a given load balancer
GET https://{ELB_Endpoint}/v3/060576782980d5762f9ec014dd2f1148/elb/loadbalancers/3dbde7e5-c277-4ea3-a424-edd339357eff
Example Responses
Status code: 200
Successful request.
{ "loadbalancer" : { "id" : "3dbde7e5-c277-4ea3-a424-edd339357eff", "project_id" : "060576782980d5762f9ec014dd2f1148", "name" : "elb-l4-no-delete", "description" : null, "vip_port_id" : "f079c7ee-65a9-44ef-be86-53d8927e59be", "vip_address" : "10.0.0.196", "admin_state_up" : true, "provisioning_status" : "ACTIVE", "operating_status" : "ONLINE", "listeners" : [ ], "pools" : [ { "id" : "1d864dc9-f6ef-4366-b59d-7034cde2328f" }, { "id" : "c0a2e4a1-c028-4a24-a62f-e721c52f5513" }, { "id" : "79308896-6169-4c28-acbc-e139eb661996" } ], "tags" : [ ], "provider" : null, "created_at" : "2019-12-02T09:55:11Z", "updated_at" : "2019-12-02T09:55:11Z", "vpc_id" : "70711260-9de9-4d96-9839-0ae698e00109", "enterprise_project_id" : "0", "availability_zone_list" : [ ], "ipv6_vip_address" : null, "ipv6_vip_virsubnet_id" : null, "ipv6_vip_port_id" : null, "publicips" : [ ], "elb_virsubnet_ids" : [ "ad5d63bf-3b50-4e88-b4d9-e94a59aade48" ], "eips" : [ ], "guaranteed" : true, "billing_info" : null, "l4_flavor_id" : "e5acacda-f861-404e-9871-df480c49d185", "l4_scale_flavor_id" : null, "l7_flavor_id" : null, "l7_scale_flavor_id" : null, "vip_subnet_cidr_id" : "396d918a-756e-4163-8450-3bdc860109cf", "deletion_protection_enable" : false, "autoscaling" : { "enable" : true, "min_l7_flavor_id" : "0c8cf29d-51cb-4c1d-8e25-1c61cf5c2b00" }, "public_border_group" : "center" }, "request_id" : "1a47cfbf-969f-4e40-8c0e-c2e60b14bcac" }
SDK Sample Code
The SDK sample code is as follows.
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 48 |
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 ShowLoadBalancerSolution { 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(); ShowLoadBalancerRequest request = new ShowLoadBalancerRequest(); request.withLoadbalancerId("{loadbalancer_id}"); try { ShowLoadBalancerResponse response = client.showLoadBalancer(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 32 |
# 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 = ShowLoadBalancerRequest() request.loadbalancer_id = "{loadbalancer_id}" response = client.show_load_balancer(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 38 |
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.ShowLoadBalancerRequest{} request.LoadbalancerId = "{loadbalancer_id}" response, err := client.ShowLoadBalancer(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot