doc-exports/docs/evs/api-ref/evs_04_2011.html
zhangyue f3b09e5d2f Elastic Volume Service API V1
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2023-02-02 16:28:20 +00:00

567 lines
44 KiB
HTML

<a name="evs_04_2011"></a><a name="evs_04_2011"></a>
<h1 class="topictitle1">Querying Details About a Disk</h1>
<div id="body1521551957245"><div class="section" id="evs_04_2011__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_2011__p1621162824117">This API is used to query details about a disk.</p>
</div>
<div class="section" id="evs_04_2011__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2011__ul4618564"><li id="evs_04_2011__li41567079">URI format<p id="evs_04_2011__p11490242"><a name="evs_04_2011__li41567079"></a><a name="li41567079"></a>GET /v2/{project_id}/os-vendor-volumes/{volume_id}</p>
</li><li id="evs_04_2011__li36303315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__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_2011__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_2011__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_2011__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2011__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_2011__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_2011__p16154192">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2011__row11170003"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2011__p32355065">volume_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_2011__p3514615">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_2011__p16248438">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2011__section45527389"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2011__ul105631347175718"><li id="evs_04_2011__li8563947195715">Example request<pre class="screen" id="evs_04_2011__screen154065815573">GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/b104b8db-170d-441b-897a-3c8ba9c5a214</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2011__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2011__ul37131542"><li id="evs_04_2011__li17924740165114">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__table10924124020519" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__row11924194015519"><th align="left" class="cellrowborder" valign="top" width="18.82%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2011__p1925340155113">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.580000000000002%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2011__p13925440205111">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.599999999999994%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2011__p99250405513">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__row159251409514"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2011__p1292513408516">volume</p>
</td>
<td class="cellrowborder" valign="top" width="23.580000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2011__p392564017518">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.599999999999994%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2011__p16925134045115">The queried disk. For details, see <a href="#evs_04_2011__li3451542201439">Parameters in the volume field</a>.</p>
</td>
</tr>
<tr id="evs_04_2011__row143812361506"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2011__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="23.580000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2011__evs_04_2010_p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.599999999999994%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2011__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2011__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2011__li3451542201439"><a name="evs_04_2011__li3451542201439"></a><a name="li3451542201439"></a>Parameters in the <strong id="evs_04_2011__b18282213124020">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__row12524911142557"><th align="left" class="cellrowborder" valign="top" width="18.82%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2011__p7884856142557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.53%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2011__p34693598142557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.65%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2011__p58539486142557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__row44077962142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p13545137142557">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p23414333142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p9255075142557">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2011__row16186817142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p36063800142557">links</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p35486679142557">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p27456944142557">The disk URI. For details, see <a href="#evs_04_2011__li4929184617138">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2011__row45785905142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p17670785142557">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p22047453142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p33742556142557">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2011__row35247553142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p36479557142557">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p2054104142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p55209810142557">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2011__row27126244142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p49742149142557">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p2582234142557">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p30604994142557">The disk attachment information. For details, see <a href="#evs_04_2011__li4186567617138">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2011__row7009490142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p30897802142557">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p19694010142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p27840420142557">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2011__row96919520562"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p8965337193314">count</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p12965143715331">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p13965237123320">The number of queried disks.</p>
</td>
</tr>
<tr id="evs_04_2011__row49237196142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p28789925142557">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p50282587142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p63987579142557">The source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_2011__p102771156662">This field is not supported currently.</p>
</td>
</tr>
<tr id="evs_04_2011__row39017307142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p6285295142557">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p39346916142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p54429968142557">The snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_2011__row20107664142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p18108106142557">description</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p57470472142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p46172338142557">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2011__row12897861142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p38093790142557">os-vol-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p65698111142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p5075579142557">The ID of the tenant to which the disk belongs. The tenant ID is the same as the project ID.</p>
</td>
</tr>
<tr id="evs_04_2011__row45680217142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p9110107142557">volume_image_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p66830090142557">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p50014861142557">The metadata of the disk image.</p>
<div class="note" id="evs_04_2011__note410975220289"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2011__evs_04_2009_p1888154732118">For details about <strong id="evs_04_2011__b31951313610">volume_image_metadata</strong>, see <strong id="evs_04_2011__b141951931561">Querying Image Details (Native OpenStack API)</strong> in the <em id="evs_04_2011__i171964317619">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2011__row44850461565"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p13966183733316">dedicated_storage_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p15966037113313">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p10966037183311">The ID of the DSS storage pool accommodating the disk.</p>
</td>
</tr>
<tr id="evs_04_2011__row174001446561"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p1696610370335">dedicated_storage_name</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p6966153743316">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p1496613371332">The name of the DSS storage pool accommodating the disk.</p>
</td>
</tr>
<tr id="evs_04_2011__row166262135919"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p1496763773312">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p796763713314">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p5967163712334">The ID of the enterprise project that the disk has been added to. This field is currently not supported.</p>
</td>
</tr>
<tr id="evs_04_2011__row47480567142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p20720700142557">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p655154142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p3501903142557">The time when the disk was created.</p>
<p id="evs_04_2011__p1834613217531">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2011__row31517135142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p2751105142557">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p21512968142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p16647604142557">The disk type.</p>
<div class="p" id="evs_04_2011__p12887229134510">The value can be <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b279274144111">ESSD</strong>, <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b167931044411">SSD</strong>, <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b87935416410">SAS</strong>, <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b1679312412411">SATA</strong>, <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b4794164144117">co-p1</strong>, or <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b187941744413">uh-l1</strong>.<ul id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_ul11489121916439"><li id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_2011__evs_04_2005_evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_2011__evs_04_2005_evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_2011__evs_04_2005_evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_li848817193433"><strong id="evs_04_2011__evs_04_2005_evs_04_2013_b821064223314">co-p1</strong>: the high I/O (performance-optimized I) type</li><li id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_li548917194430"><strong id="evs_04_2011__evs_04_2005_evs_04_2013_b543613460339">uh-l1</strong>: the ultra-high I/O (latency-optimized) type</li><li id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_2011__evs_04_2005_evs_04_2013_b9997162484116">ESSD</strong>: the extreme SSD type<p id="evs_04_2011__evs_04_2005_evs_04_2013_evs_04_2003_p19697421145811">The <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b65151219135318">co-p1</strong> and <strong id="evs_04_2011__evs_04_2005_evs_04_2013_b3515151925310">uh-l1</strong> types of disks are used exclusively for HPC ECSs and SAP HANA ECSs.</p>
</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2011__row15610713142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p56508275142557">size</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p13767590142557">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p628596142557">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2011__row5657368142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p55593700142557">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p6795819142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2011__evs_04_2010_p8780414125315">Whether the disk is bootable.<ul id="evs_04_2011__ul185931714111"><li id="evs_04_2011__li135936114118"><strong id="evs_04_2011__b124771811147">true</strong>: indicates a bootable disk.</li><li id="evs_04_2011__li1593611917"><strong id="evs_04_2011__b78502217142">false</strong>: indicates a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2011__row42462677142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p16924779142557">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p28729858142557">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p2976878614485">The disk metadata. For details, see <a href="#evs_04_2011__li29114110314">Parameters in the metadata field</a>.</p>
<p id="evs_04_2011__p6664089144810">If <strong id="evs_04_2011__b11744183251415">metadata</strong> does not contain the <strong id="evs_04_2011__b67471232191416">hw:passthrough</strong> field, the disk device type is VBD.</p>
<p id="evs_04_2011__p27113282155030">If <strong id="evs_04_2011__b6965195318143">metadata</strong> does not contain the <strong id="evs_04_2011__b79674539146">__system__encrypted</strong> field, the disk is not encrypted.</p>
</td>
</tr>
<tr id="evs_04_2011__row24435167142557"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p33091499142557">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p63165723142557">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p33074440142557">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row16261731102710"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p196753719335">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p9967203793316">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p296733783315">Whether the disk is encrypted.</p>
</td>
</tr>
<tr id="evs_04_2011__row319029143856"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p25841403143856">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p12778905143856">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p23431040143856">The time when the disk was updated.</p>
<p id="evs_04_2011__p088761318554">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2011__row1056515525115"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p12972437143319">os-volume-replication:driver_data</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p129721037143317">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p3972123715332">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row6226231314391"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p1008260514391">os-volume-replication:extended_status</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p1138464014391">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p246367414391">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row1430942214399"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p1821254814399">replication_status</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p6593029014399">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p5201068114399">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row1801485814395"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p4991739214395">os-vol-mig-status-attr:migstat</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p55570357144311">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p61763041144311">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row46340323144336"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p62578689144336">consistencygroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p20253849144646">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p9956989144646">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row36758187144417"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p24623167144417">os-vol-mig-status-attr:name_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p34730547144648">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p32527650144648">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row30115821144625"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p23462435144625">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p48108796144650">String</p>
<p id="evs_04_2011__p92310192476"></p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p28827892144650">Whether the disk is shareable.</p>
<div class="note" id="evs_04_2011__note3800959821323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2011__p45212589213213">This field is no longer used. Use <strong id="evs_04_2011__b1076135963414">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2011__row4658776614505"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p1551273614505">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p4857213114505">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p4886676914505">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2011__row16426724115040"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p59918584115045">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p21567161115045">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2011__evs_04_2010_p4781191416535">Whether the disk is shareable.<ul id="evs_04_2011__ul161621719119"><li id="evs_04_2011__li91631519818"><strong id="evs_04_2011__b49341731182015">true</strong>: indicates a shared disk.</li><li id="evs_04_2011__li1916311191410"><strong id="evs_04_2011__b145631935102012">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2011__row115471547175713"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p47811214165316">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p107811114125311">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p611625042712">The service type. The value is <strong id="evs_04_2011__b842352706181851">EVS</strong>.</p>
</td>
</tr>
<tr id="evs_04_2011__row1393175475712"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p69881644104318">tags</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p1198854414439">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p18988144418437">The disk tags.</p>
<p id="evs_04_2011__p898894418432">This field has values if the disk has tags. Or, it is left empty.</p>
</td>
</tr>
<tr id="evs_04_2011__row189091958125710"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2011__p149881344124319">wwn</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2011__p3988174494319">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2011__p6988244114313">The unique identifier used when attaching the disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2011__li4929184617138"><a name="evs_04_2011__li4929184617138"></a><a name="li4929184617138"></a>Parameters in the <strong id="evs_04_2011__b84235270692535">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__table53116786111129" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__row38921210111129"><th align="left" class="cellrowborder" valign="top" width="19.05%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_2011__p65610305111129">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.810000000000002%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_2011__p12834480111129">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_2011__p52513065111129">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__row25699842111129"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2011__p1312419111129">href</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2011__p39197109111129">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2011__p11067466111129">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2011__row32498335111129"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2011__p15119502111129">rel</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2011__p16720145111129">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2011__p44991477111129">The shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2011__li4186567617138"><a name="evs_04_2011__li4186567617138"></a><a name="li4186567617138"></a>Parameters in the <strong id="evs_04_2011__b1976649848">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__table2886066111147" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__row7036686111147"><th align="left" class="cellrowborder" valign="top" width="19.27807219278072%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_2011__p33100723111147">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.0975902409759%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_2011__p63912929111147">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.624337566243376%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_2011__p36546037111147">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__row7439020111147"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p65689739111147">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p19268667111147">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p55737901111147">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2011__row31879061111147"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p32067121111147">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p47300034111147">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p24142306111147">The ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_2011__row23348196112253"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p12155729112253">attached_at</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p45090011112253">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p19692132112253">The time when the disk was attached.</p>
<p id="evs_04_2011__p66401431193919">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2011__row15954169111147"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p17219276111147">host_name</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p52584153111147">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p65069243111147">The name of the physical host housing the cloud server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2011__row48752281111147"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p56620654111147">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p22870239111147">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p63332792111147">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2011__row33124222111147"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p65816302111147">device</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p29520255111147">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p6214946111147">The device name.</p>
</td>
</tr>
<tr id="evs_04_2011__row55934521111147"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2011__p34402351111147">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2011__p35127017111147">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2011__p16521419111147">The ID of the attached disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2011__li29114110314"><a name="evs_04_2011__li29114110314"></a><a name="li29114110314"></a>Parameters in the <strong id="evs_04_2011__b1011310498288">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__evs_04_3004_table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_3004_p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_3004_p177192813501">The encryption field in <strong id="evs_04_2011__b62420217374">metadata</strong>.<ul id="evs_04_2011__evs_04_3004_ul141951225145011"><li id="evs_04_2011__evs_04_3004_li191951925125013"><strong id="evs_04_2011__b16711324183714">0</strong>: indicates a non-encrypted disk.</li><li id="evs_04_2011__evs_04_3004_li11195192510508"><strong id="evs_04_2011__b18874182610377">1</strong>: indicates an encrypted disk.</li><li id="evs_04_2011__evs_04_3004_li191958257506">If this parameter does not appear, the disk is not encrypted.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_3004_p4159804295622">The encryption CMK ID in <strong id="evs_04_2011__b99424555517">metadata</strong>. This parameter is used together with <strong id="evs_04_2011__b1894310515514">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2011__b294375125518">cmkid</strong> is fixed at 36 bytes.</p>
</td>
</tr>
<tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_3004_p17177177145116">The parameter that describes the disk device type in <strong id="evs_04_2011__b199761213195519">metadata</strong>. The value can be <strong id="evs_04_2011__b497721314553">true</strong> or <strong id="evs_04_2011__b18977121395510">false</strong>.<ul id="evs_04_2011__evs_04_3004_ul14462208141855"><li id="evs_04_2011__evs_04_3004_li16942218141855"><strong id="evs_04_2011__b1826491975519">true</strong> indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported.</li><li id="evs_04_2011__evs_04_3004_li42055621173515"><strong id="evs_04_2011__b1024152525512">false</strong> indicates the VBD device type (the default type), which supports only simple SCSI read/write commands.</li><li id="evs_04_2011__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_2011__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_2011__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_2011__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_2011__evs_04_3004_p47931946183150">The clone method. If the disk is created from a snapshot, value <strong id="evs_04_2011__b75712416551">0</strong> indicates the linked cloning method.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2011__li0419202382514"><a name="evs_04_2011__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2011__b1650630135814">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2011__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2011__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_2011__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_2011__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_2011__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2011__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_2011__li65748423">Example response<pre class="screen" id="evs_04_2011__screen11700161114268">{
"volume": {
"attachments": [ ],
"links": [
{
"href": "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
"rel": "self"
},
{
"href": "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/volumes/591ac654-26d8-41be-bb77-4f90699d2d41",
"rel": "bookmark"
}
],
"availability_zone": "az-dc-1",
"os-vol-host-attr:host": "az-dc-1#SSD",
"encrypted": false,
"multiattach": true,
"updated_at": "2016-02-03T02:19:29.895237",
"os-volume-replication:extended_status": null,
"replication_status": "disabled",
"snapshot_id": null,
"id": "591ac654-26d8-41be-bb77-4f90699d2d41",
"size": 40,
"user_id": "fd03ee73295e45478d88e15263d2ee4e",
"os-vol-tenant-attr:tenant_id": "40acc331ac784f34842ba4f08ff2be48",
"volume_image_metadata": null,
"os-vol-mig-status-attr:migstat": null,
"metadata": {},
"tags": {
"key1": "value1",
"key2": "value2"
},
"status": "available",
"description": "auto-created_from_restore_from_backup",
"source_volid": null,
"consistencygroup_id": null,
"os-vol-mig-status-attr:name_id": null,
"name": "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9",
"bootable": "false",
"created_at": "2016-02-03T02:19:11.723797",
"volume_type": null,
"service_type": "EVS",
"wwn": " 688860300000d136fa16f48f05992360"
}
}</pre>
<p id="evs_04_2011__p47031911172618">or</p>
<pre class="screen" id="evs_04_2011__screen1370371118267">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2011__p470371102617">In the preceding example, <strong id="evs_04_2011__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2011__b842352706144438">badrequest</strong> or <strong id="evs_04_2011__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2011__screen570331112617">{
"badrequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2011__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2011__ul9862716"><li id="evs_04_2011__li21655584">Normal<p id="evs_04_2011__p60682533"><a name="evs_04_2011__li21655584"></a><a name="li21655584"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2011__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2011__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_2002.html">EVS Disk</a></div>
</div>
</div>