vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_0052.html
zhangyue ccbf63b495 EVS API DOC 
Reviewed-by: Muller, Martin <martin.muller@t-systems.com>
Reviewed-by: Sabelnikov, Dmitriy <dmitriy.sabelnikov@t-systems.com>
Co-authored-by: zhangyue <zhangyue164@huawei.com>
Co-committed-by: zhangyue <zhangyue164@huawei.com>
2024-05-16 09:08:21 +00:00

426 lines
36 KiB
HTML
Raw Blame History

<a name="evs_04_0052"></a><a name="evs_04_0052"></a>
<h1 class="topictitle1">Querying Details About a Disk (Deprecated)</h1>
<div id="body1494051692098"><div class="section" id="evs_04_0052__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_0052__p43967757">This API is used to query details about a disk. It does not support enterprise project authorization.</p>
<div class="notice" id="evs_04_0052__note182951651102614"><span class="noticetitle"><img src="public_sys-resources/notice_3.0-en-us.png"> </span><div class="noticebody"><p id="evs_04_0052__p29514165276">This API has been deprecated. Use another API. For details, see <a href="evs_04_3034.html">Querying Details About a Disk</a>.</p>
</div></div>
</div>
<div class="section" id="evs_04_0052__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_0052__ul4618564"><li id="evs_04_0052__li41567079">URI format<p id="evs_04_0052__p11490242"><a name="evs_04_0052__li41567079"></a><a name="li41567079"></a>GET /v1/{project_id}/volumes/{volume_id}</p>
</li><li id="evs_04_0052__li36303315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0052__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0052__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_0052__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_0052__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_0052__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0052__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_0052__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_0052__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_0052__p16154192">The project ID.</p>
</td>
</tr>
<tr id="evs_04_0052__row11170003"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_0052__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_0052__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_0052__p16248438">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_0052__section45527389"><h4 class="sectiontitle">Request</h4><ul id="evs_04_0052__ul151723154812"><li id="evs_04_0052__li17632310485">Example request<pre class="screen" id="evs_04_0052__screen1835153019484">GET https://{endpoint}/v1/{project_id}/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214</pre>
</li></ul>
</div>
<div class="section" id="evs_04_0052__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_0052__ul37131542"><li id="evs_04_0052__li4976142420436">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0052__table18977112434313" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0052__row3977132419439"><th align="left" class="cellrowborder" valign="top" width="22.467753224677534%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_0052__p159773247431">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.297570242975702%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_0052__p12977324154317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.23467653234677%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_0052__p597722424317">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0052__row89773247438"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0052__p1397772413439">volume</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0052__p29771324204317">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0052__p179771624124315">The disk information. For details, see <a href="#evs_04_0052__li3451542201439">Parameters in the volume field</a>.</p>
</td>
</tr>
<tr id="evs_04_0052__row987510557481"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_0052__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_0052__evs_04_2010_p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_0052__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_0052__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0052__li3451542201439"><a name="evs_04_0052__li3451542201439"></a><a name="li3451542201439"></a>Parameters in the <strong id="evs_04_0052__b4977222113311">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0052__table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0052__row12524911142557"><th align="left" class="cellrowborder" valign="top" width="22.467753224677534%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_0052__p7884856142557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.297570242975702%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_0052__p34693598142557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.23467653234677%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_0052__p58539486142557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0052__row444782011610"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p66683282154651">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p32636789154651">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p9255075142557"><span id="evs_04_0052__text193761052172315">The disk ID.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row44077962142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p30586043154651">display_name</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p9772661154635">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p38052791154651">The disk name.</p>
</td>
</tr>
<tr id="evs_04_0052__row16186817142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p24524218154651">status</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p3143623154637">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p29828016154651">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_0052__row45785905142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p1352242154651">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p42422738154651">list</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p35126047154651">The attachment information.</p>
</td>
</tr>
<tr id="evs_04_0052__row35247553142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p38411786154651">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p62102892154639">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p21400414154651">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_0052__row27126244142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p31645621154651">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p44910102154640">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p30932940154651"><span id="evs_04_0052__text8624191685913">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row7009490142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p1535595154651">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p62551737154640">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p34514964154651">The source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_0052__p11914151216505"><span id="evs_04_0052__text18357144552617">This field is currently not supported.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row49237196142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p62693997154651">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p28398340154644">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p18936934154651">The snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_0052__row39017307142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p47707972154651">display_description</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p40680894154646">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p42443707154651">The disk description.</p>
</td>
</tr>
<tr id="evs_04_0052__row20107664142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p4276225154651">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p55282734154647">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p54211604154651">The time when the disk was created.</p>
<p id="evs_04_0052__p128341116112619"><span id="evs_04_0052__text19834191618261">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_0052__row12897861142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p60247422154651">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p51779673154648">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p42804410154651">The disk type.</p>
<div class="p" id="evs_04_0052__p12887229134510">The value can be <strong id="evs_04_0052__evs_04_2003_evs_04_2013_b18986209175810">ESSD</strong>, <strong id="evs_04_0052__evs_04_2003_evs_04_2013_b139865912588">GPSSD</strong>, <strong id="evs_04_0052__evs_04_2003_evs_04_2013_b198719145816">SSD</strong>, <strong id="evs_04_0052__evs_04_2003_evs_04_2013_b1198714910584">SAS</strong>, or <strong id="evs_04_0052__evs_04_2003_evs_04_2013_b17987193587">SATA</strong>.<ul id="evs_04_0052__evs_04_2003_evs_04_2013_ul13901722818"><li id="evs_04_0052__evs_04_2003_evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_0052__evs_04_2003_evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_0052__evs_04_2003_evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_0052__evs_04_2003_evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_0052__evs_04_2003_evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_0052__evs_04_2003_evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_0052__evs_04_2003_evs_04_2013_evs_04_2003_li1444614485511"><strong id="evs_04_0052__evs_04_2003_evs_04_2013_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="evs_04_0052__evs_04_2003_evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_0052__evs_04_2003_evs_04_2013_b529917133589">ESSD</strong>: the extreme SSD type</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_0052__row45680217142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p65902234154651">os-vol-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p14564094154649">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p7523113475716">The ID of the tenant to which the disk belongs. <span id="evs_04_0052__text19941457165313">The tenant ID is the same as the project ID.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row47480567142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p22901376154651">size</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p43072149154651">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p947705154651">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_0052__row31517135142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p19789024154651">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2010_p159017261855">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p4822480314495">The disk metadata.</p>
</td>
</tr>
<tr id="evs_04_0052__row15610713142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p45218866154651">os-vol-mig-status-attr:migstat</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p37723694154653">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2010_p978016142531"><span id="evs_04_0052__text203605127103">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row5657368142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p7111161154651">os-vol-mig-status-attr:name_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p2604538915471">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p61553832154651"><span id="evs_04_0052__text117680327233">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row24435167142557"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p4466064154651">os-volume-replication:extended_status</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p944841515473">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p10508856154651"><span id="evs_04_0052__text379518478151">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row15562216185816"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p53797707185823">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p62647029185823">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p63407626185825"><span id="evs_04_0052__text14572822181912">This field is currently not supported.</span></p>
</td>
</tr>
<tr id="evs_04_0052__row319029143856"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p41938891154651">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p4460388215477">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_0052__evs_04_2067_evs_04_2010_p8780414125315">Whether the disk is bootable.<ul id="evs_04_0052__evs_04_2067_ul185931714111"><li id="evs_04_0052__evs_04_2067_li135936114118"><strong id="evs_04_0052__b1963262316212">true</strong>: indicates a bootable disk.</li><li id="evs_04_0052__evs_04_2067_li1593611917"><strong id="evs_04_0052__b1567242517210">false</strong>: indicates a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_0052__row6226231314391"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p56347645154651">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p368674015478">String</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p64877853154651">Whether the disk is shareable.</p>
<div class="note" id="evs_04_0052__note1645730517525"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_0052__evs_04_2013_p45212589213213">This field is no longer used. Use <strong id="evs_04_0052__evs_04_2013_b84235270610834">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_0052__row1430942214399"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p51315026154651">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p4808386110597">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_0052__evs_04_2067_evs_04_2010_p4781191416535">Whether the disk is shareable.<ul id="evs_04_0052__evs_04_2067_ul161621719119"><li id="evs_04_0052__evs_04_2067_li91631519818"><strong id="evs_04_0052__b67250521821">true</strong>: indicates a shared disk.</li><li id="evs_04_0052__evs_04_2067_li1916311191410"><strong id="evs_04_0052__b1096920541828">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_0052__row1801485814395"><td class="cellrowborder" valign="top" width="22.467753224677534%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_0052__p43505026154651">volume_image_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="24.297570242975702%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_0052__p34246222154651">Object</p>
</td>
<td class="cellrowborder" valign="top" width="53.23467653234677%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_0052__p8988855154651">The metadata of the disk image. This field has a value if the disk is created from an image. Or, it is left empty.</p>
<div class="note" id="evs_04_0052__note151343244518"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_0052__evs_04_2009_p1888154732118">For details about <strong id="evs_04_0052__evs_04_2009_b1583910241610">volume_image_metadata</strong>, see <strong id="evs_04_0052__evs_04_2009_b48471428167">Querying Image Details (Native OpenStack API)</strong> in the <em id="evs_04_0052__evs_04_2009_i1384712215164">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0052__li11209832191352">Parameters in the <strong id="evs_04_0052__evs_04_2067_b84235270692535">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0052__evs_04_2067_table6503386185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0052__evs_04_2067_row1296819185927"><th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_0052__evs_04_2067_p37933504185927">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_0052__evs_04_2067_p52714965185927">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_0052__evs_04_2067_p50913593185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0052__evs_04_2067_row30360408185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p43274016185927">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p15534392185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p49891705185927">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2067_row49550172185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p54141023185927">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p23346722185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p35416329185927">The ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2067_row35650386185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p2000176185927">attached_at</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p27796542185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p38329099185927">The time when the disk was attached.</p>
<p id="evs_04_0052__evs_04_2067_p3414132514312"><span id="evs_04_0052__evs_04_2067_text7299269449">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2067_row9417574185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p24626033185927">host_name</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p48551632185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p48591276185927">The name of the physical host housing the cloud server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2067_row34668301185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p56668991185927">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p26785545185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p48959624185927">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2067_row41070280185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p38358373185927">device</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p20020490185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p22392462185927">The device name.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2067_row205574185927"><td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2067_p16651565185927">id</p>
</td>
<td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2067_p6599487185927">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2067_p14021450185927">The ID of the attached disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0052__li29114110314">Parameters in the <strong id="evs_04_0052__evs_04_3004_b1734614164165">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0052__evs_04_3004_table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0052__evs_04_3004_row4496975195554"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_0052__evs_04_3004_p8809200174410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.62%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_0052__evs_04_3004_p168135017449">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_0052__evs_04_3004_p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0052__evs_04_3004_row456195295554"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0052__evs_04_3004_p1562408795622">__system__encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0052__evs_04_3004_p5759155095622">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><div class="p" id="evs_04_0052__evs_04_3004_p177192813501">The encryption field in <strong id="evs_04_0052__evs_04_3004_b84235270614509">metadata</strong>.<ul id="evs_04_0052__evs_04_3004_ul141951225145011"><li id="evs_04_0052__evs_04_3004_li191951925125013"><strong id="evs_04_0052__evs_04_3004_b87781551824">0</strong>: indicates a non-encrypted disk.</li><li id="evs_04_0052__evs_04_3004_li11195192510508"><strong id="evs_04_0052__evs_04_3004_b181881011732">1</strong>: indicates an encrypted disk.</li><li id="evs_04_0052__evs_04_3004_li191958257506">If this parameter does not appear, the disk is not encrypted.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_0052__evs_04_3004_row247050109562"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0052__evs_04_3004_p241272995622">__system__cmkid</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0052__evs_04_3004_p6121338895622">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0052__evs_04_3004_p4159804295622">The encryption CMK ID in <strong id="evs_04_0052__evs_04_3004_b84235270615116">metadata</strong>. This parameter is used together with <strong id="evs_04_0052__evs_04_3004_b842352706143827">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_0052__evs_04_3004_b84235270614396">cmkid</strong> is fixed at 36 bytes.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_3004_row60499086104915"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0052__evs_04_3004_p1478896104915">hw:passthrough</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0052__evs_04_3004_p52681767104915">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><div class="p" id="evs_04_0052__evs_04_3004_p17177177145116">The parameter that describes the disk device type in <strong id="evs_04_0052__evs_04_3004_b13632941434">metadata</strong>. The value can be <strong id="evs_04_0052__evs_04_3004_b116336411432">true</strong> or <strong id="evs_04_0052__evs_04_3004_b36337410319">false</strong>.<ul id="evs_04_0052__evs_04_3004_ul14462208141855"><li id="evs_04_0052__evs_04_3004_li16942218141855"><strong id="evs_04_0052__evs_04_3004_b46462521314">true</strong> indicates the SCSI device type, which allows ECS OSs to directly access the underlying storage media and support SCSI reservations commands.</li><li id="evs_04_0052__evs_04_3004_li42055621173515"><strong id="evs_04_0052__evs_04_3004_b938710292410">false</strong> indicates the VBD device type (the default type), which supports only simple SCSI read/write commands.</li><li id="evs_04_0052__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_0052__evs_04_3004_row991210132288"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_0052__evs_04_3004_p3500156018292">full_clone</p>
</td>
<td class="cellrowborder" valign="top" width="22.62%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_0052__evs_04_3004_p1655411118292">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_0052__evs_04_3004_p47931946183150">The clone method. If the disk is created from a snapshot, value <strong id="evs_04_0052__evs_04_3004_b337155114417">0</strong> indicates the linked cloning method.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_0052__li0419202382514"><a name="evs_04_0052__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_0052__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_0052__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_0052__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.5.2.1.4.1.1"><p id="evs_04_0052__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.5.2.1.4.1.2"><p id="evs_04_0052__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.5.2.1.4.1.3"><p id="evs_04_0052__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_0052__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_0052__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.1 "><p id="evs_04_0052__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.5.2.1.4.1.2 "><p id="evs_04_0052__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.5.2.1.4.1.3 "><p id="evs_04_0052__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_0052__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_0052__li65748423">Example response<pre class="screen" id="evs_04_0052__screen4205040216212">{
"volume": {
"attachments": [],
"availability_zone": "az-dc-1",
"os-vol-host-attr:host": "db-rabbitmq201#LVM_iSCSI",
"encrypted": false,
"os-volume-replication:extended_status": null,
"volume_image_metadata": null,
"snapshot_id": null,
"id": "da4f9c7a-c275-4bc9-80c4-76c7d479a218",
"size": 1,
"os-vol-tenant-attr:tenant_id": "3dab0aaf682849678a94ec7b5a3af2ce",
"os-vol-mig-status-attr:migstat": null,
"metadata": {},
"status": "available",
"display_description": null,
"source_volid": null,
"os-vol-mig-status-attr:name_id": null,
"display_name": "test",
"bootable": "false",
"created_at": "2014-12-18T17:14:38.000000",
"volume_type": "SAS",
"multiattach": false
}
}</pre>
<p id="evs_04_0052__p52821068113531">or</p>
<pre class="screen" id="evs_04_0052__screen4594167995947">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_0052__p5655715720175">In the preceding example, <strong id="evs_04_0052__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_0052__b842352706144438">badrequest</strong> or <strong id="evs_04_0052__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_0052__screen65553757145321">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_0052__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_0052__ul9862716"><li id="evs_04_0052__li21655584">Normal<p id="evs_04_0052__p60682533"><a name="evs_04_0052__li21655584"></a><a name="li21655584"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_0052__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_0052__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_3028.html">EVS Disk</a></div>
</div>
</div>
View Git Blame Copy Permalink