Correct example output for "List Volume Details"
In OpenStack Block Storage Service API v2 Reference - API v2 Replaced file https://github.com/openstack/volume-api/blob/master/v2/src /samples/volume_list_detail_response.json With http://git.openstack.org/cgit/openstack/api-site/tree/api-ref/src /wadls/volume-api/src/v2/samples/volume_list_detail_response.json Change-Id: If58bf5a92755ec7dc52355da483c1f1dc4266ecd backport: havana Closes-Bug: #1258533
This commit is contained in:
Miranda Zhang
Diane Fleming
parent
a29fe1180e
commit
bbd2437ef7
@ -70,12 +70,24 @@ format="SVG" scale="60"/>
|
||||
</legalnotice>
|
||||
<abstract>
|
||||
<para>This document is for software developers who develop
|
||||
applications by using the OpenStack Block Storage Service Application Programming
|
||||
Interface (<abbrev>API</abbrev>). </para>
|
||||
applications by using the OpenStack Block Storage Service
|
||||
Application Programming Interface (<abbrev>API</abbrev>).
|
||||
</para>
|
||||
</abstract>
|
||||
<revhistory>
|
||||
<revision>
|
||||
<!-- ... continue addding more revisions here as you change this document using the markup shown below... -->
|
||||
<date>2013-12-14</date>
|
||||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
<listitem>
|
||||
<para>Corrected code example for list volume details
|
||||
request.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</revdescription>
|
||||
</revision>
|
||||
<revision>
|
||||
<date>2013-05-22</date>
|
||||
<revdescription>
|
||||
<itemizedlist spacing="compact">
|
||||
@ -165,8 +177,8 @@ format="SVG" scale="60"/>
|
||||
xmlns:m="http://www.w3.org/1998/Math/MathML"
|
||||
xmlns:html="http://www.w3.org/1999/xhtml">
|
||||
<title>Overview</title>
|
||||
<para>OpenStack Block Storage Service is a block-level storage solution that enables
|
||||
you to: <itemizedlist>
|
||||
<para>OpenStack Block Storage Service is a block-level storage
|
||||
solution that enables you to: <itemizedlist>
|
||||
<listitem>
|
||||
<para>Mount drives to OpenStack Cloud Servers<trademark/> to
|
||||
scale storage without paying for more compute
|
||||
@ -780,29 +792,29 @@ X-Compute-Request-Id: req-8e0295cd-a283-46e4-96da-cae05cbfd1c7
|
||||
<td>&GET;</td>
|
||||
<td>/volumes</td>
|
||||
<td>Lists a summary of all volumes defined in Block
|
||||
Storage that are accessible to the tenant who submits
|
||||
the request.</td>
|
||||
Storage that the tenant who submits the request can
|
||||
access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/volumes/<parameter>volume_id</parameter></td>
|
||||
<td>Lists detailed information for the specified
|
||||
<td>Lists detailed information for a specified
|
||||
volume.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>&POST;</td>
|
||||
<td>/volumes</td>
|
||||
<td>Creates a new Block Storage volume.</td>
|
||||
<td>Creates a Block Storage volume.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>&PUT;</td>
|
||||
<td>/volumes/<parameter>volume_id</parameter></td>
|
||||
<td>Updates the specified volume.</td>
|
||||
<td>Updates a specified volume.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>&DELETE;</td>
|
||||
<td>/volumes/<parameter>volume_id</parameter></td>
|
||||
<td>Destroys the specified volume.</td>
|
||||
<td>Deletes a specified volume.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
@ -858,8 +870,8 @@ Accept: application/json</literallayout>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/volumes</td>
|
||||
<td>Lists volumes defined in Block Storage that are
|
||||
accessible to the tenant who submits the request. </td>
|
||||
<td>Lists volumes defined in Block Storage that the
|
||||
tenant who submits the request can access. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
@ -892,19 +904,19 @@ Accept: application/json </literallayout>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/volumes/details</td>
|
||||
<td>Lists detailed information for volumes defined in
|
||||
Block Storage that are accessible to the tenant who
|
||||
submits the request. </td>
|
||||
<td>Lists detailed information for Block Storage volumes
|
||||
that the tenant who submits the request can access.
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
<example>
|
||||
<title>List Volumes: JSON Request</title>
|
||||
<title>List Volume Details: JSON Request</title>
|
||||
<literallayout class="monospaced">GET /&VERSION;/volumes/details
|
||||
Accept: application/json </literallayout>
|
||||
</example>
|
||||
<example>
|
||||
<title>List Volumes: JSON Response</title>
|
||||
<title>List Volume Details: JSON Response</title>
|
||||
<programlisting language="json"><xi:include href="samples/volume_list_detail_response.json" parse="text"/></programlisting>
|
||||
</example>
|
||||
<para>Returns status code <returnvalue>200</returnvalue> on
|
||||
@ -1091,8 +1103,8 @@ Accept: application/json</literallayout>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/snapshots</td>
|
||||
<td>Lists snapshots defined in Block Storage that are
|
||||
accessible to the tenant who submits the request. </td>
|
||||
<td>Lists snapshots defined in Block Storage that the
|
||||
tenant who submits the request can access. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
@ -1126,8 +1138,8 @@ Accept: application/json </literallayout>
|
||||
<td>&GET;</td>
|
||||
<td>/snapshots/details</td>
|
||||
<td>Lists detailed information for snapshots defined in
|
||||
Block Storage that are accessible to the tenant who
|
||||
submits the request. </td>
|
||||
Block Storage that the tenant who submits the request
|
||||
can access. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
@ -1372,15 +1384,15 @@ Accept: application/json </literallayout>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/backups</td>
|
||||
<td>Lists backups defined in Block Storage that are
|
||||
accessible to the tenant who submits the request.</td>
|
||||
<td>Lists backups defined in Block Storage that the
|
||||
tenant who submits the request can access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/backups/detail</td>
|
||||
<td>Lists detailed information for backups defined in
|
||||
Block Storage that are accessible to the tenant who
|
||||
submits the request.</td>
|
||||
Block Storage that the tenant who submits the request
|
||||
can access.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
@ -1457,8 +1469,8 @@ Accept: application/json </literallayout>
|
||||
<tr>
|
||||
<td>&GET;</td>
|
||||
<td>/backups</td>
|
||||
<td>Lists backups defined in Block Storage that are
|
||||
accessible to the tenant who submits the request. </td>
|
||||
<td>Lists backups defined in Block Storage that the
|
||||
tenant who submits the request can access. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
@ -1492,8 +1504,8 @@ Accept: application/json </literallayout>
|
||||
<td>&GET;</td>
|
||||
<td>/backups/details</td>
|
||||
<td>Lists detailed information for backups defined in
|
||||
Block Storage that are accessible to the tenant who
|
||||
submits the request. </td>
|
||||
Block Storage that the tenant who submits the
|
||||
request can access. </td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</informaltable>
|
||||
|
||||
@ -1,32 +1,64 @@
|
||||
{
|
||||
"volumes":[
|
||||
{
|
||||
"id":"45baf976-c20a-4894-a7c3-c94b7376bf55",
|
||||
"status":"available",
|
||||
"attachments":[
|
||||
|
||||
],
|
||||
"links":[
|
||||
{
|
||||
"href":"http://54.241.241.145:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
|
||||
"href":"http://localhost:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
|
||||
"rel":"self"
|
||||
},
|
||||
{
|
||||
"href":"http://54.241.241.145:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
|
||||
"href":"http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/45baf976-c20a-4894-a7c3-c94b7376bf55",
|
||||
"rel":"bookmark"
|
||||
}
|
||||
],
|
||||
"name":"vol-004"
|
||||
"availability_zone":"nova",
|
||||
"os-vol-host-attr:host":"ip-10-168-107-25",
|
||||
"source_volid":null,
|
||||
"snapshot_id":null,
|
||||
"id":"45baf976-c20a-4894-a7c3-c94b7376bf55",
|
||||
"description":"Another volume.",
|
||||
"name":"vol-004",
|
||||
"created_at":"2013-02-25T06:36:28.000000",
|
||||
"volume_type":"None",
|
||||
"os-vol-tenant-attr:tenant_id":"0c2eba2c5af04d3f9e9d0d410b371fde",
|
||||
"size":1,
|
||||
"metadata":{
|
||||
"contents":"junk"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id":"5aa119a8-d25b-45a7-8d1b-88e127885635",
|
||||
"status":"available",
|
||||
"attachments":[
|
||||
|
||||
],
|
||||
"links":[
|
||||
{
|
||||
"href":"http://54.241.241.145:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
|
||||
"href":"http://localhost:8776/v2/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
|
||||
"rel":"self"
|
||||
},
|
||||
{
|
||||
"href":"http://54.241.241.145:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
|
||||
"href":"http://localhost:8776/0c2eba2c5af04d3f9e9d0d410b371fde/volumes/5aa119a8-d25b-45a7-8d1b-88e127885635",
|
||||
"rel":"bookmark"
|
||||
}
|
||||
],
|
||||
"name":"vol-003"
|
||||
"availability_zone":"nova",
|
||||
"os-vol-host-attr:host":"ip-10-168-107-25",
|
||||
"source_volid":null,
|
||||
"snapshot_id":null,
|
||||
"id":"5aa119a8-d25b-45a7-8d1b-88e127885635",
|
||||
"description":"This is yet, another volume.",
|
||||
"name":"vol-003",
|
||||
"created_at":"2013-02-25T02:40:21.000000",
|
||||
"volume_type":"None",
|
||||
"os-vol-tenant-attr:tenant_id":"0c2eba2c5af04d3f9e9d0d410b371fde",
|
||||
"size":1,
|
||||
"metadata":{
|
||||
"contents":"not junk"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user