Skip to main content

Get Load Balancer Details

GET/v2/lbaas/loadbalancers/{loadbalancer_id}

Returns the load balancer with its VIP, listeners, pools, and status. Use it to poll a load balancer that is still PENDING_CREATE or PENDING_UPDATE.

Request​

Parameters​

loadbalancer_idstringrequiredpath

The ID of the load balancer.

fieldsstringquery

Return only the listed attributes. Can be repeated.

Sample Request​

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

Response​

Sample Response​

Response body
{
"loadbalancer": {
"id": "3f2a1b9c-6d4e-4f70-8a11-2c3d4e5f6a70",
"name": "lb2",
"description": "",
"provisioning_status": "ACTIVE",
"operating_status": "ONLINE",
"provider": "amphora",
"flavor_id": null,
"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",
"vip_qos_policy_id": null,
"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": "2026-03-20T12:58:25"
}
}

Status Code​

Success​

Status CodeDescription
200 - OKRequest was successful.

Error​

Status CodeDescription
401 - UnauthorizedUser must authenticate before making a request.
403 - ForbiddenPolicy does not allow current user to do this operation.
404 - Not FoundThe load balancer does not exist, or is not visible to your project.
note

provisioning_status describes the control plane (ACTIVE, PENDING_*, ERROR), while operating_status describes the data plane (ONLINE, OFFLINE, DEGRADED). A load balancer can be ACTIVE while a member is OFFLINE.