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}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Specifies the project ID.
loadbalancer_id	Yes	String	Specifies the load balancer ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Specifies the token used for IAM authentication.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
request_id	String	Specifies the request ID. Note: The value is automatically generated.
loadbalancer	LoadBalancer object	Specifies the load balancer.

**Table 4** LoadBalancer
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: ACTIVE: The load balancer is successfully provisioned. PENDING_DELETE: The load balancer is being deleted.
admin_state_up	Boolean	Specifies whether the load balancer is enabled. The value can be: true: indicates the load balancer is enabled. false: indicates the load balancer is disabled.
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: ONLINE: indicates that the load balancer is running normally. FROZEN: indicates that the load balancer is frozen.
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. true (default): The load balancer is a dedicated load balancer. false: The load balancer is a shared 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. If the value is left blank, the resource is billed in pay-per-use mode.
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: If l4_flavor_id is specified, the load balancer is billed by fixed specifications. If L4_elastic_max is specified, the load balancer is billed by how many LCUs you use.
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: If l7_flavor_id is specified, the load balancer is billed by fixed specifications. If L7_elastic_max is specified, the load balancer is billed by how many LCUs you use.
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: ipv4: IPv4 subnet dualstack: subnet that supports IPv4/IPv6 dual stack
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: The value can only be updated to true. If you need to connect your server to a shared VPC, ensure the VPC principal has created a VPC peering connections between the two VPCs. This function is supported only by dedicated load balancers.
frozen_scene	String	Specifies the scenario where the load balancer is frozen. Multiple values are separated using commas (,). The value can be: POLICE: The load balancer is frozen due to security reasons. ILLEGAL: The load balancer is frozen due to violation of laws and regulations. VERIFY: Your account has not completed real-name authentication. PARTNER: The load balancer is frozen by the partner. ARREAR: Your account is in arrears.
ipv6_bandwidth	BandwidthRef object	Specifies the ID of the bandwidth used by an IPv6 address. Notes and constraints: This parameter is available only when you create or update a load balancer with a public IPv6 address. If you use a new IPv6 address and specify a shared bandwidth, the IPv6 address will be added to this shared bandwidth.
deletion_protection_enable	Boolean	Specifies whether to enable removal protection for the load balancer. The value can be: true: Enable removal protection. false (default): Disable removal protection. Notes and constraints: You need to disable removal protection for all your resources before deleting your account. This parameter will be returned only when this option is enabled.
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: This parameter is only available for users on the whitelist. If elastic scaling is enabled, l4_flavor_id indicates the maximum Layer-4 flavor for elastic scaling. l7_flavor_id indicates the maximum Layer-7 flavor for elastic scaling. This parameter is no longer used, but it is still supported for compatibility reasons. Please do not use this parameter. If you specify it, the load balancer will be assigned the minimum elastic specification and billed accordingly.
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: flavor: billed by the specifications you will select. lcu: billed by how many LCUs you have used. If this parameter is left blank, shared load balancers will be free, while dedicated load balancers will billed by the specifications you will select. Notes and constraints: If this parameter is not specified during the creation of a shared load balancer, the load balancer is free. If this parameter is not specified during the creation of a dedicated load balancer, the load balancer is billed by the specifications you have selected.
waf_failure_action	String	Specifies traffic distributing policies when the WAF is faulty. The value can be: discard: Traffic will be discarded. forward (default): Traffic will be distributed to the default backend servers. 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: nonProtection (default): The resource is not protected against being modified by accident. consoleProtection: The resource is protected against being modified by accident.
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.

**Table 5** PoolRef
Parameter	Type	Description
id	String	Specifies the ID of the backend server group.

**Table 6** ListenerRef
Parameter	Type	Description
id	String	Specifies the listener ID.

**Table 7** Tag
Parameter	Type	Description
key	String	Specifies the tag key.
value	String	Specifies the tag value.

**Table 8** EipInfo
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.

**Table 9** PublicIpInfo
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).

**Table 10** GlobalEipInfo
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).

**Table 11** BandwidthRef
Parameter	Type	Description
id	String	Specifies the shared bandwidth ID.

**Table 12** AutoscalingRef
Parameter	Type	Description
enable	Boolean	Specifies whether to enable elastic scaling for the load balancer. The value can be: true: Enable elastic scaling. false (default): Disable elastic scaling.
min_l7_flavor_id	String	Specifies the ID of the minimum Layer-7 flavor for elastic scaling. Notes and constraints: This parameter cannot be left blank if there are Layer 7 listeners. This parameter is no longer used, but it is still supported for compatibility reasons. Please do not use this parameter. If you specify it, the load balancer will be assigned the minimum elastic specification and billed accordingly.

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.

      
       
         
         
           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());
        }
    }
}

          

        

      
     

      
       
         
         
           # 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)

          

        

      
     

      
       
         
         
           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)
    }
}

          

        

      
     