Removes WADL from v1 Block Storage API
Moves generalized info to API Reference Other patch adds backup extension info to API Reference Change-Id: I8abd1189c8948044047fa6cf19683c982f826c83
This commit is contained in:
Anne Gentle
parent
36dab19ef5
commit
47653c6aa7
@ -68,6 +68,19 @@ format="SVG" scale="60"/>
|
||||
<revhistory xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml">
|
||||
<revision>
|
||||
<date>2014-08-05</date>
|
||||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Removed and replaced WADL references with link to <link
|
||||
xlink:href="http://developer.openstack.org/api-ref-blockstorage-v1.html"
|
||||
><citetitle>Block Storage API v1
|
||||
(CURRENT)</citetitle></link>.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
</revision>
|
||||
<revision>
|
||||
<date>2014-06-17</date>
|
||||
<revdescription>
|
||||
@ -708,115 +721,8 @@ Date: Tue, 29 Nov 2011 00:35:24 GMT</computeroutput></screen>
|
||||
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml">
|
||||
<title>API operations</title>
|
||||
<section xml:id="Volumes">
|
||||
<title>Volumes</title>
|
||||
<para>A volume is a detachable block storage device. You can
|
||||
think of it as a USB hard drive. It can only be attached to
|
||||
one instance at a time.</para>
|
||||
<para><?rax-fo keep-with-next?>When making an API call to
|
||||
create, list, or delete volume(s), the following status values
|
||||
are possible:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>CREATING – The volume is being created.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>AVAILABLE – The volume is read to be attached to
|
||||
an instance.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ATTACHING – The volume is attaching to an
|
||||
instance.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>IN-USE – The volume is attached to an
|
||||
instance.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>DELETING – The volume is being deleted.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ERROR – An error has occurred with the
|
||||
volume.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ERROR_DELETING – There was an error deleting the
|
||||
volume.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl#volumes">
|
||||
<wadl:method href="createVolume"/>
|
||||
<wadl:method href="getVolumesSimple"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl#detail-volume">
|
||||
<wadl:method href="getVolumesDetail"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl#volume_id">
|
||||
<wadl:method href="getVolume"/>
|
||||
<wadl:method href="deleteVolume"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="Snapshots">
|
||||
<title>Snapshots</title>
|
||||
<para><?rax-fo keep-with-next?>A snapshot is a point in time
|
||||
copy of the data contained in a volume.</para>
|
||||
<para>When making an API call to create, list, or delete
|
||||
snapshot(s), the following status values are possible:</para>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>CREATING – The snapshot is being created.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>AVAILABLE – The snapshot is ready to be
|
||||
used.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>DELETING – The snapshot is being deleted.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ERROR – An error occurred with the
|
||||
snapshot.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>ERROR_DELETING – There was an error deleting the
|
||||
snapshot.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl#snapshots"/>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl#detail-snapshots"/>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/volume-api-v1.wadl#snapshot_id"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="Volume_Types">
|
||||
<title>Volume types</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#types">
|
||||
<wadl:method href="getVolumeTypes"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id">
|
||||
<wadl:method href="getVolumeType"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="ext-os-quota-sets-cinder">
|
||||
<title>Quota sets extension (os-quota-sets)</title>
|
||||
<para>Administrators only, depending on policy settings. View,
|
||||
update, and delete quotas for a tenant.</para>
|
||||
<wadl:resources
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v1/os-quota-sets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<para>For information about Block Storage API operations, see <link
|
||||
xlink:href="http://developer.openstack.org/api-ref-blockstorage-v1.html"
|
||||
><citetitle>Block Storage API v1 (CURRENT)</citetitle></link>.</para>
|
||||
</chapter>
|
||||
</book>
|
||||
|
||||
@ -63,6 +63,19 @@ format="SVG" scale="60"/>
|
||||
Programming Interface (<abbrev>API</abbrev>).</para>
|
||||
</abstract>
|
||||
<revhistory>
|
||||
<revision>
|
||||
<date>2014-08-13</date>
|
||||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Removed and replaced WADL references with links to <link
|
||||
xlink:href="http://developer.openstack.org/api-ref-blockstorage-v2.html"
|
||||
><citetitle>Block Storage API v2
|
||||
(CURRENT)</citetitle></link>.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
</revision>
|
||||
<revision>
|
||||
<date>2014-06-17</date>
|
||||
<revdescription>
|
||||
@ -749,281 +762,9 @@ Date: Tue, 29 Nov 2011 00:35:24 GMT</computeroutput></screen>
|
||||
xmlns:svg="http://www.w3.org/2000/svg"
|
||||
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml">
|
||||
<title>API operations</title>
|
||||
<section xml:id="Volumes">
|
||||
<title>Volumes</title>
|
||||
<para>A volume is a detachable block storage device. You can
|
||||
think of it as a USB hard drive. You can attach a volume to
|
||||
one instance at a time.</para>
|
||||
<para>When you create, list, or delete volumes, these status
|
||||
values are possible:</para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><para>creating</para></td>
|
||||
<td><para>The volume is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>available</para></td>
|
||||
<td><para>The volume is ready to be attached to an
|
||||
instance.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>attaching</para></td>
|
||||
<td><para>The volume is attaching to an
|
||||
instance.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>in-use</para></td>
|
||||
<td><para>The volume is attached to an
|
||||
instance.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>deleting</para></td>
|
||||
<td><para>The volume is being deleted.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>error</para></td>
|
||||
<td><para>An error occurred during volume
|
||||
creation.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>error_deleting</para></td>
|
||||
<td><para>An error occurred during volume
|
||||
deletion.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>backing-up</para></td>
|
||||
<td><para>The volume is being backed up.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>restoring-backup</para></td>
|
||||
<td><para>A backup is being restored to the
|
||||
volume.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para>error_restoring</para></td>
|
||||
<td><para>An error occurred during backup restoration to a
|
||||
volume.</para></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#volumes">
|
||||
<wadl:method href="createVolume"/>
|
||||
<wadl:method href="getVolumesSimple"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#detail">
|
||||
<wadl:method href="getVolumesDetail"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#volume_id">
|
||||
<wadl:method href="getVolume"/>
|
||||
<wadl:method href="updateVolume"/>
|
||||
<wadl:method href="deleteVolume"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="Snapshots">
|
||||
<title>Snapshots</title>
|
||||
<para>A snapshot is a point in time copy of the data that a
|
||||
volume contains.</para>
|
||||
<para>When you create, list, or delete snapshots, these status
|
||||
values are possible:</para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<para>creating</para></td>
|
||||
<td><para>The snapshot is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>available</para></td>
|
||||
<td><para>The snapshot is ready to be used.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>deleting</para></td>
|
||||
<td><para>The snapshot is being deleted.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error</para></td>
|
||||
<td><para>An error occurred during snapshot
|
||||
creation.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error_deleting</para></td>
|
||||
<td><para>An error occurred during snapshot
|
||||
deletion.</para></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#snapshots"/>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#detail-snapshot"/>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#snapshot_id"
|
||||
/>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="Volume_Types">
|
||||
<title>Volume types</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#types">
|
||||
<wadl:method href="getVolumeTypes"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-api-v2.wadl#volume_type_id">
|
||||
<wadl:method href="getVolumeType"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="qos-cinder-v2">
|
||||
<title>Quality of service (QoS) specifications
|
||||
(qos-specs)</title>
|
||||
<para>Administrators only, depending on policy settings. Create,
|
||||
list, show details for, associate, disassociate, and delete
|
||||
quality of service (QoS) specifications.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-qos-v2.wadl#qos-specs">
|
||||
<wadl:method href="#createQoSSpec"/>
|
||||
<wadl:method href="#listQoSSpecs"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-qos-v2.wadl#qos_id"/>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-qos-v2.wadl#associate">
|
||||
<wadl:method href="#associateQoSSpec"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate">
|
||||
<wadl:method href="#disassociateQoSSpec"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-qos-v2.wadl#disassociate_all">
|
||||
<wadl:method href="#disassociateQoSSpecAll"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-qos-v2.wadl#associations">
|
||||
<wadl:method href="#getQoSAssociations"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="ext-os-quota-sets-cinder">
|
||||
<title>Quota sets extension (os-quota-sets)</title>
|
||||
<para>Administrators only, depending on policy settings. View,
|
||||
update, and delete quotas for a tenant.</para>
|
||||
<wadl:resources
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-quota-sets.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="ext-os-limits-cinder">
|
||||
<title>Limits extension (limits)</title>
|
||||
<para>Show absolute limits for a tenant.</para>
|
||||
<wadl:resources
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/os-limits.wadl"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
|
||||
</section>
|
||||
<section xml:id="Backups">
|
||||
<title>Backups extension</title>
|
||||
<para>A backup is a full copy of a volume stored in an external
|
||||
service. The service can be configured. The only supported
|
||||
service for now is Object Storage. A backup can subsequently
|
||||
be restored from the external service to either the same
|
||||
volume that the backup was originally taken from, or to a new
|
||||
volume. backup and restore operations can only be carried out
|
||||
on volumes which are in an unattached and available
|
||||
state.</para>
|
||||
<para>When you create, list, or delete backups, these status
|
||||
values are possible:</para>
|
||||
<informaltable rules="all">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Status</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<para>creating</para></td>
|
||||
<td><para>The backup is being created.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>available</para></td>
|
||||
<td><para>The backup is ready to be restored to a
|
||||
volume.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>deleting</para></td>
|
||||
<td><para>The backup is being deleted.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error</para></td>
|
||||
<td><para>An error has occurred with the
|
||||
backup.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>restoring</para></td>
|
||||
<td><para>The backup is being restored to a
|
||||
volume.</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para>error_restoring</para></td>
|
||||
<td><para>An error occurred during backup restoration to a
|
||||
volume.</para></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<para>In the event of an error, more information about the error
|
||||
can be found in the <literal>fail_reason</literal> field for
|
||||
the backup.</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl#backups">
|
||||
<wadl:method href="#createBackup"/>
|
||||
<wadl:method href="#listBackups"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl#detail">
|
||||
<wadl:method href="#listBackupsDetails"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl#backup_id">
|
||||
<wadl:method href="#showBackup"/>
|
||||
<wadl:method href="#deleteBackup"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource
|
||||
href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/volume-api/src/v2/volume-backups-api-v2.wadl#restore">
|
||||
<wadl:method href="#restoreBackup"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<title>API operations and extensions</title>
|
||||
<para>For information about Block Storage API operations and extensions, see <link
|
||||
xlink:href="http://developer.openstack.org/api-ref-blockstorage-v2.html"
|
||||
><citetitle>Block Storage API v2 (CURRENT)</citetitle></link>.</para>
|
||||
</chapter>
|
||||
</book>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user