List Load Balancers

GET/v2/lbaas/loadbalancers

Lists the load balancers in your project with their VIP, provisioning status, and the listeners and pools attached to them.

info

Source: list-load-balancers

Request

Query parameters

project_idstring

Project to query. Only administrators can query another project.

fieldsstring

Return only the listed attributes. Can be repeated, for example fields=id&fields=name.

Sample Request

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://api.vietnix.cloud:9888/v2/lbaas/loadbalancers

Response

loadbalancersarrayrequired

List of load balancer objects.

idstringrequired

Load balancer ID.

namestringrequired

Human-readable name.

descriptionstringrequired

Free-form description.

provisioning_statusstringrequired

PENDING_CREATE, ACTIVE, PENDING_UPDATE, PENDING_DELETE, ERROR, and similar.

operating_statusstringrequired

ONLINE, OFFLINE, DEGRADED, ERROR, and similar.

vip_addressstringrequired

IP address of the virtual IP (VIP).

vip_subnet_idstringrequired

Subnet of the VIP.

vip_network_idstringrequired

Network of the VIP.

vip_port_idstringrequired

Port that carries the VIP.

listenersarrayrequired

Listener IDs attached to the load balancer.

poolsarrayrequired

Pool IDs attached to the load balancer.

providerstringrequired

Provider driver, for example amphora.

admin_state_upbooleanrequired

Administrative state.

tagsarrayrequired

Tags on the resource.

created_at / updated_atstringrequired

ISO 8601 timestamps.

Sample Response

Response body

{
  "loadbalancers": [
    {
      "id": "3f2a1b9c-6d4e-4f70-8a11-2c3d4e5f6a70",
      "name": "lb2",
      "description": "",
      "provisioning_status": "ACTIVE",
      "operating_status": "ONLINE",
      "provider": "amphora",
      "vip_address": "192.168.10.5",
      "vip_subnet_id": "fd2de462-f93b-43a6-9b5c-254f1e690bf1",
      "vip_network_id": "15f7dc0a-712c-422f-bfd3-31dc351d9026",
      "vip_port_id": "fb0e8e3e-2a71-420a-885c-94f6d2c2f2b7",
      "listeners": [
        {
          "id": "1dc8539c-7545-4ae8-8081-3140a47b6342"
        }
      ],
      "pools": [
        {
          "id": "bd04cc50-0575-45cc-a965-514357a4b62d"
        }
      ],
      "admin_state_up": true,
      "tags": [],
      "created_at": "2026-03-20T12:58:20",
      "updated_at": null
    }
  ]
}

Status Code

Success

Status Code	Description
200 - OK	Request was successful.

Error

Status Code	Description
401 - Unauthorized	User must authenticate before making a request.
403 - Forbidden	Policy does not allow current user to do this operation.
500 - Internal Server Error	The service failed to process the request.
503 - Service Unavailable	The load balancing service is not available.

note

A load balancer in PENDING_CREATE or PENDING_UPDATE is still being provisioned. Wait for ACTIVE before you add or remove members.