Prev Next

14.1. Listing load balancers¶

GET /v2/lbaas/loadbalancers

List all load balancers in the specified project.

Administrative users can specify a project ID that is different than their own to list load balancers for other projects.

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index.html#list-load-balancers

14.1.1. Request¶

Name	In	Type	Description
`fields` (Optional)	query	string	The fields that you want the server to return. If no `fields` query parameter is specified, the octavia API returns all attributes allowed by the policy settings. By using the `fields` parameter, the API returns only the requested set of attributes. The `fields` parameter can be specified multiple times. For example, if you specify `fields=id&fields=name` in the request URL, only the `id` and `name` attributes will be returned.
`project_id` (Optional)	query	string	The ID of the project to query.

14.1.1.1. Example¶

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

14.1.2. Response¶

Name	In	Type	Description
`admin_state_up`	body	boolean	The administrative state of the resource, which is up (`true`) or down (`false`).
`created_at`	body	string	The UTC date and timestamp when the resource was created.
`description`	body	string	A human-readable description for the resource.
`flavor_id`	body	uuid	The ID of the flavor.
`id`	body	uuid	The ID of the load balancer.
`listeners`	body	array	The associated listener IDs, if any.
`loadbalancers`	body	array	A list of `loadbalancer` objects.
`name`	body	string	Human-readable name of the resource.
`operating_status`	body	string	The operating status of the resource.
`pools`	body	array	The associated pool IDs, if any.
`project_id`	body	string	The ID of the project owning this resource.
`provider`	body	string	Provider name for the load balancer.
`provisioning_status`	body	string	The provisioning status of the resource.
`tags`	body	list	A list of simple strings assigned to the resource. New in version 2.5
`updated_at`	body	string	The UTC date and timestamp when the resource was last updated.
`vip_address`	body	string	The IP address of the Virtual IP (VIP).
`vip_network_id`	body	uuid	The ID of the network for the Virtual IP (VIP).
`vip_port_id`	body	uuid	The ID of the Virtual IP (VIP) port.
`vip_qos_policy_id`	body	uuid	The ID of the QoS Policy which will apply to the Virtual IP (VIP).
`vip_subnet_id`	body	uuid	The ID of the subnet for the Virtual IP (VIP).

14.1.2.1. Status codes¶

14.1.2.1.1. Success¶

Code	Reason
`200 - OK`	Request was successful.

14.1.2.1.2. Error¶

Code	Reason
`400 - Bad Request`	Some content in the request was invalid.
`401 - Unauthorized`	User must authenticate before making a request.
`500 - Internal Server Error`	Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

14.1.2.2. Example¶

{
  "loadbalancer": {
    "provider": "amphora",
    "description": "",
    "admin_state_up": true,
    "pools": [
      {
        "id": "e7ac20f9-a4f9-4bf7-9333-ae96e1d34e0c"
      }
    ],
    "created_at": "2020-03-19T18:04:56.378183",
    "provisioning_status": "ACTIVE",
    "updated_at": "2020-03-19T18:09:33.467099",
    "vip_qos_policy_id": null,
    "vip_network_id": "15f7dc0a-712c-422f-bfd3-31dc351d9026",
    "listeners": [
      {
        "id": "ab110967-fd83-4a41-b3c5-4083395bdc86"
      }
    ],
    "tags": [],
    "vip_port_id": "c39af70f-a725-4b2b-b876-16ad636868ac",
    "flavor_id": null,
    "tenant_id": "05341a23f649427baa2fd4039b7f378f",
    "vip_address": "192.168.10.46",
    "vip_subnet_id": "fd2de462-f93b-43a6-9b5c-254f1e690bf1",
    "project_id": "05341a23f649427baa2fd4039b7f378f",
    "id": "601be015-0753-4221-931c-d26d81248551",
    "operating_status": "ONLINE",
    "name": "lb1"
  }
}

Version 5.0.0 — Feb 01, 2022

Prev Next