• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. LBaas
  6. List load balancers

List load balancers

Function Description

This interface is to query a load balancer.

Interface Format

Method

URI

Description

GET

/v2.0/lbaas/loadbalancers

Queries all load balancers of the tenant submitting the request.

Restrictions

N/A

Request Parameter

None

Response Parameter

Parameter

Type

Mandatory

Description

loadbalancers

List(loadbalancer)

Yes

Specifies the list of load balancers. For details, see Table 1.

Request Example

GET /v2.0/lbaas/loadbalancers

Response Example

{
    "loadbalancers": [
        {
            "description": "simple lb",
            "admin_state_up": true,
            "tenant_id": "1a3e005cf9ce40308c900bcb08e5320c",
            "provisioning_status": "ACTIVE",
            "vip_subnet_id": "5328f1e6-ce29-44f1-9493-b128a5653350",
            "listeners": [
                {
                    "id": "45196943-2907-4369-87b1-c009b1d7ac35"
                }
            ],
            "vip_address": "10.0.0.2",
            "vip_port_id": "cbced4fe-6f6f-4fd6-9348-0c3d1219d6ca",
            "provider": "vlb",
            "pools": [
                {
                    "id": "21d49cf7-4fd3-4cb6-8c48-b7fc6c259aab"
            }
            ],
            "id": "a9729389-6147-41a3-ab22-a24aed8692b2",
            "operating_status": "ONLINE",
            "name": "loadbalancer1"
        }
]
}

Error Code

See section Return Code Processing.