The openstack_dashboard.api.rest.cinder Module

API over the cinder service.

class openstack_dashboard.api.rest.cinder.DefaultQuotaSets(**kwargs)

Bases: django.views.generic.base.View

API for getting default quotas for cinder

get(request, *args, **kw)

Get the values for Cinder specific quotas

Example GET: http://localhost/api/cinder/quota-sets/defaults/

patch(request, *args, **kw)

Update the values for Cinder specific quotas

This method returns HTTP 204 (no content) on success.

url_regex = 'cinder/quota-sets/defaults/$'

class openstack_dashboard.api.rest.cinder.Extensions(**kwargs)

Bases: django.views.generic.base.View

API for cinder extensions.

get(request, *args, **kw)

Get a list of extensions.

The listing result is an object with property “items”. Each item is an extension.

Example GET: http://localhost/api/cinder/extensions

url_regex = 'cinder/extensions/$'

class openstack_dashboard.api.rest.cinder.QoSSpecs(**kwargs)

Bases: django.views.generic.base.View

get(request, *args, **kw)

url_regex = 'cinder/qosspecs/$'

class openstack_dashboard.api.rest.cinder.QuotaSets(**kwargs)

Bases: django.views.generic.base.View

API for setting quotas for a given project.

patch(request, *args, **kw)

Update a single project quota data.

The PATCH data should be an application/json object with the attributes to set to new quota values.

This method returns HTTP 204 (no content) on success.

url_regex = 'cinder/quota-sets/(?P<project_id>[0-9a-f]+)$'

class openstack_dashboard.api.rest.cinder.Services(**kwargs)

Bases: django.views.generic.base.View

API for cinder services.

get(request, *args, **kw)

Get a list of cinder services. Will return HTTP 501 status code if the service_list extension is not supported.

url_regex = 'cinder/services/$'

class openstack_dashboard.api.rest.cinder.TenantAbsoluteLimits(**kwargs)

Bases: django.views.generic.base.View

get(request, *args, **kw)

url_regex = 'cinder/tenantabsolutelimits/$'

class openstack_dashboard.api.rest.cinder.Volume(**kwargs)

Bases: django.views.generic.base.View

API for cinder volume.

get(request, *args, **kw)

Get a single volume’s details with the volume id.

The following get parameters may be passed in the GET

Parameters:volume_id – the id of the volume

The result is a volume object.

url_regex = 'cinder/volumes/(?P<volume_id>[^/]+)/$'

class openstack_dashboard.api.rest.cinder.VolumeSnapshots(**kwargs)

Bases: django.views.generic.base.View

API for cinder volume snapshots.

get(request, *args, **kw)

Get a detailed list of volume snapshots associated with the current user’s project.

The listing result is an object with property “items”.

url_regex = 'cinder/volumesnapshots/$'

class openstack_dashboard.api.rest.cinder.VolumeType(**kwargs)

Bases: django.views.generic.base.View

API for getting a volume type.

get(request, *args, **kw)

Get a single volume type details with the volume type id.

The following get parameters may be passed in the GET

Parameters:volumetype_id – the id of the volume type

If ‘default’ is passed as the volumetype_id then it returns the default volumetype

The result is a volume type object.

url_regex = 'cinder/volumetypes/(?P<volumetype_id>[^/]+)/$'

class openstack_dashboard.api.rest.cinder.VolumeTypes(**kwargs)

Bases: django.views.generic.base.View

API for volume types.

get(request, *args, **kw)

Get a list of volume types.

The listing result is an object with the property “items”.

url_regex = 'cinder/volumetypes/$'

class openstack_dashboard.api.rest.cinder.Volumes(**kwargs)

Bases: django.views.generic.base.View

API for cinder volumes.

get(request, *args, **kw)

Get a detailed list of volumes associated with the current user’s project.

Example GET: http://localhost/api/cinder/volumes?paginate=true&sort_dir=asc

If invoked as an admin, you may set the GET parameter “all_projects” to ‘true’ to return details for all projects.

The following get parameters may be passed in the GET

Parameters:

• search_opts – includes options such as name, status, bootable
• paginate – If true will perform pagination based on settings.
• marker – Specifies the namespace of the last-seen image. The typical pattern of limit and marker is to make an initial limited request and then to use the last namespace from the response as the marker parameter in a subsequent limited request. With paginate, limit is automatically set.
• sort_dir – The sort direction (‘asc’ or ‘desc’).

The listing result is an object with property “items”.

post(request, *args, **kw)

url_regex = 'cinder/volumes/$'