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

699 lines
56 KiB
HTML
Raw Blame History

<a name="evs_04_2006"></a><a name="evs_04_2006"></a>
<h1 class="topictitle1">Querying Details About All Disks</h1>
<div id="body66839947"><div class="section" id="evs_04_2006__section37076589"><h4 class="sectiontitle">Function</h4><p id="evs_04_2006__p45326617">This API is used to query details about all disks.</p>
</div>
<div class="section" id="evs_04_2006__section65253851"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2006__ul47577364"><li id="evs_04_2006__li25543093">URI format<p id="evs_04_2006__p55724670"><a name="evs_04_2006__li25543093"></a><a name="li25543093"></a>GET /v2/{project_id}/cloudvolumes/detail</p>
</li><li id="evs_04_2006__li31759983">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__table17404391" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__row60677108"><th align="left" class="cellrowborder" valign="top" width="33.33%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_2006__p15898735">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.06%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_2006__p12729171">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.61%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_2006__p24429894">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__row32664435"><td class="cellrowborder" valign="top" width="33.33%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2006__p28573568">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.06%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2006__p32757653">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44.61%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2006__p36124251">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2006__li56682808">Request query parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__table270317378337" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__row1670119374333"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.3.1.1.5.1.1"><p id="evs_04_2006__p770313763318">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.3.1.1.5.1.2"><p id="evs_04_2006__p27031337143313">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.2.3.1.1.5.1.3"><p id="evs_04_2006__p4703737163310">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.2.3.1.1.5.1.4"><p id="evs_04_2006__p170333723315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__row20702143713331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p6703103723318">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1170419376339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p1470420374336">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p177041737193320">The AZ information.</p>
</td>
</tr>
<tr id="evs_04_2006__row7702193753317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p14704637153312">dedicated_storage_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p8704737133316">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p27041237163319">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p1170413372337">The dedicated storage pool ID. All disks in the dedicated storage pool can be filtered out. Only exact match is supported.</p>
</td>
</tr>
<tr id="evs_04_2006__row3702113717331"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p9704737163311">dedicated_storage_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1470573793319">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p170583712335">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p15705103773318">The dedicated storage pool name. All disks in the dedicated storage pool can be filtered out. Fuzzy match is supported.</p>
</td>
</tr>
<tr id="evs_04_2006__row2702337103314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p3705237113315">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1170543723320">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p197053378332">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p11705637153318">The enterprise project ID for filtering. If parameter <strong id="evs_04_2006__b11578645204">all_granted_eps</strong> is transferred, disks in all enterprise projects that are within the permission scope will be queried.</p>
</td>
</tr>
<tr id="evs_04_2006__row12702137103317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p1270615372339">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p157061437193319">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p17706037123315">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p16707537203319">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2006__row5702113783312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p97071537163310">ids</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p47073372339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p9707637143314">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p170713716332">The disk IDs. The parameter value is in the <em id="evs_04_2006__i14448417737">ids=['id1','id2',...,'idx']</em> format. In the response, the <strong id="evs_04_2006__b174481217636">ids</strong> value contains valid disk IDs only. Invalid disk IDs will be ignored. The details about a maximum of 60 disks can be queried. If parameters <strong id="evs_04_2006__b1569910501310">id</strong> and <strong id="evs_04_2006__b1699650133">ids</strong> are both specified in the request, <strong id="evs_04_2006__b187001501336">id</strong> will be ignored.</p>
</td>
</tr>
<tr id="evs_04_2006__row10702163715333"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p2707193715331">limit</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p370720374337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p97072037143318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p3708133793312">The maximum number of query results that can be returned. The default value is <strong id="evs_04_2006__b4480024242">1000</strong>.</p>
<p id="evs_04_2006__p770819376336">Minimum value: <strong id="evs_04_2006__b1478310261546">1</strong></p>
<p id="evs_04_2006__p870883714339">Maximum value: <strong id="evs_04_2006__b14352162918416">1000</strong></p>
<p id="evs_04_2006__p1670813773314">Default value: <strong id="evs_04_2006__b8492731845">1000</strong></p>
</td>
</tr>
<tr id="evs_04_2006__row5702173733315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p770883715337">marker</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p157081137103315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p17708637103311">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p870883717336">The pagination query by disk ID. The query starts from the first page by default. By specifying a disk ID for <strong id="evs_04_2006__b1690435264314">marker</strong>, information of all disks following the specified disk will be queried. Note that information of the specified disk will not be included in the query results.</p>
</td>
</tr>
<tr id="evs_04_2006__row207021237203315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p970863743318">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1270919379339">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p1970983710339">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p1470933723313">The disk metadata.</p>
</td>
</tr>
<tr id="evs_04_2006__row1870217372338"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p14709037183317">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p13709183743311">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p670973720332">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p1470903713338">Whether the disk is shareable. The value can be <strong id="evs_04_2006__b476111559720">true</strong> (a shared disk) or <strong id="evs_04_2006__b758812581873">false</strong> (a non-shared disk).</p>
</td>
</tr>
<tr id="evs_04_2006__row370293793315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p9709137143313">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1571003783312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p971053717334">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p271073715334">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2006__row570216374330"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p147101237163311">offset</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p47102373333">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p15710737133318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p1071013372337">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_2006__row1870243716334"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p77108374331">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1671163711333">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p271119376331">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p971153718335">The server ID.</p>
</td>
</tr>
<tr id="evs_04_2006__row1270253773314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p1571173713339">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p1071153711333">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p971193710334">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p16711133715336">The service type. Only EVS, DSS, and DESS are supported.</p>
</td>
</tr>
<tr id="evs_04_2006__row8702137123316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p37115374336">sort_dir</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p16712153733312">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p17122037203320">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p67121370335">The result sorting order. The value can be <strong id="evs_04_2006__b49891038165612">asc</strong> (the ascending order) or <strong id="evs_04_2006__b1589913512107">desc</strong> (the descending order). The default value is <strong id="evs_04_2006__b686857111012">desc</strong>.</p>
</td>
</tr>
<tr id="evs_04_2006__row7702123712332"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p1671293713316">sort_key</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p18712183717336">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p1471218377331">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p7712537193320">The keyword based on which the returned results are sorted. The value can be <strong id="evs_04_2006__b8401151616120">id</strong>, <strong id="evs_04_2006__b565511186129">status</strong>, <strong id="evs_04_2006__b8351172061220">size</strong>, or <strong id="evs_04_2006__b109682022191216">created_at</strong>, and the default value is <strong id="evs_04_2006__b450992716129">created_at</strong>.</p>
</td>
</tr>
<tr id="evs_04_2006__row9702143753318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p1471243743311">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p13713193720337">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p10713437183311">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p1871314373337">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2006__row13702143716339"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.1 "><p id="evs_04_2006__p671363793319">volume_type_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.2 "><p id="evs_04_2006__p17713103773315">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.2.3.1.1.5.1.3 "><p id="evs_04_2006__p5713133793318">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.2.3.1.1.5.1.4 "><p id="evs_04_2006__p12713183714335">The disk type ID. For details, see <a href="evs_04_2071.html">Querying EVS Disk Types</a>. The disk type ID is the <strong id="evs_04_2006__b1294412681318">id</strong> value in the table that describes parameters in the <strong id="evs_04_2006__b72332031111320">volume_types</strong> field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2006__section50413755"><h4 class="sectiontitle">Request</h4><div class="p" id="evs_04_2006__p68902433512">The following example shows how to query the disks in the <strong id="evs_04_2006__b18493141018567">available</strong> state.<ul id="evs_04_2006__ul1618599088"><li id="evs_04_2006__li81864915817">Example request<pre class="screen" id="evs_04_2006__screen85415131181">GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail?status=available</pre>
</li></ul>
</div>
</div>
<div class="section" id="evs_04_2006__section51070612"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2006__ul25394981"><li id="evs_04_2006__li13301791611">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__table84066241518" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__row12406192413112"><th align="left" class="cellrowborder" valign="top" width="19.05%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2006__p44071924617">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.810000000000002%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2006__p1740719241010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2006__p13407524412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__row1540722420116"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2006__p7407924310">volumes</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2006__p12407102418117">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2006__p1440714241716">The list of returned disks. For details, see <a href="#evs_04_2006__li7558467201357">Parameters in the volumes field</a>.</p>
</td>
</tr>
<tr id="evs_04_2006__row21946532437"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2006__p2717173753312">count</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2006__p177171537163318">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2006__p2717183753314">The number of queried disks. This value is not affected by the pagination.</p>
</td>
</tr>
<tr id="evs_04_2006__row885415515435"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2006__p7717637193314">volumes_links</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2006__p771710376334">Array of <a href="#evs_04_2006__li1043159617124">Link</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2006__p1071703723315">The query position marker in the disk list. If only some disks are returned in this query, the URL of the last disk queried will be returned. You can use this URL to continue to query the remaining disks in the next query.</p>
</td>
</tr>
<tr id="evs_04_2006__row9632115616119"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2006__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2006__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2006__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2006__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2006__li7558467201357"><a name="evs_04_2006__li7558467201357"></a><a name="li7558467201357"></a>Parameters in the <strong id="evs_04_2006__b1519104717615">volumes</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__table2981836711145" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__row3364554311145"><th align="left" class="cellrowborder" valign="top" width="19.05%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2006__p4093449711145">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.810000000000002%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2006__p2735998811145">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2006__p5978048211145">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__row1038087811145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p3554478611145">id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p6055544711145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1981792311145">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2006__row4414357911145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p1886016511145">links</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p5127838711145">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p2076537311145">The disk URI. For details, see <a href="#evs_04_2006__li1043159617124">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2006__row5267063211145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p3846276911145">name</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p2847654611145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p354371011145">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2006__row3189339611145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p3322829411145">status</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p713731711145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p5306151211145">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2006__row779156211145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p2713676711145">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p5059453311145">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p3029347411145">The disk attachment information. For details, see <a href="#evs_04_2006__li3900093617124">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2006__row420581811145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p512694011145">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1262901111145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p4660854311145">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2006__row4624829132616"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p137230374335">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p67231837203318">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p7723103710331">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row1682370811145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p2054314211145">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p5338183311145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p6415551111145">The source disk ID. This parameter has a value if the disk is created from a source disk.</p>
<p id="evs_04_2006__p152173372473">This field is currently not supported.</p>
</td>
</tr>
<tr id="evs_04_2006__row4052869111145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p6159857511145">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p2342864611145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p3605277911145">The snapshot ID. This parameter has a value if the disk is created from a snapshot.</p>
</td>
</tr>
<tr id="evs_04_2006__row5603956011145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p4291047811145">description</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p5319669311145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p5741254811145">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2006__row4695089011145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p4492573411145">os-vol-tenant-attr:tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1510579811145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p5645845111145">The ID of the tenant to which the disk belongs. The tenant ID is the same as the project ID.</p>
</td>
</tr>
<tr id="evs_04_2006__row3836401911145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p2047785411145">volume_image_metadata</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p4809349011145">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p6261854611145">The metadata of the disk image.</p>
<div class="note" id="evs_04_2006__note15692019279"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2006__evs_04_2009_p1888154732118">For details about <strong id="evs_04_2006__b12218270244">volume_image_metadata</strong>, see <strong id="evs_04_2006__b73527192414">Querying Image Details (Native OpenStack API)</strong> in the <em id="evs_04_2006__i163172713244">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2006__row2669600511145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p1489277711145">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p6546428211145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1442502411145">The time when the disk was created.</p>
<p id="evs_04_2006__p15772145473814">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2006__row6271635911145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p4686035111145">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p3759207111145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__evs_04_2010_p47786148539">The disk type.</p>
<div class="p" id="evs_04_2006__p12887229134510">The value can be <strong id="evs_04_2006__evs_04_2013_b18986209175810">ESSD</strong>, <strong id="evs_04_2006__evs_04_2013_b139865912588">GPSSD</strong>, <strong id="evs_04_2006__evs_04_2013_b198719145816">SSD</strong>, <strong id="evs_04_2006__evs_04_2013_b1198714910584">SAS</strong>, or <strong id="evs_04_2006__evs_04_2013_b17987193587">SATA</strong>.<ul id="evs_04_2006__evs_04_2013_ul13901722818"><li id="evs_04_2006__evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_2006__evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_2006__evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_2006__evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_2006__evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_2006__evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_2006__evs_04_2013_evs_04_2003_li1444614485511"><strong id="evs_04_2006__evs_04_2013_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="evs_04_2006__evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_2006__evs_04_2013_b529917133589">ESSD</strong>: the extreme SSD type</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2006__row1431806011145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p1891222511145">size</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p5549524211145">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p3869865011145">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2006__row679318292290"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p6728113793314">consistencygroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1772811372337">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1872833773316">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row1274353211145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p2559317611145">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p5978137211145">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2006__evs_04_2010_p8780414125315">Whether the disk is bootable.<ul id="evs_04_2006__ul185931714111"><li id="evs_04_2006__li135936114118"><strong id="evs_04_2006__b72091815195712">true</strong>: indicates a bootable disk.</li><li id="evs_04_2006__li1593611917"><strong id="evs_04_2006__b3175717185714">false</strong>: indicates a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2006__row3693082411145"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p3860677311145">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p19729113715339">Map&lt;String,Object&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p872933743313">The disk metadata. The encryption CMK ID in <strong id="evs_04_2006__b3554122215299">metadata</strong>. This parameter is used together with <strong id="evs_04_2006__b165551226296">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2006__b1555582222917">cmkid</strong> is fixed at 36 bytes.</p>
<p id="evs_04_2006__p19729163713319"><strong id="evs_04_2006__b11893173110319">__system__encrypted</strong>: the encryption field in <strong id="evs_04_2006__b17893183111316">metadata</strong>. The value can be <strong id="evs_04_2006__b78930318319">0</strong> (not encrypted) or <strong id="evs_04_2006__b198947316313">1</strong> (encrypted). If this parameter does not appear, the encryption attribute of the disk is the same as that of the data source. If the disk is not created from a data source, the disk is not encrypted by default.</p>
<p id="evs_04_2006__p47291237193312"><strong id="evs_04_2006__b1369134510396">full_clone</strong>: The method of creation when the disk is created from a snapshot.</p>
<ul id="evs_04_2006__ul157291937153319"><li id="evs_04_2006__li5729737113317"><strong id="evs_04_2006__b26561818194015">0</strong>: linked clone</li><li id="evs_04_2006__li18730153713311"><strong id="evs_04_2006__b4399162017404">1</strong>: full clone</li></ul>
<p id="evs_04_2006__p1599183763311"><strong id="evs_04_2006__b15964204164010">hw:passthrough</strong>:</p>
<ul id="evs_04_2006__ul399173753314"><li id="evs_04_2006__li1799112377330">If this parameter is <strong id="evs_04_2006__b1526719438403">true</strong>, the disk device type is SCSI, which allows ECS OSs to directly access underlying storage media. SCSI reservation commands are supported.</li><li id="evs_04_2006__li7991183723314">If this parameter is <strong id="evs_04_2006__b8735552184016">false</strong>, the disk device type is VBD, which supports only simple SCSI read/write commands.</li><li id="evs_04_2006__li89915377334">If this parameter does not appear, the disk device type is VBD.</li></ul>
</td>
</tr>
<tr id="evs_04_2006__row9352152283611"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p69911937193315">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p2099133716338">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p8991183783316">The time when the disk was updated. Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2006__row1862115133614"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p599119376335">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p189912379339">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1699183793312">This field is currently not supported.</p>
</td>
</tr>
<tr id="evs_04_2006__row889210254371"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p1999113793314">replication_status</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p159911537113313">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p19911377332">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row595422083818"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p17991183713313">os-vol-mig-status-attr:migstat</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1099163715334">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p7991133783311">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row27570907112011"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p18650967112011">os-vol-host-attr:host</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p34333384112011">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p43991208112011">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row4358951163810"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p20991737143320">os-vol-mig-status-attr:name_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1599153723310">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p169913371335">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row1680824512716"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p129881319775">os-volume-replication:extended_status</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p169881619370">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1798816191971">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row5671275145922"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p637448871502">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p630621881502">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p5991103763318">Whether the disk is shareable. The value can be <strong id="evs_04_2006__b1149511715456">true</strong> (shared disk) or <strong id="evs_04_2006__b34960176458">false</strong> (common disk). This field is no longer used. Use <strong id="evs_04_2006__b104657210452">multiattach</strong>.</p>
</td>
</tr>
<tr id="evs_04_2006__row597325243913"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p299173715332">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1799173713335">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p8991637103316">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2006__row9308163216403"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p799117378330">service_type</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1999133714332">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p29921437163317">The service type. The value can be <strong id="evs_04_2006__b1158531010465">EVS</strong>, <strong id="evs_04_2006__b127201112184610">DSS</strong>, or <strong id="evs_04_2006__b5402161724614">DESS</strong>.</p>
</td>
</tr>
<tr id="evs_04_2006__row1544393415400"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p14992137143314">dedicated_storage_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p29921377331">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p189921437153311">The ID of the DSS storage pool accommodating the disk.</p>
</td>
</tr>
<tr id="evs_04_2006__row720163744010"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p189921637113319">dedicated_storage_name</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p99927375333">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p11992123723315">The name of the DSS storage pool accommodating the disk.</p>
</td>
</tr>
<tr id="evs_04_2006__row0459194624113"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p19992133723311">tags</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p14992637113316">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p179921337123313">The disk tags. This field has values if the disk has tags. Or, it is left empty.</p>
</td>
</tr>
<tr id="evs_04_2006__row187797496410"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p6992163714332">wwn</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1099216377334">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1799243712339">The unique identifier used when attaching the disk.</p>
</td>
</tr>
<tr id="evs_04_2006__row63276793114824"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p53765166114828">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p60011165114828">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2006__evs_04_2010_p4781191416535">Whether the disk is shareable.<ul id="evs_04_2006__ul161621719119"><li id="evs_04_2006__li91631519818"><strong id="evs_04_2006__b81451349194811">true</strong>: indicates a shared disk.</li><li id="evs_04_2006__li1916311191410"><strong id="evs_04_2006__b12891051184814">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2006__row17751130144210"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p19921737113315">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p8992153711337">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p1599263710330">The ID of the enterprise project that the disk has been added to.</p>
</td>
</tr>
<tr id="evs_04_2006__row986703311424"><td class="cellrowborder" valign="top" width="19.05%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2006__p179924374333">serial_number</p>
</td>
<td class="cellrowborder" valign="top" width="23.810000000000002%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2006__p1099214372339">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2006__p39921037203315">The disk SN. This field is returned only for non-HyperMetro SCSI volumes and is used for disk mapping in the VM.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2006__li1043159617124"><a name="evs_04_2006__li1043159617124"></a><a name="li1043159617124"></a>Parameters in the <strong id="evs_04_2006__b84235270692535">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__table4005083311851" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__row4647546111851"><th align="left" class="cellrowborder" valign="top" width="19.27807219278072%" id="mcps1.3.4.2.3.2.1.4.1.1"><p id="evs_04_2006__p641601411851">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.0975902409759%" id="mcps1.3.4.2.3.2.1.4.1.2"><p id="evs_04_2006__p4993509511851">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.624337566243376%" id="mcps1.3.4.2.3.2.1.4.1.3"><p id="evs_04_2006__p6579322611851">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__row2765107611851"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2006__p2514470311851">href</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2006__p2345507511851">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2006__p812224311851">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="evs_04_2006__row599132611851"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.3.2.1.4.1.1 "><p id="evs_04_2006__p1553537811851">rel</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.3.2.1.4.1.2 "><p id="evs_04_2006__p5040609911851">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.3.2.1.4.1.3 "><p id="evs_04_2006__p193416911851">The shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2006__li3900093617124"><a name="evs_04_2006__li3900093617124"></a><a name="li3900093617124"></a>Parameters in the <strong id="evs_04_2006__b1919746252">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__table3471673811913" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__row950913211913"><th align="left" class="cellrowborder" valign="top" width="19.27807219278072%" id="mcps1.3.4.2.4.2.1.4.1.1"><p id="evs_04_2006__p3204224811913">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.0975902409759%" id="mcps1.3.4.2.4.2.1.4.1.2"><p id="evs_04_2006__p4528532911913">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.624337566243376%" id="mcps1.3.4.2.4.2.1.4.1.3"><p id="evs_04_2006__p2610634411913">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__row3423911011913"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p2190452911913">server_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p2943640011913">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p6002094011913">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2006__row331754911913"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p28604711913">attachment_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p2316983311913">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p1570218411913">The ID of the attachment information.</p>
</td>
</tr>
<tr id="evs_04_2006__row41611216113819"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p26997962113823">attached_at</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p39351338113823">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p16333436113823">The time when the disk was attached.</p>
<p id="evs_04_2006__p103581088395">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2006__row710192811913"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p3838529111913">host_name</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p2220087511913">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p3370764811913">The name of the physical host housing the cloud server to which the disk is attached.</p>
</td>
</tr>
<tr id="evs_04_2006__row3493337611913"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p1103121411913">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p2111318111913">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p1089110111913">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2006__row3091104611913"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p2076682611913">device</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p439134611913">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p2192276811913">The device name.</p>
</td>
</tr>
<tr id="evs_04_2006__row6308718811913"><td class="cellrowborder" valign="top" width="19.27807219278072%" headers="mcps1.3.4.2.4.2.1.4.1.1 "><p id="evs_04_2006__p978858311913">id</p>
</td>
<td class="cellrowborder" valign="top" width="24.0975902409759%" headers="mcps1.3.4.2.4.2.1.4.1.2 "><p id="evs_04_2006__p5467773011913">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.624337566243376%" headers="mcps1.3.4.2.4.2.1.4.1.3 "><p id="evs_04_2006__p4371205011913">The ID of the attached disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2006__li0419202382514"><a name="evs_04_2006__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2006__b981373645319">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2006__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2006__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_2006__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_2006__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_2006__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2006__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_2006__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_2006__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_2006__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2006__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_2006__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_2006__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_2006__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2006__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_2006__li27228238">Example response<pre class="screen" id="evs_04_2006__screen115613581039">{
"count" : 1,
"volumes" : [ {
"attachments" : [ ],
"availability_zone" : "az-dc-1",
"bootable" : "false",
"created_at" : "2016-05-25T02:42:10.856332",
"description" : null,
"id" : "b104b8db-170d-441b-897a-3c8ba9c5a214",
"links" : [ {
"href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel" : "self"
}, {
"href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214",
"rel" : "bookmark"
} ],
"metadata" : { },
"name" : "zjb_u25_test",
"os-vol-host-attr:host" : "pod01.xxx#SATA",
"volume_image_metadata" : { },
"os-vol-mig-status-attr:migstat" : null,
"os-vol-mig-status-attr:name_id" : null,
"os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f",
"os-volume-replication:extended_status" : null,
"replication_status" : "disabled",
"multiattach" : false,
"size" : 1,
"snapshot_id" : null,
"status" : "available",
"updated_at" : "2016-05-25T02:42:22.341984",
"user_id" : "b0524e8342084ef5b74f158f78fc3049",
"volume_type" : "SATA",
"service_type" : "EVS",
"dedicated_storage_id" : null,
"dedicated_storage_name" : null,
"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_2006__p885082">or</p>
<pre class="screen" id="evs_04_2006__screen3819634310315">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2006__section56982329"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2006__ul51488960"><li id="evs_04_2006__li60747463">Normal<p id="evs_04_2006__p9856263"><a name="evs_04_2006__li60747463"></a><a name="li60747463"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2006__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2006__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