vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2069.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

613 lines
52 KiB
HTML
Raw Permalink 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_2069"></a><a name="evs_04_2069"></a>
<h1 class="topictitle1">Querying Details About All Disks</h1>
<div id="body1494051692091"><div class="section" id="evs_04_2069__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_2069__p43967757">This API is used to query details about all disks.</p>
</div>
<div class="section" id="evs_04_2069__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2069__ul4618564"><li id="evs_04_2069__li41567079">URI format<p id="evs_04_2069__p11490242"><a name="evs_04_2069__li41567079"></a><a name="li41567079"></a>GET /v2/{project_id}/volumes/detail</p>
</li><li id="evs_04_2069__li36303315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__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_2069__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_2069__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_2069__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2069__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_2069__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_2069__p16154192">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2069__li56682808">Request filter parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__table4291376694520" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__row75210794520"><th align="left" class="cellrowborder" valign="top" width="18.6%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2069__p6092069194520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2069__p3562891594520">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.919999999999998%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2069__p26101294520">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.63%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2069__p2114201394520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__row3478152794520"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p60095082153718">marker</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p35863456153718">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p19258860153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p16463795153718"><span id="evs_04_2069__text1666413213419">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_2069__row2183600894520"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p56729311153718">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p38113769154021">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p15250867153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p27360714153718">Specifies the disk name. <span id="evs_04_2069__text557493116201645">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2069__row4640654394520"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p14628184153718">limit</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p44032231153718">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p9840947153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p58919203153718">Specifies the maximum number of query results that can be returned.</p>
<p id="evs_04_2069__p1412911417152"><span id="evs_04_2069__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_2069__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_2069__b8423527069161">50</strong> to improve the query efficiency. Examples are provided as follows:</p>
<p id="evs_04_2069__p1233994321914"><strong id="evs_04_2069__b320873402103755">GET /v2/</strong><em id="evs_04_2069__i1514898224103755">xxx</em><strong id="evs_04_2069__b738773580103755">/volumes/detail?limit=50</strong>: Queries the 1–50 disks. <strong id="evs_04_2069__b842352706103810">GET /v2/</strong><em id="evs_04_2069__i197699858310388">xxx</em><strong id="evs_04_2069__b842352706103816">/volumes/detail?offset=50&amp;limit=50</strong>: Queries the 51–100 disks.</p>
</td>
</tr>
<tr id="evs_04_2069__row6054321594520"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p2426142153718">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p43526083154024">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p13119059153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p56010871153718">Specifies the keyword based on which the returned results are sorted. The value can be <strong id="evs_04_2069__b1323065485511">id</strong>, <strong id="evs_04_2069__b1723118546555">status</strong>, <strong id="evs_04_2069__b1523165419550">size</strong>, or <strong id="evs_04_2069__b5232155414552">created_at</strong>, and the default value is <strong id="evs_04_2069__b1823295495513">created_at</strong>.</p>
</td>
</tr>
<tr id="evs_04_2069__row5521380794520"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p29735682153718">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p16700889154026">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p10345862153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><div class="p" id="evs_04_2069__p62620581361">Specifies the result sorting order. The default value is <strong id="evs_04_2069__b596612596554">desc</strong>.<ul id="evs_04_2069__ul022952573"><li id="evs_04_2069__li32291228717"><strong id="evs_04_2069__b149057020567">desc</strong>: indicates the descending order.</li><li id="evs_04_2069__li12290218716"><strong id="evs_04_2069__b57865275610">asc</strong>: indicates the ascending order.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2069__row49871977153626"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p20840349153718">offset</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p10346748153718">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p32780292153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p98722321465">Specifies the offset.</p>
<p id="evs_04_2069__p37957980153718">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_2069__row2837320153624"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p22515601153718">status</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p53812252154029">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p18251790153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p2000007153718">Specifies the disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2069__row34125704153621"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p48719302153718">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p31082833154032">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p7822125153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p29612385153718">Specifies the disk metadata.</p>
</td>
</tr>
<tr id="evs_04_2069__row61070326153619"><td class="cellrowborder" valign="top" width="18.6%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2069__p45483948153718">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2069__p23816783154035">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.919999999999998%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2069__p54179442153718">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2069__p26458700153718">Specifies the AZ.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2069__section45527389"><h4 class="sectiontitle">Request</h4><p id="evs_04_2069__p8131165310442">The following example shows how to query details of the disks in the <strong id="evs_04_2069__b4966161305611">available</strong> state.</p>
<ul id="evs_04_2069__ul28722627"><li id="evs_04_2069__li57177053">Example request<pre class="screen" id="evs_04_2069__screen13806089161140">GET https://{endpoint}/v2/{project_id}/volumes/detail?status=available</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2069__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2069__ul37131542"><li id="evs_04_2069__li78273306556">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__table682710305552" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__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_2069__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_2069__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_2069__p10828123085512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__row6828153014554"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2069__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_2069__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_2069__p158281930195514">Specifies the list of queried disks. For details, see <a href="#evs_04_2069__li3451542201439">Parameters in the volumes field</a>.</p>
</td>
</tr>
<tr id="evs_04_2069__row16651711135716"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2069__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_2069__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_2069__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. For details, see <a href="#evs_04_2069__li851885019247">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2069__row1383518379555"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2069__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_2069__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_2069__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2069__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2069__li3451542201439"><a name="evs_04_2069__li3451542201439"></a><a name="li3451542201439"></a>Parameters in the <strong id="evs_04_2069__b1466884515598">volumes</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__row12524911142557"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2069__p7884856142557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2069__p34693598142557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2069__p58539486142557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__row444782011610"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p54175786153922">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p26162565153922">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p55227932153922">Specifies the disk ID.</p>
</td>
</tr>
<tr id="evs_04_2069__row44077962142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p62953588153922">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p494261191750">list&lt;map&lt;String,String&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p379966153922">Specifies the disk URI. For details, see <a href="#evs_04_2069__li851885019247">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2069__row16186817142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p8559918153922">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p38279089154138">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p50401086153922">Specifies the disk name.</p>
</td>
</tr>
<tr id="evs_04_2069__row45785905142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p33843531153922">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p15510513154140">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p60776191153922">Specifies the disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2069__row35247553142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p13993091153922">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p59698591153922">list</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p35128232153922">Specifies the disk attachment information. For details, see <a href="#evs_04_2069__li5001921919316">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2069__row27126244142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p40004503153922">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p51760296154143">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p12372460153922">Specifies the AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2069__row7009490142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p26935952153922">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p61285780154145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p12079427153922"><span id="evs_04_2069__text657995710581">Reserved field</span></p>
</td>
</tr>
<tr id="evs_04_2069__row49237196142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p14641407153922">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p15993974154147">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p40148014153922">Specifies the source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_2069__p1587817436328"><span id="evs_04_2069__text18357144552617">Currently, this field is not supported by EVS.</span></p>
</td>
</tr>
<tr id="evs_04_2069__row39017307142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p8437822153922">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p43970411154151">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p57569910153922">Specifies the snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_2069__row20107664142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p25424812153922">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p16247974154153">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p22193516153922">Specifies the disk description.</p>
</td>
</tr>
<tr id="evs_04_2069__row12897861142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p5837556153922">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p30798966154156">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p8308266153922">Specifies the time when the disk was created.</p>
<p id="evs_04_2069__p15772145473814"><span id="evs_04_2069__text151181202390">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2069__row45680217142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p16928326153922">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p35495495154158">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p60775887153922">Specifies the disk type.</p>
<div class="p" id="evs_04_2069__p12887229134510">Currently, the value can be <strong id="evs_04_2069__evs_04_2003_b842352706164929">SSD</strong>, <strong id="evs_04_2069__evs_04_2003_b842352706164932">SAS</strong>, <strong id="evs_04_2069__evs_04_2003_b842352706164937">SATA</strong>, <strong id="evs_04_2069__evs_04_2003_b842352706164941">co-p1</strong>, or <strong id="evs_04_2069__evs_04_2003_b842352706164944">uh-l1</strong>.<ul id="evs_04_2069__evs_04_2003_ul11489121916439"><li id="evs_04_2069__evs_04_2003_li15488111934310"><strong id="evs_04_2069__evs_04_2003_b842352706165021">SSD</strong>: specifies the ultra-high I/O disk type.</li><li id="evs_04_2069__evs_04_2003_li0488119194318"><strong id="evs_04_2069__evs_04_2003_b1784237562165049">SAS</strong>: specifies the high I/O disk type.</li><li id="evs_04_2069__evs_04_2003_li348881917438"><strong id="evs_04_2069__evs_04_2003_b3295367816515">SATA</strong>: specifies the common I/O disk type.</li><li id="evs_04_2069__evs_04_2003_li848817193433"><strong id="evs_04_2069__evs_04_2003_b141033785">co-p1</strong>: specifies the high I/O (performance-optimized I) disk type.</li><li id="evs_04_2069__evs_04_2003_li548917194430"><strong id="evs_04_2069__evs_04_2003_b1336833005">uh-l1</strong>: specifies the ultra-high I/O (latency-optimized) disk type.<p id="evs_04_2069__evs_04_2003_p14488819154320">Disks of the <strong id="evs_04_2069__evs_04_2003_b108664633815116">co-p1</strong> and <strong id="evs_04_2069__evs_04_2003_b104594858115116">uh-l1</strong> types are used exclusively for HPC ECSs and SAP HANA ECSs.</p>
</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2069__row47480567142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p13771931153922">os-vol-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p4873995415420">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p9058246153922">Specifies the ID of the tenant to which the disk belongs. <span id="evs_04_2069__text19941457165313">The tenant ID is actually the project ID.</span></p>
</td>
</tr>
<tr id="evs_04_2069__row31517135142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p26792948153922">size</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p22745155153922">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p47959551153922">Specifies the disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2069__row15610713142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p65903514153922">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p36584404153922">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p63055822144653">Specifies the disk metadata. For details, see <a href="#evs_04_2069__li29114110314">Parameters in the metadata field</a>.</p>
<p id="evs_04_2069__p1210013914474">If <strong id="evs_04_2069__evs_04_2005_b842352706182520">metadata</strong> does not contain the <strong id="evs_04_2069__evs_04_2005_b842352706143434">hw:passthrough</strong> field, the disk device type is VBD.</p>
<p id="evs_04_2069__p3812802015506">If <strong id="evs_04_2069__evs_04_2005_b842352706182629">metadata</strong> does not contain the <strong id="evs_04_2069__evs_04_2005_b842352706143455">__system__encrypted</strong> field, the disk is not encrypted.</p>
</td>
</tr>
<tr id="evs_04_2069__row5657368142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p5824606153922">os-vol-mig-status-attr:migstat</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p28057958154213">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p38401827153922"><span id="evs_04_2069__text7576132237">Reserved field</span></p>
</td>
</tr>
<tr id="evs_04_2069__row42462677142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p10535641153922">os-vol-mig-status-attr:name_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p41814751154216">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p45371608153922"><span id="evs_04_2069__text203605127103">Reserved field</span></p>
</td>
</tr>
<tr id="evs_04_2069__row35655683142957"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p42283458153922">os-volume-replication:extended_status</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p9813320154224">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p28603805153922"><span id="evs_04_2069__text379518478151">Reserved field</span></p>
</td>
</tr>
<tr id="evs_04_2069__row57913155185111"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p47452553185118">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p18451581185118">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p27951625185124"><span id="evs_04_2069__text1610112322316">Currently, this field is not supported by EVS.</span></p>
</td>
</tr>
<tr id="evs_04_2069__row6226231314391"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p50459706153922">replication_status</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p43392623154228">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p57639660153922"><span id="evs_04_2069__text13830109172317">Reserved field</span></p>
</td>
</tr>
<tr id="evs_04_2069__row1430942214399"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p9163288153922">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p28184221154230">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p16698134793611">Reserved field</p>
</td>
</tr>
<tr id="evs_04_2069__row1801485814395"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p13972139153922">consistencygroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p60028304154232">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p40663722153922">Specifies the ID of the consistency group where the disk belongs.</p>
<p id="evs_04_2069__p1890419561322"><span id="evs_04_2069__text16334171582811">Currently, this field is not supported by EVS.</span></p>
</td>
</tr>
<tr id="evs_04_2069__row53974058144326"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p48844805153922">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p26156143154240">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2069__evs_04_2010_p8780414125315">Specifies whether the disk is bootable.<ul id="evs_04_2069__ul185931714111"><li id="evs_04_2069__li135936114118"><strong id="evs_04_2069__b1758062272117">true</strong>: specifies a bootable disk.</li><li id="evs_04_2069__li1593611917"><strong id="evs_04_2069__b037922312116">false</strong>: specifies a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2069__row46340323144336"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p57039357153922">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p51292786154244">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p46488385153922">Specifies the time when the disk was updated.</p>
<p id="evs_04_2069__p14195114017102"><span id="evs_04_2069__text8196154011011">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2069__row36758187144417"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p56950153922">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p4612960153922">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p66643618153922">Specifies whether the disk is shareable.</p>
<div class="note" id="evs_04_2069__note3800959821323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2069__p45212589213213">This field is no longer used. Use <strong id="evs_04_2069__b84235270610834">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2069__row4658776614505"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p63488919153922">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p42328837153922">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2069__evs_04_2010_p4781191416535">Specifies whether the disk is shareable.<ul id="evs_04_2069__ul161621719119"><li id="evs_04_2069__li91631519818"><strong id="evs_04_2069__b1152162642119">true</strong>: specifies a shared disk.</li><li id="evs_04_2069__li1916311191410"><strong id="evs_04_2069__b1967128122110">false</strong>: specifies a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2069__row29234512142557"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2069__p5432339153922">volume_image_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2069__p37366318153922">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2069__p11733449153922">Specifies the metadata of the disk image. This field has a value if the disk is created from an image. Otherwise, it is left empty.</p>
<div class="note" id="evs_04_2069__note13108526174911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2069__evs_04_2009_p1888154732118">For details about <strong id="evs_04_2069__evs_04_2009_b1583910241610">volume_image_metadata</strong>, see <strong id="evs_04_2069__evs_04_2009_b48471428167">Querying Image Details (Native OpenStack API)</strong> in the <em id="evs_04_2069__evs_04_2009_i1384712215164">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2069__li851885019247"><a name="evs_04_2069__li851885019247"></a><a name="li851885019247"></a>Parameters in the <strong id="evs_04_2069__evs_04_2067_b3190144816178">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__evs_04_2067_table24355024185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__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_2069__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_2069__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_2069__evs_04_2067_p47699944185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__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_2069__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_2069__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_2069__evs_04_2067_p53015590185927">Specifies the corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2069__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_2069__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_2069__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_2069__evs_04_2067_p57795935185927">Specifies the shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2069__li5001921919316"><a name="evs_04_2069__li5001921919316"></a><a name="li5001921919316"></a>Parameters in the <strong id="evs_04_2069__evs_04_2067_b84235270692535">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__evs_04_2067_table6503386185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__evs_04_2067_row1296819185927"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_2069__evs_04_2067_p37933504185927">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_2069__evs_04_2067_p52714965185927">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_2069__evs_04_2067_p50913593185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__evs_04_2067_row30360408185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p43274016185927">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p15534392185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p49891705185927">Specifies the ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2067_row49550172185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p54141023185927">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p23346722185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p35416329185927">Specifies the ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2067_row35650386185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p2000176185927">attached_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p27796542185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p38329099185927">Specifies the time when the disk was attached.</p>
<p id="evs_04_2069__evs_04_2067_p3414132514312"><span id="evs_04_2069__evs_04_2067_text7299269449">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2067_row9417574185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p24626033185927">host_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p48551632185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p48591276185927">Specifies the name of the physical host accommodating the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2067_row34668301185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p56668991185927">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p26785545185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p48959624185927">Specifies the disk ID.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2067_row41070280185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p38358373185927">device</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p20020490185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p22392462185927">Specifies the device name.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2067_row205574185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2067_p16651565185927">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2067_p6599487185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2067_p14021450185927">Specifies the ID of the attached resource.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2069__li29114110314"><a name="evs_04_2069__li29114110314"></a><a name="li29114110314"></a>Parameters in the <strong id="evs_04_2069__evs_04_3004_b1734614164165">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__evs_04_3004_table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__evs_04_3004_row4496975195554"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.4.2.5.2.1.4.1.1"><p id="evs_04_2069__evs_04_3004_p8809200174410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.62%" id="mcps1.3.4.2.5.2.1.4.1.2"><p id="evs_04_2069__evs_04_3004_p168135017449">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.5.2.1.4.1.3"><p id="evs_04_2069__evs_04_3004_p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__evs_04_3004_row456195295554"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_2069__evs_04_3004_p1562408795622">__system__encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_2069__evs_04_3004_p5759155095622">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><div class="p" id="evs_04_2069__evs_04_3004_p177192813501">Specifies the parameter that describes the encryption function in <strong id="evs_04_2069__evs_04_3004_b84235270614509">metadata</strong>. The value can be <strong id="evs_04_2069__evs_04_3004_b842352706145015">0</strong> or <strong id="evs_04_2069__evs_04_3004_b842352706145020">1</strong>.<ul id="evs_04_2069__evs_04_3004_ul141951225145011"><li id="evs_04_2069__evs_04_3004_li191951925125013"><strong id="evs_04_2069__evs_04_3004_b842352706145038">0</strong>: indicates the disk is not encrypted.</li><li id="evs_04_2069__evs_04_3004_li11195192510508"><strong id="evs_04_2069__evs_04_3004_b842352706145058">1</strong>: indicates the disk is encrypted.</li><li id="evs_04_2069__evs_04_3004_li191958257506">If this parameter does not appear, the disk is not encrypted by default.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2069__evs_04_3004_row247050109562"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_2069__evs_04_3004_p241272995622">__system__cmkid</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_2069__evs_04_3004_p6121338895622">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="evs_04_2069__evs_04_3004_p4159804295622">Specifies the encryption CMK ID in <strong id="evs_04_2069__evs_04_3004_b84235270615116">metadata</strong>. This parameter is used together with <strong id="evs_04_2069__evs_04_3004_b842352706143827">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2069__evs_04_3004_b84235270614396">cmkid</strong> is fixed at 36 bytes.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_3004_row60499086104915"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_2069__evs_04_3004_p1478896104915">hw:passthrough</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_2069__evs_04_3004_p52681767104915">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><div class="p" id="evs_04_2069__evs_04_3004_p17177177145116">Specifies the parameter that describes the disk device type in <strong id="evs_04_2069__evs_04_3004_b84235270615173">metadata</strong>. The value can be <strong id="evs_04_2069__evs_04_3004_b842352706151718">true</strong> or <strong id="evs_04_2069__evs_04_3004_b842352706151722">false</strong>.<ul id="evs_04_2069__evs_04_3004_ul14462208141855"><li id="evs_04_2069__evs_04_3004_li16942218141855">If this parameter is set to <strong id="evs_04_2069__evs_04_3004_b55868159103732">true</strong>, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media and supports SCSI reservation commands.</li><li id="evs_04_2069__evs_04_3004_li42055621173515">If this parameter is set to <strong id="evs_04_2069__evs_04_3004_b1524131935716">false</strong>, the disk device type is VBD (the default type), that is, Virtual Block Device (VBD), which supports only simple SCSI read/write commands.</li><li id="evs_04_2069__evs_04_3004_li922714915316">If this parameter does not appear, the disk device type is VBD.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2069__evs_04_3004_row991210132288"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_2069__evs_04_3004_p3500156018292">full_clone</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_2069__evs_04_3004_p1655411118292">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="evs_04_2069__evs_04_3004_p47931946183150">Specifies the clone method. When the disk is created from a snapshot, the parameter value is <strong id="evs_04_2069__evs_04_3004_b84235270616922">0</strong>, indicating the linked cloning method.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2069__li0419202382514"><a name="evs_04_2069__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2069__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2069__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2069__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.6.2.1.4.1.1"><p id="evs_04_2069__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.6.2.1.4.1.2"><p id="evs_04_2069__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.6.2.1.4.1.3"><p id="evs_04_2069__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2069__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.6.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2013_p21623243103019">Specifies the error message returned when an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2069__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.1 "><p id="evs_04_2069__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.2 "><p id="evs_04_2069__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.6.2.1.4.1.3 "><p id="evs_04_2069__evs_04_2013_p6087468103019">Specifies the error code returned when an error occurs.</p>
<p id="evs_04_2069__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_2069__li65748423">Example response<pre class="screen" id="evs_04_2069__screen11857182153634">{
"volumes": [
{
"attachments": [ ],
"availability_zone": "az-dc-1",
"bootable": "false",
"consistencygroup_id": null,
"created_at": "2016-05-25T02:42:10.856332",
"description": null,
"encrypted": false,
"id": "b104b8db-170d-441b-897a-3c8ba9c5a214",
"links": [
{
"href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel": "self"
},
{
"href": "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel": "bookmark"
}
],
"metadata": {},
"name": "zjb_u25_test",
"os-vol-host-attr:host": "pod01.xxx#SATA",
"volume_image_metadata": { },
"os-vol-mig-status-attr:migstat": null,
"os-vol-mig-status-attr:name_id": null,
"os-vol-tenant-attr:tenant_id": "dd14c6ac581f40059e27f5320b60bf2f",
"os-volume-replication:extended_status": null,
"replication_status": "disabled",
"multiattach": false,
"size": 1,
"snapshot_id": null,
"source_volid": null,
"status": "available",
"updated_at": "2016-05-25T02:42:22.341984",
"user_id": "b0524e8342084ef5b74f158f78fc3049",
"volume_type": "SATA"
}
],
"volumes_links": [
{
"href": "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/detail?limit=1&amp;marker=b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel": "next"
}
]
}</pre>
<p id="evs_04_2069__p8355436185729">or</p>
<pre class="screen" id="evs_04_2069__screen59558308185754">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2069__p5655715720175">In the preceding example, <strong id="evs_04_2069__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2069__b842352706144438">badrequest</strong> or <strong id="evs_04_2069__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2069__screen54581143201731">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
} </pre>
</li></ul>
</div>
<div class="section" id="evs_04_2069__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2069__ul9862716"><li id="evs_04_2069__li21655584">Normal<p id="evs_04_2069__p60682533"><a name="evs_04_2069__li21655584"></a><a name="li21655584"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2069__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2069__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