OpenStack Octavia API v2

https://docs.openstack.org/api-ref/load-balancer/v2/
Admin
OpenStack Octavia API v2 provides a ReSTful HTTP API for managing load balancers within the...
Tokens:315,419
Snippets:598
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET Request Examples for Load Balancers

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Demonstrates how to make GET requests to the Octavia API v2 for load balancer resources. It shows equivalent requests with and without the '.json' extension, and examples of filtering by name.

```http
GET _publicURL_/loadbalancers
GET _publicURL_/loadbalancers.json
```

```http
GET /v2/lbaas/loadbalancers?name=foobar
```

--------------------------------

### List Amphorae Request Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

This example shows a basic GET request to list all amphorae for a project. Query parameters can be added for filtering and selecting specific fields.

```bash
curl -X GET http://198.51.100.10:9876/v2/octavia/amphorae

```

--------------------------------

### Example Load Balancer List Request (First Page)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

An example HTTP GET request to retrieve the first page of load balancers from the OpenStack Load Balancer v2 API. It uses the `limit` parameter to specify the number of items per page.

```HTTP
GET http://198.51.100.10:9876/v2/lbaas/loadbalancers.json?limit=2

```

--------------------------------

### Create Listener Request Example (JSON)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Example of a JSON request body to create a new listener for an OpenStack load balancer. It includes details like protocol, port, and TLS configuration.

```json
{
    "listener": {
        "description": "A great TLS listener",
        "admin_state_up": true,
        "protocol": "TERMINATED_HTTPS",
        "protocol_port": 443,
        "default_tls_container_ref": "http://198.51.100.10:9311/v1/containers/a570068c-d295-4780-91d4-3046a325db51",
        "insert_headers": {
            "X-Forwarded-Port": "true",
            "X-Forwarded-For": "true"
        },
        "default_pool_id": "ddb2b28f-89e9-45d3-a329-a359c3e39e4a",
        "sni_container_refs": [
            "http://198.51.100.10:9311/v1/containers/a570068c-d295-4780-91d4-3046a325db51",
            "http://198.51.100.10:9311/v1/containers/aaebb31e-7761-4826-8cb4-2b829caca3ee"
        ],
        "name": "great_tls_listener",
        "timeout_client_data": 50000,
        "timeout_member_connect": 5000,
        "timeout_member_data": 50000,
        "timeout_tcp_inspect": 0,
        "tags": [
            "test_tag"
        ],
        "client_ca_tls_container_ref": "http://198.51.100.10:9311/v1/containers/35649991-49f3-4625-81ce-2465fe8932e5",
        "client_authentication": "NONE",
        "client_crl_container_ref": "http://198.51.100.10:9311/v1/containers/e222b065-b93b-4e2a-9a02-804b7a118c3c",
        "allowed_cidrs": [
            "192.0.2.0/24",
            "198.51.100.0/24"
        ],
        "tls_ciphers": "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256",
        "tls_versions": [
            "TLSv1.2",
            "TLSv1.3"
        ],
        "alpn_protocols": [
            "http/1.1",
            "http/1.0"
        ],
        "hsts_include_subdomains": true,
        "hsts_max_age": 31536000,
        "hsts_preload": true
    }
}
```

--------------------------------

### Availability Zone Details Response Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

An example JSON response when successfully retrieving the details of an availability zone.

```json
{
    "availability_zone": {
        "name": "my_az",
        "description": "My availability zone.",
        "enabled": true,
        "availability_zone_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a"
    }
}
```

--------------------------------

### Create Availability Zone Profile (cURL Example)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

cURL command to create an availability zone profile. This example demonstrates setting the HTTP method, headers, request body, and the target URL.

```bash
curl -X POST -H "Content-Type: application/json" -H "X-Auth-Token: <token>" -d '{"availability_zone_profile":{"name":"some_az","provider_name":"amphora","availability_zone_data":"{\"compute_zone\": \"az1\"}"}}' http://198.51.100.10:9876/v2.0/lbaas/availabilityzoneprofiles

```

--------------------------------

### Availability Zone Profile Response Example (JSON)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Example JSON response for a successfully retrieved availability zone profile. It includes the profile ID, name, provider, and availability zone data.

```json
{
    "availability_zone_profile":
        {
            "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
            "name": "some_az",
            "provider_name": "amphora",
            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az1\"}"
        }
}

```

--------------------------------

### Example Response for Availability Zone Profiles

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This JSON object illustrates an example response when listing Availability Zone Profiles. It contains a list of profiles, each with an ID, name, provider name, and availability zone data.

