vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2068.html
Zaoxu, Li 305c41bb57 EVS 2.0.38 SP1 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2022-10-19 22:27:18 +00:00

331 lines
24 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="evs_04_2068"></a><a name="evs_04_2068"></a>
<h1 class="topictitle1">Querying EVS Disks</h1>
<div id="body1494051692085"><div class="section" id="evs_04_2068__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_2068__p43967757">This API is used to query EVS disks.</p>
</div>
<div class="section" id="evs_04_2068__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2068__ul4618564"><li id="evs_04_2068__li41567079">URI format<p id="evs_04_2068__p11490242"><a name="evs_04_2068__li41567079"></a><a name="li41567079"></a>GET /v2/{project_id}/volumes</p>
</li><li id="evs_04_2068__li36303315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2068__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2068__row24683273"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2068__p53188122">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2068__p13270664">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2068__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2068__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2068__p37653388">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2068__p30025596">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2068__p16154192">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2068__li64846622153528">Request filter parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2068__table48630339152531" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2068__row30502978152531"><th align="left" class="cellrowborder" valign="top" width="17.599999999999998%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2068__p54822134152531">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.54%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2068__p11407863152531">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.05%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2068__p51621676152531">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.809999999999995%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2068__p20606205152531">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2068__row58489940152531"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p49168107152914">marker</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p23193765152914">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p66755704152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p38502923152914"><span id="evs_04_2068__text138882914373">Specifies the ID of the last record on the previous page. The returned value is the value of the item after this one.</span></p>
</td>
</tr>
<tr id="evs_04_2068__row38948343152859"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p17125818152914">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p14491527153320">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p22259725152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p58207321152914">Specifies the disk name. <span id="evs_04_2068__text256503808201536">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2068__row61932754152911"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p20335623152914">limit</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p36572733152914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p9601396152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p39515603152914">Specifies the maximum number of query results that can be returned.</p>
<p id="evs_04_2068__p99431755191418"><span id="evs_04_2068__text138349551887">The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.</span></p>
<p id="evs_04_2068__p14657115572511">If the tenant has more than 50 disks in total, you are advised to use this parameter and set its value to <strong id="evs_04_2068__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
<p id="evs_04_2068__p1233994321914"><strong id="evs_04_2068__b9984595891811">GET /v2/</strong><em id="evs_04_2068__i40797784691811">xxx</em><strong id="evs_04_2068__b172149191991811">/volumes?limit=50</strong>: Queries the 1–50 disks. <strong id="evs_04_2068__b842352706102346">GET /v2/</strong><em id="evs_04_2068__i587306121102343">xxx</em><strong id="evs_04_2068__b842352706102351">/volumes?offset=50&amp;limit=50</strong>: Queries the 51–100 disks.</p>
</td>
</tr>
<tr id="evs_04_2068__row4561665015299"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p17172513152914">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p43305182153332">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p60186269152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p43249593152914">Specifies the keyword based on which the returned results are sorted. The value can be <strong id="evs_04_2068__b4477124205215">id</strong>, <strong id="evs_04_2068__b8481162412525">status</strong>, <strong id="evs_04_2068__b154811824125212">size</strong>, or <strong id="evs_04_2068__b104821244522">created_at</strong>, and the default value is <strong id="evs_04_2068__b4482182418529">created_at</strong>.</p>
</td>
</tr>
<tr id="evs_04_2068__row5831630415296"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p54896674152914">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p4460297153338">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p3809857152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><div class="p" id="evs_04_2068__p2025341125211">Specifies the result sorting order. The default value is <strong id="evs_04_2068__b194631533125210">desc</strong>.<ul id="evs_04_2068__ul107075455529"><li id="evs_04_2068__li3707445155211"><strong id="evs_04_2068__b154772344529">desc</strong>: indicates the descending order.</li><li id="evs_04_2068__li4707144525219"><strong id="evs_04_2068__b139815359524">asc</strong>: indicates the ascending order.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2068__row1669400215294"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p19336748152914">offset</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p22139675153443">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p32652321152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p1812219549521">Specifies the offset.</p>
<p id="evs_04_2068__p27592310152914">All disks after this offset will be queried. The value must be an integer greater than 0 but less than the number of disks.</p>
</td>
</tr>
<tr id="evs_04_2068__row4150243115292"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p49243814152914">status</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p15960789153343">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p26598214152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p6971702152914">Specifies the disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2068__row33130210152857"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p49206403152914">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p6448822153343">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p49578561152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p56440503152914">Specifies the disk metadata.</p>
</td>
</tr>
<tr id="evs_04_2068__row20664390152531"><td class="cellrowborder" valign="top" width="17.599999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2068__p7393147152914">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="16.54%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2068__p59504247153343">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.05%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2068__p53841259152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="48.809999999999995%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2068__p66174752152914">Specifies the AZ.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2068__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_2068__p8131165310442">The following example shows how to query the disks in the <strong id="evs_04_2068__b1730317469526">available</strong> state.</p>
<ul id="evs_04_2068__ul28722627"><li id="evs_04_2068__li57177053">Example request<pre class="screen" id="evs_04_2068__screen13806089161140">GET https://{endpoint}/v2/{project_id}/volumes?status=available</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2068__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2068__ul37131542"><li id="evs_04_2068__li78273306556">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2068__table682710305552" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2068__row18828730125511"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2068__p17828103014554">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2068__p982813025513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2068__p10828123085512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2068__row6828153014554"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2068__p1828130105513">volumes</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2068__p582813013559">list</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2068__p158281930195514">Specifies the list of queried disks. For details, see <a href="#evs_04_2068__li3451542201439">Parameters in the volumes field</a>.</p>
</td>
</tr>
<tr id="evs_04_2068__row16651711135716"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2068__p20139619153059">volumes_links</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2068__p20696419153059">list</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2068__p27977197153059">Specifies the query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query.</p>
</td>
</tr>
<tr id="evs_04_2068__row1383518379555"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2068__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2068__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2068__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2068__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2068__li3451542201439"><a name="evs_04_2068__li3451542201439"></a><a name="li3451542201439"></a>Parameters in the <strong id="evs_04_2068__b53964105319">volumes</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2068__table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2068__row12524911142557"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2068__p7884856142557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2068__p34693598142557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2068__p58539486142557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2068__row444782011610"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2068__p9640386153059">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2068__p42673774153059">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2068__p4455949153059">Specifies the disk ID.</p>
</td>
</tr>
<tr id="evs_04_2068__row44077962142557"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2068__p27161806153059">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2068__p52622641153059">list&lt;map&lt;String, String&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2068__p49157451153059">Specifies the disk URI. For details, see <a href="#evs_04_2068__li1077125119136">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2068__row16186817142557"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2068__p66757462153059">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2068__p38645307153059">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2068__p14572483153059">Specifies the disk name. <span id="evs_04_2068__text416107395201549">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2068__li1077125119136"><a name="evs_04_2068__li1077125119136"></a><a name="li1077125119136"></a>Parameters in the <strong id="evs_04_2068__evs_04_2067_b3190144816178">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2068__evs_04_2067_table24355024185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2068__evs_04_2067_row16225418185927"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_2068__evs_04_2067_p39190461185927">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_2068__evs_04_2067_p20310744185927">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.330000000000005%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_2068__evs_04_2067_p47699944185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2068__evs_04_2067_row38490285185927"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2068__evs_04_2067_p30705403185927">href</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2068__evs_04_2067_p4109689185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2068__evs_04_2067_p53015590185927">Specifies the corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2068__evs_04_2067_row7378265185927"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2068__evs_04_2067_p60768596185927">rel</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2068__evs_04_2067_p23309219185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2068__evs_04_2067_p57795935185927">Specifies the shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2068__li0419202382514"><a name="evs_04_2068__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2068__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2068__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2068__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_2068__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_2068__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_2068__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2068__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2068__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2068__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2068__evs_04_2013_p21623243103019">Specifies the error message returned when an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2068__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2068__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2068__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2068__evs_04_2013_p6087468103019">Specifies the error code returned when an error occurs.</p>
<p id="evs_04_2068__evs_04_2013_p54787218103019">For details about the error code, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2068__li65748423">Example response<pre class="screen" id="evs_04_2068__screen2628029316162">{
"volumes": [
{
"id": "6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
"links": [
{
"href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
"rel": "self"
},
{
"href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/6b604cef-9bd8-4f5a-ae56-45839e6e1f0a",
"rel": "bookmark"
}
],
"name": "zjb_u25_test"
},
{
"id": "2bce4552-9a7d-48fa-8484-abbbf64b206e",
"links": [
{
"href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
"rel": "self"
},
{
"href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/2bce4552-9a7d-48fa-8484-abbbf64b206e",
"rel": "bookmark"
}
],
"name": "zjb_u25_test"
},
{
"id": "3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"links": [
{
"href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"rel": "self"
},
{
"href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"rel": "bookmark"
}
],
"name": "zjb_u25_test"
}
],
"volumes_links": [
{
"href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes?limit=3&amp;marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
"rel": "next"
}
]
}</pre>
<p id="evs_04_2068__p52821068113531">or</p>
<pre class="screen" id="evs_04_2068__screen4594167995947">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2068__p5655715720175">In the preceding example, <strong id="evs_04_2068__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2068__b842352706144438">badRequest</strong> or <strong id="evs_04_2068__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2068__screen54581143201731">{
"badRequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2068__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2068__ul9862716"><li id="evs_04_2068__li21655584">Normal<p id="evs_04_2068__p60682533"><a name="evs_04_2068__li21655584"></a><a name="li21655584"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2068__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2068__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2064.html">EVS Disk</a></div>
</div>
</div>
View Git Blame Copy Permalink