forked from docs/doc-exports
lizaoxu
ecf810a948
Reviewed-by: Muller, Martin <martin.muller@t-systems.com> Co-authored-by: lizaoxu <lizaoxu@huawei.com> Co-committed-by: lizaoxu <lizaoxu@huawei.com>
339 lines
27 KiB
HTML
339 lines
27 KiB
HTML
<a name="evs_04_3032"></a><a name="evs_04_3032"></a>
|
||
|
||
<h1 class="topictitle1">Querying EVS Disks</h1>
|
||
<div id="body1521533001620"><div class="section" id="evs_04_3032__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_3032__p43967757">This API is used to query EVS disks.</p>
|
||
</div>
|
||
<div class="section" id="evs_04_3032__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3032__ul4618564"><li id="evs_04_3032__li41567079">URI format<p id="evs_04_3032__p11490242"><a name="evs_04_3032__li41567079"></a><a name="li41567079"></a>GET /v3/{project_id}/volumes</p>
|
||
</li><li id="evs_04_3032__li36303315">Parameter description
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3032__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3032__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_3032__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_3032__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_3032__p1182010">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3032__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3032__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_3032__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_3032__p16154192">The project ID.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3032__li64846622153528">Request filter parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3032__en-us_topic_0058762430_table48630339152531" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3032__en-us_topic_0058762430_row30502978152531"><th align="left" class="cellrowborder" valign="top" width="17.82178217821782%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_3032__en-us_topic_0058762430_p54822134152531">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="17.643564356435643%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_3032__en-us_topic_0058762430_p11407863152531">Type</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="16.01980198019802%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_3032__en-us_topic_0058762430_p51621676152531">Mandatory</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="48.51485148514851%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_3032__en-us_topic_0058762430_p20606205152531">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3032__en-us_topic_0058762430_row58489940152531"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p49168107152914">marker</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p23193765152914">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p66755704152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__en-us_topic_0058762430_p38502923152914"><span id="evs_04_3032__text387847143818">The ID of the resource from which the pagination query starts. It is the ID of the last resource on the previous page.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row38948343152859"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p17125818152914">name</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p14491527153320">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p22259725152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__en-us_topic_0058762430_p58207321152914">The disk name. <span id="evs_04_3032__en-us_topic_0058762430_text37302935152245">The value can contain a maximum of 255 bytes.</span></p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row61932754152911"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p20335623152914">limit</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p36572733152914">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p9601396152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__en-us_topic_0058762430_p39515603152914">The maximum number of query results that can be returned.</p>
|
||
<p id="evs_04_3032__p149391124171211"><span id="evs_04_3032__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_3032__en-us_topic_0058762430_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_3032__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
|
||
<p id="evs_04_3032__en-us_topic_0058762430_p1233994321914"><strong id="evs_04_3032__b9984595891811">GET /v3/</strong><em id="evs_04_3032__i40797784691811">xxx</em><strong id="evs_04_3032__b172149191991811">/volumes?limit=50</strong>: Queries the 1–50 disks. <strong id="evs_04_3032__b842352706102346">GET /v3/</strong><em id="evs_04_3032__i587306121102343">xxx</em><strong id="evs_04_3032__b842352706102351">/volumes?offset=50&limit=50</strong>: Queries the 51–100 disks.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row4561665015299"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p17172513152914">sort_key</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p43305182153332">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p60186269152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__p43249593152914">The keyword based on which the returned results are sorted. The value can be <strong id="evs_04_3032__b11922195123812">id</strong>, <strong id="evs_04_3032__b149223512380">status</strong>, <strong id="evs_04_3032__b792212513813">size</strong>, or <strong id="evs_04_3032__b1192320519386">created_at</strong>, and the default value is <strong id="evs_04_3032__b179231557380">created_at</strong>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row5831630415296"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p54896674152914">sort_dir</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p4460297153338">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p3809857152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><div class="p" id="evs_04_3032__p2025341125211">The result sorting order. The default value is <strong id="evs_04_3032__b17261213819">desc</strong>.<ul id="evs_04_3032__ul107075455529"><li id="evs_04_3032__li3707445155211"><strong id="evs_04_3032__b174381914173816">desc</strong>: the descending order</li><li id="evs_04_3032__li4707144525219"><strong id="evs_04_3032__b1017211164380">asc</strong>: the ascending order</li></ul>
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row1669400215294"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p19336748152914">offset</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p22139675153443">Integer</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p32652321152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__p02247913491">The query offset.</p>
|
||
<p id="evs_04_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_row4150243115292"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p49243814152914">status</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p15960789153343">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p26598214152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__en-us_topic_0058762430_p6971702152914">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row33130210152857"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p49206403152914">metadata</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p6448822153343">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p49578561152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__en-us_topic_0058762430_p56440503152914">The disk metadata.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row20664390152531"><td class="cellrowborder" valign="top" width="17.82178217821782%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_p7393147152914">availability_zone</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="17.643564356435643%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_3032__en-us_topic_0058762430_p59504247153343">String</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="16.01980198019802%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_3032__en-us_topic_0058762430_p53841259152914">No</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_3032__en-us_topic_0058762430_p66174752152914">The AZ information.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3032__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_3032__en-us_topic_0058762430_p8131165310442">The following example shows how to query the disks in the <strong id="evs_04_3032__b12876163614711">available</strong> state.</p>
|
||
<ul id="evs_04_3032__en-us_topic_0058762430_ul28722627"><li id="evs_04_3032__en-us_topic_0058762430_li57177053">Example request<pre class="screen" id="evs_04_3032__en-us_topic_0058762430_screen13806089161140">GET https://{endpoint}/v3/{project_id}/volumes?status=available</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3032__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3032__en-us_topic_0058762430_ul37131542"><li id="evs_04_3032__li11713619182017">Response parameters
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3032__table47135197203" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3032__row1971411197206"><th align="left" class="cellrowborder" valign="top" width="21.52%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_3032__p18714119102015">Parameter</p>
|
||
</th>
|
||
<th align="left" class="cellrowborder" valign="top" width="21.34%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_3032__p2714171962013">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_3032__p1971411912014">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3032__row10714519142015"><td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3032__p171411918201">volumes</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3032__p471441982010">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_3032__p177147197207">The list of queried disks. For details, see <a href="#evs_04_3032__en-us_topic_0058762430_li3451542201439">Parameters in the volumes field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__row971541982016"><td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3032__p1715219112015">volumes_links</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3032__p157151719152012">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_3032__p671511199201">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_3032__row14715719102010"><td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3032__p10715141942016">count</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3032__p1366719501195">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_3032__p37151919162013">The number of records returned in this query.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__row1294462562116"><td class="cellrowborder" valign="top" width="21.52%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3032__p129522216412">error</p>
|
||
</td>
|
||
<td class="cellrowborder" valign="top" width="21.34%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3032__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_3032__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_3032__li0419202382514">Parameters in the error field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3032__en-us_topic_0058762430_li3451542201439"><a name="evs_04_3032__en-us_topic_0058762430_li3451542201439"></a><a name="en-us_topic_0058762430_li3451542201439"></a>Parameters in the <strong id="evs_04_3032__b71202377911">volumes</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3032__en-us_topic_0058762430_table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_p58539486142557">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3032__en-us_topic_0058762430_row444782011610"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_p4455949153059">The disk ID.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row44077962142557"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_p52622641153059">Array of objects</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_3032__en-us_topic_0058762430_p49157451153059">The disk URI. For details, see <a href="#evs_04_3032__en-us_topic_0058762430_li1077125119136">Parameters in the links field</a>.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_row16186817142557"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_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_3032__en-us_topic_0058762430_p14572483153059">The disk name. <span id="evs_04_3032__text1081494105183234">The value can contain a maximum of 255 bytes.</span></p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3032__en-us_topic_0058762430_li1077125119136"><a name="evs_04_3032__en-us_topic_0058762430_li1077125119136"></a><a name="en-us_topic_0058762430_li1077125119136"></a>Parameters in the <strong id="evs_04_3032__b84235270692535">links</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3032__en-us_topic_0058762430_en-us_topic_0058762429_table24355024185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_p47699944185927">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3032__en-us_topic_0058762430_en-us_topic_0058762429_row38490285185927"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_p53015590185927">The corresponding shortcut link.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__en-us_topic_0058762430_en-us_topic_0058762429_row7378265185927"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_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_3032__en-us_topic_0058762430_en-us_topic_0058762429_p57795935185927">The shortcut link marker name.</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</li><li id="evs_04_3032__li0419202382514"><a name="evs_04_3032__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_3032__evs_04_2013_b1288034833610">error</strong> field
|
||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3032__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3032__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_3032__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_3032__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_3032__evs_04_2013_p38578950103019">Description</p>
|
||
</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody><tr id="evs_04_3032__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_3032__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_3032__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_3032__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
|
||
</td>
|
||
</tr>
|
||
<tr id="evs_04_3032__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_3032__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_3032__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_3032__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
|
||
<p id="evs_04_3032__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_3032__en-us_topic_0058762430_li65748423">Example response<pre class="screen" id="evs_04_3032__screen9641442791">{
|
||
|
||
"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&marker=3f1b98ec-a8b5-4e92-a727-88def62d5ad3",
|
||
"rel": "next"
|
||
}
|
||
]
|
||
}</pre>
|
||
<p id="evs_04_3032__en-us_topic_0058762430_p52821068113531">or</p>
|
||
<pre class="screen" id="evs_04_3032__en-us_topic_0058762430_screen4594167995947">{
|
||
"error": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
<p id="evs_04_3032__en-us_topic_0058762430_p5655715720175">In the preceding example, <strong id="evs_04_3032__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_3032__b842352706144438">badRequest</strong> or <strong id="evs_04_3032__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
|
||
<pre class="screen" id="evs_04_3032__en-us_topic_0058762430_screen54581143201731">{
|
||
"badRequest": {
|
||
"message": "XXXX",
|
||
"code": "XXX"
|
||
}
|
||
}</pre>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3032__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3032__evs_04_2068_ul9862716"><li id="evs_04_3032__evs_04_2068_li21655584">Normal<p id="evs_04_3032__evs_04_2068_p60682533"><a name="evs_04_3032__evs_04_2068_li21655584"></a><a name="evs_04_2068_li21655584"></a>200</p>
|
||
</li></ul>
|
||
</div>
|
||
<div class="section" id="evs_04_3032__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3032__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_3028.html">EVS Disk</a></div>
|
||
</div>
|
||
</div>
|
||
|