```json
{
    "availability_zone_profiles": [
        {
            "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
            "name": "some_az",
            "provider_name": "amphora",
            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az2\"}"
        }
    ]
}
```

--------------------------------

### List Load Balancer Providers Response Example (JSON)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

An example JSON response when listing Load Balancer providers. It includes a list of provider objects, each with a name and description.

```json
{
    "providers": [
        {
            "name": "amphora",
            "description": "The Octavia Amphora driver."
        },
        {
            "name": "octavia",
            "description": "Deprecated alias of the Octavia Amphora driver."
        }
    ]
}
```

--------------------------------

### Example Response for Availability Zone Data

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This JSON object represents an example response when querying for Availability Zone data. It includes details such as the zone name, description, enabled status, and associated profile ID.

```json
{
    "availability_zone": {
        "name": "my_az",
        "description": "My availability zone.",
        "enabled": false,
        "availability_zone_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a"
    }
}
```

--------------------------------

### List Availability Zones Response Example - JSON

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Example of a successful JSON response when listing availability zones. It includes a list of availability zone objects, each with name, description, enabled status, and profile ID.

```json
{
    "availability_zones": [
        {
            "name": "my_az",
            "description": "My availability zone.",
            "enabled": true,
            "availability_zone_profile_id": "5712097e-0092-45dc-bff0-ab68b61ad51a"
        }
    ]
}
```

--------------------------------

### Create Availability Zone Profile (JSON Request Example)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Example JSON payload for creating a new availability zone profile. It includes the profile name, provider name, and availability zone data.

```json
{
    "availability_zone_profile":
        {
            "name": "some_az",
            "provider_name": "amphora",
            "availability_zone_data": "{\"compute_zone\": \"az1\", \"volume_zone\": \"az1\"}"
        }
}

```

--------------------------------

### View Load Balancer v2 Quotas Response Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This JSON object represents an example of a successful response when retrieving the quota information for a project. It details the current limits for various load balancer resources.

```json
{
    "quota": {
        "loadbalancer": 5,
        "listener": -1,
        "member": 50,
        "pool": -1,
        "healthmonitor": -1,
        "l7policy": 20,
        "l7rule": -1
    }
}
```

--------------------------------

### Request Example for Availability Zone Profile

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

Illustrates the JSON payload for creating or updating an availability zone profile, including its name, provider, and zone data.

```json
{
    "availability_zone_profile":
        {
            "name": "other_az",
            "provider_name": "amphora",
            "availability_zone_data": "{\"compute_zone\": \"az2\", \"volume_zone\": \"az2\"}"
        }
}

```

--------------------------------

### Get Load Balancer Statistics (Curl Example)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This example shows how to retrieve statistics for a specific load balancer using the curl command. It specifies the GET method, the required authentication token header, and the URL endpoint including the load balancer ID.

```curl
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2/lbaas/loadbalancers/4a13c573-623c-4d23-8a9c-581dc17ceb1f/stats
```

--------------------------------

### Get Load Balancer Flavor Profile (Response Example)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

This is an example of a successful JSON response when retrieving a Load Balancer flavor profile. It contains the profile's ID, name, provider name, and flavor data.

```json
{
    "flavorprofile":
        {
            "id": "5712097e-0092-45dc-bff0-ab68b61ad51a",
            "name": "amphora-act-stdby",
            "provider_name": "amphora",
            "flavor_data": "{\"loadbalancer_topology\": \"ACTIVE_STANDBY\"}"
        }
}
```

--------------------------------

### Get Availability Zone Profile Details (GET)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This example shows how to retrieve the details of a specific availability zone profile using its ID. It includes authentication headers and the endpoint URL. The response contains the profile's attributes, which can be filtered using the `fields` query parameter.

```bash
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2.0/lbaas/availabilityzoneprofiles/5712097e-0092-45dc-bff0-ab68b61ad51a

```

--------------------------------

### Example Load Balancer List Request (Last Page)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

An example HTTP GET request to retrieve the last page of load balancers from the OpenStack Load Balancer v2 API. It includes the `limit` parameter and a `marker` for pagination, indicating the last item from the previous page.

```HTTP
GET /v2/lbaas/loadbalancers.json?limit=2&marker=4ef465f3-0233-44af-b93d-9d3eae4daf85 HTTP/1.1
Host: 198.51.100.10:9876
Content-Type: application/json
Accept: application/json


```

--------------------------------

### Show Provider Flavor Capabilities (Curl)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Example using curl to send a GET request to the OpenStack Load Balancer v2 API to retrieve the flavor capabilities for a specific provider. Requires an authentication token and the provider name.

```curl
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2/lbaas/providers/amphora/flavor_capabilities
```

--------------------------------

