Help Center> Elastic Load Balance> API Reference> Classic Load Balancer APIs> Load Balancer> Querying Details of a Load Balancer
View PDF

Querying Details of a Load Balancer

Function

This API is used to query details about a load balancer.

URI

GET /v1.0/{project_id}/elbaas/loadbalancers/{loadbalancer_id}

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

loadbalancer_id

Yes

String

Specifies the load balancer ID.

Request

  • Request parameters

    None

  • Example request

    None

Response

  • Response parameters
    Table 2 Parameter description

    Parameter

    Type

    Description

    vip_address

    String

    Specifies the private IP address of the load balancer.

    update_time

    String

    Specifies the time when the load balancer was updated.

    create_time

    String

    Specifies the time when the load balancer was created.

    id

    String

    Specifies the load balancer ID.

    status

    String
    • Specifies the load balancer status.
    • The value can be ACTIVE, PENDING_CREATE, or ERROR.

    bandwidth

    Integer

    Specifies the bandwidth (Mbit/s).

    vpc_id

    String

    Specifies the VPC ID.

    admin_state_up

    Integer
    • Specifies the administrative status of the load balancer.
    • The following options are available:

      0: The load balancer is disabled.

      1: The load balancer is running properly.

      2: The load balancer is frozen.

    vip_subnet_id

    String

    Specifies the ID of the private network that the load balancer accesses. This parameter is valid when type is set to Internal.

    type

    String

    Specifies the network type of the load balancer. The value can be Internal or External.

    name

    String

    Specifies the load balancer name.

    description

    String

    Provides supplementary information about the load balancer.

    security_group_id

    String
    • Specifies the security group ID.
    • null is displayed for this parameter when type is set to External.
  • Example response 
    {
    "vip_address": "192.144.62.114",
    "update_time": "2015-09-14 02:34:32",
    "create_time": "2015-09-14 02:34:32",
    "id": "0b07acf06d243925bc24a0ac7445267a",
    "status": "ACTIVE",
    "bandwidth": 1,
    "security_group_id": null,
    "vpc_id": "f54a3ffd-7a55-4568-9e3d-f0ff2d46a107",
    "admin_state_up": 1,
    "vip_subnet_id": null,
    "type": "External",
    "name": "MY_ELB",
    "description": null
}

Status Code

  • Normal

    200

  • Error

    Status Code

    Message

    Description

    400

    badRequest

    Request error.

    401

    unauthorized

    Authentication failed.

    403

    userDisabled

    You do not have the permission to perform the operation.

    404

    Not Found

    The requested page does not exist.

    500

    authFault

    System error.

    503

    serviceUnavailable

    The service is unavailable.
Parent topic: Load Balancer