Skip to content

Openstack Images

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-images/ List images
GET /api/openstack-images/{uuid}/ Get image details
Other Actions
GET /api/openstack-images/usage_stats/ Get image usage statistics

Core CRUD

List images

Get a list of available VM instance images.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-images/ \
  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_images import openstack_images_list # (1)

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

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

try {
  const response = await openstackImagesList({
  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)
offering_uuid string (uuid) Offering UUID
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
min_disk integer Minimum disk size in MiB
min_ram integer Minimum memory size in MiB
settings string (uri)
backend_id string

Get image details

Retrieve details of a specific VM instance image.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-images/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_images import openstack_images_retrieve # (1)

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

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

try {
  const response = await openstackImagesRetrieve({
  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
min_disk integer Minimum disk size in MiB
min_ram integer Minimum memory size in MiB
settings string (uri)
backend_id string

Other Actions

Get image usage statistics

Retrieve usage statistics for VM instance images, showing running and created instance counts for each image.

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

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_images import openstack_images_usage_stats_retrieve # (1)

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

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

try {
  const response = await openstackImagesUsageStatsRetrieve({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
min_disk integer Minimum disk size in MiB
min_ram integer Minimum memory size in MiB
settings string (uri)
backend_id string