### Show Pool Details API Request Example (Curl)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This snippet demonstrates how to make a GET request to the OpenStack Load Balancer API to retrieve the details of a specific pool. It requires authentication via an X-Auth-Token and specifies the pool ID in the URL.

```bash
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2/lbaas/pools/24a43e68-36de-45f6-89cf-c03df583131d
```

--------------------------------

### List Load Balancer Providers (Curl)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Example using curl to send a GET request to the OpenStack Load Balancer v2 API to list all enabled provider drivers. Supports filtering response fields using the 'fields' query parameter. Requires an authentication token.

```curl
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2/lbaas/providers
```

--------------------------------

### Example Load Balancer List Response (First Page)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

A sample JSON response for the first page of a load balancer list from the OpenStack Load Balancer v2 API. It includes a list of load balancer objects and pagination links ('next' and 'previous') for navigation.

```JSON
{
    "loadbalancers": [
        {
            "admin_state_up": true,
            "listeners": [],
            "vip_subnet_id": "08dce793-daef-411d-a896-d389cd45b1ea",
            "pools": [],
            "provider": "octavia",
            "description": "Best App load balancer 1",
            "name": "bestapplb1",
            "operating_status": "ONLINE",
            "id": "34d5f4a5-cbbc-43a0-878f-b8a26370e6e7",
            "provisioning_status": "ACTIVE",
            "vip_port_id": "1e20d91d-8df9-4c15-9778-28bc89226c19",
            "vip_address": "203.0.113.10",
            "project_id": "bf325b04-e7b1-4002-9b10-f4984630367f"
        },
        {
            "admin_state_up": true,
            "listeners": [],
            "vip_subnet_id": "08dce793-daef-411d-a896-d389cd45b1ea",
            "pools": [],
            "provider": "octavia",
            "description": "Second Best App load balancer 1",
            "name": "2ndbestapplb1",
            "operating_status": "ONLINE",
            "id": "0fdb0ca7-0a38-4aea-891c-daaed40bcafe",
            "provisioning_status": "ACTIVE",
            "vip_port_id": "21f7ac04-6824-4222-93cf-46e0d70607f9",
            "vip_address": "203.0.113.20",
            "project_id": "bf325b04-e7b1-4002-9b10-f4984630367f"
        }
    ],
    "loadbalancers_links": [
        {
            "href": "http://198.51.100.10:9876/v2/lbaas/loadbalancers.json?limit=2&marker=0fdb0ca7-0a38-4aea-891c-daaed40bcafe",
            "rel": "next"
        },
        {
            "href": "http://198.51.100.10:9876/v2/lbaas/loadbalancers.json?limit=2&marker=34d5f4a5-cbbc-43a0-878f-b8a26370e6e7&page_reverse=True",
            "rel": "previous"
        }
    ]
}

```

--------------------------------

### Load Balancer v2 API: Show Project Quota Request Example (cURL)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This cURL command illustrates how to make a GET request to the OpenStack Load Balancer v2 API to retrieve the quota for a specific project. It includes the necessary authentication token and the project ID.

```bash
curl -X GET -H "X-Auth-Token: <token>" http://198.51.100.10:9876/v2/lbaas/quotas/e3cd678b11784734bc366148aa37580e
```

--------------------------------

### Update Availability Zone Request Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

An example JSON request body for updating an availability zone, specifying new description and enabled status.

```json
{
    "availability_zone": {
        "description": "My availability zone.",
        "enabled": false
    }
}
```

--------------------------------

### Health Monitor Response Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

Example of a successful response after creating a health monitor. It shows the structure of the health monitor object, including its ID, status, and configuration details.

```json
{
    "healthmonitors": [
        {
            "project_id": "e3cd678b11784734bc366148aa37580e",
            "name": "super-pool-health-monitor",
            "admin_state_up": true,
            "pools": [
                {
                    "id": "4029d267-3983-4224-a3d0-afb3fe16a2cd"
                }
            ],
            "created_at": "2017-05-11T23:53:47",
            "provisioning_status": "ACTIVE",
            "updated_at": "2017-05-11T23:53:47",
            "delay": 10,
            "expected_codes": "200",
            "max_retries": 1,
            "http_method": "GET",
            "timeout": 5,
            "max_retries_down": 3,
            "url_path": "/",
            "type": "HTTP",
            "id": "8ed3c5ac-6efa-420c-bedb-99ba14e58db5",
            "operating_status": "ONLINE",
            "tags": ["test_tag"],
            "http_version": 1.0,
            "domain_name": null
        }
    ]
}
```

--------------------------------

### Listener Response Example (JSON)

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

