Skip to content

Openstack Instance Availability Zones

Operations Summary

Method Endpoint Description
GET /api/openstack-instance-availability-zones/ List instance availability zones
GET /api/openstack-instance-availability-zones/{uuid}/ Get instance availability zone details

List instance availability zones

Get a list of instance availability zones.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instance-availability-zones/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instance_availability_zones import openstack_instance_availability_zones_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instance_availability_zones_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_instance_availability_zones_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackInstanceAvailabilityZonesList } from 'waldur-js-client';

try {
  const response = await openstackInstanceAvailabilityZonesList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
settings string Settings URL
settings_uuid string (uuid) Settings UUID
tenant string Tenant URL
tenant_uuid string (uuid) Tenant UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
available boolean Indicates whether this availability zone is available for instance provisioning

Get instance availability zone details

Retrieve details of a specific instance availability zone.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-instance-availability-zones/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_instance_availability_zones import openstack_instance_availability_zones_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_instance_availability_zones_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_instance_availability_zones_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackInstanceAvailabilityZonesRetrieve } from 'waldur-js-client';

try {
  const response = await openstackInstanceAvailabilityZonesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
settings string (uri)
available boolean Indicates whether this availability zone is available for instance provisioning