Table Of Contents

This Page

Psst... hey. You're reading the latest content, but it might be out of sync with code. You can read Nova 2011.2 docs or all OpenStack docs too.

About The Volumes Extension

This extension enables volume management on virtual servers. It is used with the OpenStack Compute 1.1 API to add or remove fixed IP addresses on named instances.

To use this extension, you must have configured Compute to manage volumes.

To obtain current information the extensions available to you, issue an EXTENSION query on the OpenStack system where it is installed, such as http://mycloud.com/v1.1/tenant/extensions.

Volumes Extension Overview

Name
Volumes
Namespace
http://docs.openstack.org/ext/volumes/api/v1.1
Alias
OPS-VOL
Contact
Name <justin@fathomdb.com>
Status
Alpha
Extension Version
v1.0 (2011-09-14)
Dependencies
Compute API 1.1
Doc Link (PDF)
http://
Doc Link (WADL)
http://
Short Description
This extension enables listing of volumes available to virtual servers running in an OpenStack cloud. You can create, attach, and detach a volume with this extension.

Sample Query Responses

As shown below, responses to an EXTENSION query in XML or JSON provide basic information about the extension.

Extension Query Response: XML:

Extension Query Response: JSON:

{"extensions": [{"updated": "2011-03-25T00:00:00+00:00", "name": "Volumes", "links": [], "namespace": "http://docs.openstack.org/ext/volumes/api/v1.1", "alias": "os-volumes", "description": "Volumes support"}]}

Document Change History

Revision Date Summary of Changes
2011-09-14 Initial draft

Summary of Changes

This extension to the Compute API allows volume management through the OpenStack Compute API.

To support these new actions, the extension also issues new (faults, headers, resources, states, you name it.)

New Action

This extension uses POST to attach or detach volumes to instances.

Normal Response Code: 202

Enter “None” if there are no changes to the sections below.

Include the response codes, transitions if applicable, and XML and JSON examples.

New Faults

New Headers

New Resources

New States

Changes to the Cloud Servers Specification

List the specific changes to the API. For example:

In section 4.1.1 (List Servers) of the Cloud Servers Specification: Examples 4.1 and 4.2 should be replaced with Example 2.7 and Example 2.8 below.

Provide examples in XML and JSON