An example JSON response for a listener object, detailing its configuration and status. This includes properties like description, protocol, ports, administrative state, associated load balancers, and TLS settings. The response format is consistent with the OpenStack Load Balancer API v2.

```json
{
    "listener": {
        "description": "An updated great TLS listener",
        "admin_state_up": true,
        "project_id": "e3cd678b11784734bc366148aa37580e",
        "protocol": "TERMINATED_HTTPS",
        "protocol_port": 443,
        "provisioning_status": "PENDING_UPDATE",
        "default_tls_container_ref": "http://198.51.100.10:9311/v1/containers/a570068c-d295-4780-91d4-3046a325db51",
        "loadbalancers": [
            {
                "id": "607226db-27ef-4d41-ae89-f2a800e9c2db"
            }
        ],
        "insert_headers": {
            "X-Forwarded-Port": "true",
            "X-Forwarded-For": "false"
        },
        "created_at": "2017-02-28T00:42:44",
        "updated_at": "2017-02-28T00:44:30",
        "id": "023f2e34-7806-443b-bfae-16c324569a3d",
        "operating_status": "OFFLINE",
        "default_pool_id": "ddb2b28f-89e9-45d3-a329-a359c3e39e4a",
        "sni_container_refs": [
            "http://198.51.100.10:9311/v1/containers/a570068c-d295-4780-91d4-3046a325db51",
            "http://198.51.100.10:9311/v1/containers/aaebb31e-7761-4826-8cb4-2b829caca3ee"
        ],
        "l7policies": [
            {
                "id": "5e618272-339d-4a80-8d14-dbc093091bb1"
            }
        ],
        "name": "great_updated_tls_listener",
        "timeout_client_data": 100000,
        "timeout_member_connect": 1000,
        "timeout_member_data": 100000,
        "timeout_tcp_inspect": 5,
        "tags": ["updated_tag"],
        "client_ca_tls_container_ref": null,
        "client_authentication": "NONE",
        "client_crl_container_ref": null,
        "allowed_cidrs": [
            "192.0.2.0/24",
            "198.51.100.0/24"
        ],
        "tls_ciphers": "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256",
        "tls_versions": [
            "TLSv1.2",
            "TLSv1.3"
        ],
        "alpn_protocols": [
            "http/1.1",
            "http/1.0"
        ],
        "hsts_include_subdomains": true,
        "hsts_max_age": 31536000,
        "hsts_preload": true
    }
}
```

--------------------------------

### Response Example: Flavor Capabilities

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

This JSON object illustrates a response containing flavor capabilities. It includes a list of capabilities, such as 'loadbalancer_topology', with associated descriptions detailing their functionality and possible values.

```json
{
  "flavor_capabilities": [
    {
      "name": "loadbalancer_topology",
      "description": "The load balancer topology. One of: SINGLE - One amphora per load balancer. ACTIVE_STANDBY - Two amphora per load balancer."
    }
  ]
}
```

--------------------------------

### Load Balancer Pool Response Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index

Example of a successful JSON response when retrieving load balancer pool statistics. Includes details on bytes in/out, connections, and request errors.

```json
{
    "stats": {
        "bytes_in": 65671420,
        "total_connections": 26189172,
        "active_connections": 48629,
        "bytes_out": 774771186,
        "request_errors": 0
    }
}
```

--------------------------------

### OpenStack Load Balancer v2 L7 Policy Response Example

Source: https://docs.openstack.org/api-ref/load-balancer/v2/index_expanded=

Provides an example JSON response for an L7 policy in OpenStack Load Balancer v2. It details various attributes like listener ID, description, action, associated rules, and timestamps. This structure is useful for understanding the data returned when querying L7 policies.

```json
{
    "l7policy":
        {
            "listener_id": "023f2e34-7806-443b-bfae-16c324569a3d",
            "description": "Redirect requests to example.com",
            "admin_state_up": true,
            "rules": [
                {
                    "id": "efd6a3f8-73bf-47f0-8ae6-503ebda57372"
                }
            ],
            "created_at": "2017-06-24T23:25:14",
            "provisioning_status": "PENDING_UPDATE",
            "updated_at": "2017-06-24T23:30:05",
            "redirect_http_code": 301,
            "redirect_pool_id": null,
            "redirect_prefix": null,
            "redirect_url": "http://www.example.com",
            "action": "REDIRECT_TO_URL",
            "position": 1,
            "project_id": "e3cd678b11784734bc366148aa37580e",
            "id": "8a1412f0-4c32-4257-8b07-af4770b604fd",
            "operating_status": "ONLINE",
            "name": "redirect-example.com",
            "tags": ["updated_tag"]
        }
}

```
Tokens:
Raw