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

673 lines
55 KiB
HTML
Raw Blame History

<a name="evs_04_2010"></a><a name="evs_04_2010"></a>
<h1 class="topictitle1">Querying Details About All Disks (Deprecated)</h1>
<div id="body1519735167072"><div class="section" id="evs_04_2010__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_2010__p1621162824117">This API is used to query details about all disks.</p>
</div>
<div class="section" id="evs_04_2010__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2010__ul4618564"><li id="evs_04_2010__li41567079">URI format<p id="evs_04_2010__p18686160451"><a name="evs_04_2010__li41567079"></a><a name="li41567079"></a>GET /v2/{project_id}/os-vendor-volumes/detail</p>
</li><li id="evs_04_2010__li36303315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__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_2010__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_2010__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_2010__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2010__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_2010__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_2010__p16154192">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2010__li64846622153528">Request filter parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__table48630339152531" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__row30502978152531"><th align="left" class="cellrowborder" valign="top" width="17.5982401759824%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2010__p54822134152531">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.798420157984202%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2010__p11407863152531">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.418258174182583%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2010__p51621676152531">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.185081491850816%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2010__p20606205152531">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__row58489940152531"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p49168107152914">marker</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p23193765152914">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p66755704152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p38502923152914"><span id="evs_04_2010__text1348145625919">The ID of the resource from which the pagination query starts. It is the ID of the last resource on the previous page.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row38948343152859"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p17125818152914">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p14491527153320">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p22259725152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p58207321152914">The disk name. <span id="evs_04_2010__text37302935152245">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row61932754152911"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p20335623152914">limit</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p36572733152914">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p9601396152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p39515603152914">The maximum number of query results that can be returned.</p>
<p id="evs_04_2010__p2642143814912"><span id="evs_04_2010__text138349551887">The value ranges from 1 to 1000, and the default value is 1000. The returned value cannot exceed this limit.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row4561665015299"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p17172513152914">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p43305182153332">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p60186269152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p43249593152914">The keyword based on which the returned results are sorted. The value can be <strong id="evs_04_2010__b842352706101941">id</strong>, <strong id="evs_04_2010__b842352706101934">status</strong>, <strong id="evs_04_2010__b842352706101930">size</strong>, or <strong id="evs_04_2010__b842352706101927">created_at</strong>, and the default value is <strong id="evs_04_2010__b2063116951191130">created_at</strong>.</p>
</td>
</tr>
<tr id="evs_04_2010__row5831630415296"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p54896674152914">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p4460297153338">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p3809857152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p40162964152914">The result sorting order. The default value is <strong id="evs_04_2010__b911545915227">desc</strong>.</p>
<ul id="evs_04_2010__ul329874211485"><li id="evs_04_2010__li12298742174810"><strong id="evs_04_2010__b842352706143516">desc</strong>: the descending order</li><li id="evs_04_2010__li116876514493"><strong id="evs_04_2010__b84235270614353">asc</strong>: the ascending order</li></ul>
</td>
</tr>
<tr id="evs_04_2010__row1669400215294"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p19336748152914">offset</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p22139675153443">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p32652321152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p27592310152914">The query offset. 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_2010__row4150243115292"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p49243814152914">status</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p15960789153343">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p26598214152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p6971702152914">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2010__row33130210152857"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p49206403152914">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p6448822153343">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p49578561152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p56440503152914">The disk metadata.</p>
</td>
</tr>
<tr id="evs_04_2010__row20664390152531"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p7393147152914">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p59504247153343">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p53841259152914">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p66174752152914">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2010__row433212398420"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p1441713429428">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p1541984214429">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p18419174234210">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><div class="p" id="evs_04_2010__p16419144210429">Whether the disk is shareable.<ul id="evs_04_2010__ul202952187368"><li id="evs_04_2010__li182958188365"><strong id="evs_04_2010__b68571259164016">true</strong>: indicates a shared disk.</li><li id="evs_04_2010__li0295171811366"><strong id="evs_04_2010__b1835015264119">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2010__row1484019429236"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p4338154142317">volume_type_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p193381354122315">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p3338754132315">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p3338155422319">The disk type ID.</p>
</td>
</tr>
<tr id="evs_04_2010__row1758151163616"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p85819112362">id</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p75815112367">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p3581911193617">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p45812118360">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2010__row3113151415129"><td class="cellrowborder" valign="top" width="17.5982401759824%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2010__p11113121412125">ids</p>
</td>
<td class="cellrowborder" valign="top" width="15.798420157984202%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2010__p1811371412124">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="17.418258174182583%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2010__p9113191413128">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.185081491850816%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2010__p7651828190">The disk IDs. The parameter value is in the <em id="evs_04_2010__i196060295422">ids=['id1','id2',...,'idx']</em> format. In the response, the <strong id="evs_04_2010__b14606182964216">ids</strong> value contains valid disk IDs only. Invalid disk IDs will be ignored.</p>
<p id="evs_04_2010__p2640155471814">The details about a maximum of 60 disks can be queried.</p>
<p id="evs_04_2010__p649163291315">If parameters <strong id="evs_04_2010__b15854159164212">id</strong> and <strong id="evs_04_2010__b58558597424">ids</strong> are both specified in the request, <strong id="evs_04_2010__b085575934219">id</strong> will be ignored.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2010__section50413755"><h4 class="sectiontitle">Request</h4><div class="p" id="evs_04_2010__p2799031">The following example shows how to query the shared disks in the <strong id="evs_04_2010__b205892278011">available</strong> state.<ul id="evs_04_2010__ul1618599088"><li id="evs_04_2010__li81864915817">Example request<pre class="screen" id="evs_04_2010__screen85415131181">GET https://{endpoint}/v2/{project_id}/os-vendor-volumes/detail?status=available&amp;multiattach=true</pre>
</li></ul>
</div>
</div>
<div class="section" id="evs_04_2010__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2010__ul37131542"><li id="evs_04_2010__li3451542201439">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__row12524911142557"><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_2010__p7884856142557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.53%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2010__p34693598142557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.65%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2010__p58539486142557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__row42521635152937"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2010__p14844956152939">volumes</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2010__p61590812152939">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2010__p34852014152939">The list of queried disks. For details, see <a href="#evs_04_2010__li1435719516515">Parameters in the volumes field</a>.</p>
</td>
</tr>
<tr id="evs_04_2010__row15981815184017"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2010__p16197151919407">volumes_links</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2010__p12197151915402">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2010__p17197141954017">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_2010__li1077125119136">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2010__row444782011610"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2010__p0730182411511">count</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2010__p1573092465118">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2010__p10730152455119">The number of queried disks. This value is not affected by the pagination.</p>
</td>
</tr>
<tr id="evs_04_2010__row141841349561"><td class="cellrowborder" valign="top" width="18.82%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2010__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="23.53%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2010__evs_04_2010_p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.65%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2010__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2010__li24688256">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2010__li1435719516515"><a name="evs_04_2010__li1435719516515"></a><a name="li1435719516515"></a>Parameters in the <strong id="evs_04_2010__b84235270692535">volumes</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__table9519314115310" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__row07772014165315"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2010__p977791416537">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_2010__p1777191445316">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2010__p9894141375614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__row157775141539"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p1577716144532">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_2010__p2077712145534">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p577711405310">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2010__row197771014165318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p1777771465312">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_2010__p1577781445313">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p377719149537">The disk URI. For details, see <a href="#evs_04_2010__li1077125119136">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2010__row14777131435317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p677751415313">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_2010__p7777614185310">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p977716143532">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2010__row377719149532"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p17777714195313">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_2010__p17771514195316">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p137771014165316">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2010__row1577714145535"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p8777171445317">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_2010__p14777161435318">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1977761417532">The disk attachment information. For details, see <a href="#evs_04_2010__li12430153610291">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2010__row137779149535"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p7777614155317">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_2010__p977731415320">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1577710143534">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2010__row577741415319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p16777171425319">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_2010__p8777201414538">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1677701445318"><span id="evs_04_2010__text542510472571">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row19777171445315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p13777914155316">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_2010__p9777101475310">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p97771314105319">The source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_2010__p1066441210106"><span id="evs_04_2010__text88578719717">This field is currently not supported.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row1577751412539"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p10777201435317">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_2010__p87771614125315">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p877714143532">The snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_2010__row7777114155318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p8777151410534">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_2010__p17778191485311">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p3778181416532">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2010__row67785148537"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p277810146537">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_2010__p3778141415318">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p47781314105312">The time when the disk was created.</p>
<p id="evs_04_2010__p20997172813263"><span id="evs_04_2010__text17996183912613">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2010__row67781214105315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p377811416530">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_2010__p0778131415310">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p47786148539">The disk type.</p>
<p id="evs_04_2010__p153964391393"></p>
<div class="p" id="evs_04_2010__p12887229134510">The value can be <strong id="evs_04_2010__evs_04_2003_evs_04_2013_b18986209175810">ESSD</strong>, <strong id="evs_04_2010__evs_04_2003_evs_04_2013_b139865912588">GPSSD</strong>, <strong id="evs_04_2010__evs_04_2003_evs_04_2013_b198719145816">SSD</strong>, <strong id="evs_04_2010__evs_04_2003_evs_04_2013_b1198714910584">SAS</strong>, or <strong id="evs_04_2010__evs_04_2003_evs_04_2013_b17987193587">SATA</strong>.<ul id="evs_04_2010__evs_04_2003_evs_04_2013_ul13901722818"><li id="evs_04_2010__evs_04_2003_evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_2010__evs_04_2003_evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_2010__evs_04_2003_evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_2010__evs_04_2003_evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_2010__evs_04_2003_evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_2010__evs_04_2003_evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_2010__evs_04_2003_evs_04_2013_evs_04_2003_li1444614485511"><strong id="evs_04_2010__evs_04_2003_evs_04_2013_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="evs_04_2010__evs_04_2003_evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_2010__evs_04_2003_evs_04_2013_b529917133589">ESSD</strong>: the extreme SSD type</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2010__row137786149533"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p14778214185315">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_2010__p19778514175310">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1677871415318">The ID of the tenant to which the disk belongs. <span id="evs_04_2010__text19941457165313">The tenant ID is the same as the project ID.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row18778181445315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p12778114205320">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_2010__p18778141414532">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p2778614165317">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2010__row19778191410534"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p6778101415532">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_2010__p17788145537">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1778814165312">The disk metadata. For details, see <a href="#evs_04_2010__li29114110314">Parameters in the metadata field</a>.</p>
<p id="evs_04_2010__p87781014105314">If <strong id="evs_04_2010__b842352706144250">metadata</strong> does not contain the <strong id="evs_04_2010__b842352706143434">hw:passthrough</strong> field, the disk device type is VBD.</p>
<p id="evs_04_2010__p137786148534">If <strong id="evs_04_2010__b842352706144256">metadata</strong> does not contain the <strong id="evs_04_2010__b842352706143455">__system__encrypted</strong> field, the disk is not encrypted.</p>
</td>
</tr>
<tr id="evs_04_2010__row877851418537"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p17778214105317">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_2010__p177891485319">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p978016142531"><span id="evs_04_2010__text203605127103">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row1278081415531"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p17780101425317">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_2010__p47801514165310">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p278041410539"><span id="evs_04_2010__text4617175712110">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row7780171418539"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p978017142534">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_2010__p12780191455320">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p278051495317"><span id="evs_04_2010__text379518478151">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row15780614195318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p47452553185118">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_2010__p18451581185118">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p27951625185124"><span id="evs_04_2010__text141191141115618">This field is currently not supported.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row778012145537"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p47806145531">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_2010__p378051485319">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1478011145538"><span id="evs_04_2010__text6498181171119">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row127801014115315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p1780101435315">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_2010__p147803142534">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p1780314115312">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2010__row478012147531"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p207801914195310">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_2010__p57802014195314">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p478011417532"><span id="evs_04_2010__text13343838181111">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2010__row5780814175319"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p117801414155319">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_2010__p18780121416536">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2010__evs_04_2010_p8780414125315">Whether the disk is bootable.<ul id="evs_04_2010__ul185931714111"><li id="evs_04_2010__li135936114118"><strong id="evs_04_2010__b3402839133810">true</strong>: indicates a bootable disk.</li><li id="evs_04_2010__li1593611917"><strong id="evs_04_2010__b15509104143818">false</strong>: indicates a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2010__row18780121455311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p1478018149536">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_2010__p1078151416531">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p178141465319">The time when the disk was updated.</p>
<p id="evs_04_2010__p134522013390"><span id="evs_04_2010__text10160926103914">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2010__row1578113141536"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p1578191419531">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_2010__p378121416538">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p17811114125319">Whether the disk is shareable.</p>
<div class="note" id="evs_04_2010__note3800959821323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2010__p45212589213213">This field is no longer used. Use <strong id="evs_04_2010__b14546151023516">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2010__row157811614145318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p3781191418536">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_2010__p37812014135310">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2010__evs_04_2010_p4781191416535">Whether the disk is shareable.<ul id="evs_04_2010__ul161621719119"><li id="evs_04_2010__li91631519818"><strong id="evs_04_2010__b10797197133914">true</strong>: indicates a shared disk.</li><li id="evs_04_2010__li1916311191410"><strong id="evs_04_2010__b8716992399">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2010__row11781131475317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__p19781814165316">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_2010__p5781314145311">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p15781414175316">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_2010__note410975220289"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2010__evs_04_2009_p1888154732118">For details about <strong id="evs_04_2010__evs_04_2009_b1583910241610">volume_image_metadata</strong>, see <strong id="evs_04_2010__evs_04_2009_b48471428167">Querying Image Details (Native OpenStack API)</strong> in the <em id="evs_04_2010__evs_04_2009_i1384712215164">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2010__row13766235174313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__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_2010__p1198854414439">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p18988144418437">The disk tags.</p>
<p id="evs_04_2010__p898894418432">This field has values if the disk has tags. Or, it is left empty.</p>
</td>
</tr>
<tr id="evs_04_2010__row73891538114311"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2010__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_2010__p3988174494319">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2010__p6988244114313">The unique identifier used when attaching the disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2010__li1077125119136"><a name="evs_04_2010__li1077125119136"></a><a name="li1077125119136"></a>Parameters in the <strong id="evs_04_2010__evs_04_2067_b3190144816178">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__evs_04_2067_table24355024185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p47699944185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p53015590185927">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p57795935185927">The shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2010__li12430153610291"><a name="evs_04_2010__li12430153610291"></a><a name="li12430153610291"></a>Parameters in the <strong id="evs_04_2010__evs_04_2067_b84235270692535">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__evs_04_2067_table6503386185927" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p50913593185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p49891705185927">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p35416329185927">The ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p38329099185927">The time when the disk was attached.</p>
<p id="evs_04_2010__evs_04_2067_p3414132514312"><span id="evs_04_2010__evs_04_2067_text7299269449">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__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_2010__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_2010__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_2010__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_2010__evs_04_2067_p48959624185927">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p22392462185927">The device name.</p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_2067_p14021450185927">The ID of the attached disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2010__li29114110314"><a name="evs_04_2010__li29114110314"></a><a name="li29114110314"></a>Parameters in the <strong id="evs_04_2010__evs_04_3004_b1734614164165">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__evs_04_3004_table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_3004_p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_3004_p177192813501">The encryption field in <strong id="evs_04_2010__evs_04_3004_b84235270614509">metadata</strong>.<ul id="evs_04_2010__evs_04_3004_ul141951225145011"><li id="evs_04_2010__evs_04_3004_li191951925125013"><strong id="evs_04_2010__evs_04_3004_b87781551824">0</strong>: indicates a non-encrypted disk.</li><li id="evs_04_2010__evs_04_3004_li11195192510508"><strong id="evs_04_2010__evs_04_3004_b181881011732">1</strong>: indicates an encrypted disk.</li><li id="evs_04_2010__evs_04_3004_li191958257506">If this parameter does not appear, the disk is not encrypted.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_3004_p4159804295622">The encryption CMK ID in <strong id="evs_04_2010__evs_04_3004_b84235270615116">metadata</strong>. This parameter is used together with <strong id="evs_04_2010__evs_04_3004_b842352706143827">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2010__evs_04_3004_b84235270614396">cmkid</strong> is fixed at 36 bytes.</p>
</td>
</tr>
<tr id="evs_04_2010__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_2010__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_2010__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_2010__evs_04_3004_p17177177145116">The parameter that describes the disk device type in <strong id="evs_04_2010__evs_04_3004_b13632941434">metadata</strong>. The value can be <strong id="evs_04_2010__evs_04_3004_b116336411432">true</strong> or <strong id="evs_04_2010__evs_04_3004_b36337410319">false</strong>.<ul id="evs_04_2010__evs_04_3004_ul14462208141855"><li id="evs_04_2010__evs_04_3004_li16942218141855"><strong id="evs_04_2010__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_2010__evs_04_3004_li42055621173515"><strong id="evs_04_2010__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_2010__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_2010__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_2010__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_2010__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_2010__evs_04_3004_p47931946183150">The clone method. If the disk is created from a snapshot, value <strong id="evs_04_2010__evs_04_3004_b337155114417">0</strong> indicates the linked cloning method.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2010__li24688256"><a name="evs_04_2010__li24688256"></a><a name="li24688256"></a>Parameters in the <strong id="evs_04_2010__b316002555610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2010__table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2010__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_2010__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_2010__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_2010__p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2010__row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.1 "><p id="evs_04_2010__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_2010__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_2010__p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2010__row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.1 "><p id="evs_04_2010__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_2010__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_2010__p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2010__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_2010__li65748423">Example response<pre class="screen" id="evs_04_2010__screen18629162591918">{
"count": 1,
"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#SAS",
"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": "SAS",
"service_type": "EVS",
"wwn": " 688860300000d136fa16f48f05992360"
}
],
"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_2010__p3632182551915">or</p>
<pre class="screen" id="evs_04_2010__screen1563212541919">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2010__p19632825111912">In the preceding example, <strong id="evs_04_2010__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2010__b842352706144438">badRequest</strong> or <strong id="evs_04_2010__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2010__screen863242516197">{
"badRequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2010__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2010__ul9862716"><li id="evs_04_2010__li21655584">Normal<p id="evs_04_2010__p60682533"><a name="evs_04_2010__li21655584"></a><a name="li21655584"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2010__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2010__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">Disk Management</a></div>
</div>
</div>
View Git Blame Copy Permalink