Querying Details of a Load Balancer

Function

This API is used to query details about a load balancer using its ID. You can also query the EIP bound to the load balancer based on the value of vip_port_id.

URI

GET /v2.0/lbaas/loadbalancers/{loadbalancer_id}

**Table 1** Parameter description
Parameter	Mandatory	Type	Description
loadbalancer_id	Yes	String	Specifies the load balancer ID.

Request

None

Response

**Table 2** Parameter description
Parameter	Type	Description
loadbalancer	Object	Specifies the load balancer. For details, see Table 3.

**Table 3** **loadbalancer** parameter description
Parameter	Mandatory	Type	Description
name	No	String	Specifies the load balancer name. The value contains a maximum of 255 characters.
description	No	String	Provides supplementary information about the load balancer. The value contains a maximum of 255 characters.
provisioning_status	No	String	This parameter is reserved. Specifies the provisioning status of the load balancer. The value can be ACTIVE.
tenant_id	No	String	Specifies the ID of the project where the load balancer is used. The value contains a maximum of 255 characters. The value must be the same as the value of project_id in the token.
project_id	No	String	Specifies the ID of the project where the load balancer is used. This parameter has the same meaning as tenant_id. The value must be the same as the value of project_id in the token.
vip_subnet_id	Yes	String	Specifies the ID of the IPv4 subnet where the load balancer works. You can obtain the value by calling the API for querying subnets ({VPC endpoint}/v2.0/subnets) using the GET method. The private IP address of the load balancer is in this subnet. Only IPv4 subnets are supported. IPv6 subnets are not supported.
provider	No	String	Specifies the provider of the load balancer. The value can only be vlb.
vip_address	No	String	Specifies the private IP address of the load balancer. This IP address must be the one in the subnet specified by vip_subnet_id. If this parameter is not specified, an IP address is automatically assigned to the load balancer from the subnet specified by vip_subnet_id. The value contains a maximum of 64 characters.
admin_state_up	No	Boolean	Specifies the administrative status of the load balancer. This parameter is reserved. The default value is true.

**Table 4** **listeners** parameter description
Parameter	Type	Description
id	String	Specifies the ID of the associated listener.

**Table 5** **pools** parameter description
Parameter	Type	Description
id	String	Specifies the ID of the associated backend server group.

Example Request

Example request 1: Querying details of a load balancer using its ID
Example request 2: Querying the EIP bound to the load balancer. For details, see Querying EIPs.
```
GET https://{EIP_Endpoint}/v1/{project_id}/publicips?port_id={vip_port_id}
```
vip_port_id is the value of vip_port_id for the load balancer.

Example Response

Example response 1

{
    "loadbalancer": {
        "description": "",
        "admin_state_up": true,
        "tenant_id": "1867112d054b427e808cc6096d8193a1",
        "project_id": "1867112d054b427e808cc6096d8193a1",
        "provisioning_status": "ACTIVE",
        "vip_subnet_id": "4f5e8efe-fbbe-405e-b48c-a41202ef697c",
        "listeners": [
            {
                "id": "09e64049-2ab0-4763-a8c5-f4207875dc3e"
            }
        ],
        "vip_address": "192.168.2.4",
        "vip_port_id": "c7157e7a-036a-42ca-8474-100be22e3727",
        "provider": "vlb",
        "pools": [
            {
                "id": "b7e53dbd-62ab-4505-a280-5c066078a5c9"
            }
        ],
        "id": "3d77894d-2ffe-4411-ac0a-0d57689779b8",
        "operating_status": "ONLINE",
        "tags": [],
        "name": "lb-2",
        "created_at": "2018-07-25T01:54:13", 
        "updated_at": "2018-07-25T01:54:14"
    }
}

Example response 2

{
    "publicips": [
        {
            "id": "6285e7be-fd9f-497c-bc2d-dd0bdea6efe0",
            "status": "DOWN",
            "profile": {
              "user_id": "35f2b308f5d64441a6fa7999fbcd4321",
              "product_id": "00301-48027-0--0",
              "region_id": "xxx",
              "order_id": "xxxxxxxxx"
            },
            "type": "5_bgp",
            "public_ip_address": "161.xx.xx.9",
            "private_ip_address": "192.168.2.4",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "create_time": "2015-07-16 04:22:32",
            "bandwidth_id": "3fa5b383-5a73-4dcb-a314-c6128546d855",
            "bandwidth_share_type": "PER",
            "bandwidth_size": 5,
            "bandwidth_name": "bandwidth-test",
            "enterprise_project_id":"b261ac1f-2489-4bc7-b31b-c33c3346a439",
            "ip_version": 4,
            "port_id": "c7157e7a-036a-42ca-8474-100be22e3727"
        }
    ]
}

public_ip_address indicates the EIP bound to the load balancer.