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

549 lines
43 KiB
HTML
Raw Blame History

<a name="evs_04_2067"></a><a name="evs_04_2067"></a>
<h1 class="topictitle1">Updating an EVS Disk</h1>
<div id="body1494051692078"><div class="section" id="evs_04_2067__section60214390"><h4 class="sectiontitle">Function</h4><p id="evs_04_2067__p43967757">This API is used to update an EVS disk.</p>
</div>
<div class="section" id="evs_04_2067__section5058598"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2067__ul4618564"><li id="evs_04_2067__li41567079">URI format<p id="evs_04_2067__p11490242"><a name="evs_04_2067__li41567079"></a><a name="li41567079"></a>PUT /v2/{project_id}/volumes/{volume_id}</p>
</li><li id="evs_04_2067__li36303315">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table58294385" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__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_2067__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_2067__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_2067__p1182010">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__row28634009"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2067__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_2067__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_2067__p16154192">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2067__row11170003"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2067__p32355065">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_2067__p3514615">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_2067__p16248438">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2067__section45527389"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2067__ul105490301197"><li id="evs_04_2067__li1954923081910">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table85492307197" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__row15491230181913"><th align="left" class="cellrowborder" valign="top" width="17%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="evs_04_2067__p15491730181917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="18%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="evs_04_2067__p1854973018195">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="evs_04_2067__p13550630141913">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="evs_04_2067__p1555019303199">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__row1055013081912"><td class="cellrowborder" valign="top" width="17%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="evs_04_2067__p7550193019199">volume</p>
</td>
<td class="cellrowborder" valign="top" width="18%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="evs_04_2067__p655083017196">Object</p>
</td>
<td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="evs_04_2067__p165509307197">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="evs_04_2067__p2550143018191">The information of the disk to be updated. For details, see <a href="#evs_04_2067__li44975500">Parameters in the volume field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2067__ul4997277"><li id="evs_04_2067__li44975500"><a name="evs_04_2067__li44975500"></a><a name="li44975500"></a>Parameters in the <strong id="evs_04_2067__b4977222113311">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table2126321" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__row49924131"><th align="left" class="cellrowborder" valign="top" width="15.6%" id="mcps1.3.3.3.1.2.1.5.1.1"><p id="evs_04_2067__p37408856172245">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.229999999999999%" id="mcps1.3.3.3.1.2.1.5.1.2"><p id="evs_04_2067__p11847581">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.11%" id="mcps1.3.3.3.1.2.1.5.1.3"><p id="evs_04_2067__p20130041">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="52.059999999999995%" id="mcps1.3.3.3.1.2.1.5.1.4"><p id="evs_04_2067__p19920592">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__row64095011151910"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2067__p17428326151912">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2067__p2408306151912">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2067__p60855094151912">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.059999999999995%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2067__p30315611151912">The disk name. <span id="evs_04_2067__text445196895201356">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row22579971154332"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2067__p38689692151834">description</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2067__p46857371151834">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2067__p37350702151834">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.059999999999995%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2067__p5508030151834">The disk description. <span id="evs_04_2067__text122876569420143">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row8766885152152"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2067__p24732045152159">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2067__evs_04_2010_p159017261855">Object</p>
</td>
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2067__p64826762152159">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.059999999999995%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2067__p63795990152036">The disk metadata.</p>
<p id="evs_04_2067__p16476402152159"><span id="evs_04_2067__text39777218152047">The length of the key or value in the metadata cannot exceed 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row62503562"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2067__p8330898151834">display_name</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2067__p3714153151834">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2067__p32411005151834">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.059999999999995%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2067__p8045749151834">Also the disk name. You can specify either parameter <strong id="evs_04_2067__b84235270614459">name</strong> or <strong id="evs_04_2067__b842352706144516">display_name</strong>. If both parameters are specified, the <strong id="evs_04_2067__b2131783664144619">name</strong> value is used. <span id="evs_04_2067__text3940679201424">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row20483630151827"><td class="cellrowborder" valign="top" width="15.6%" headers="mcps1.3.3.3.1.2.1.5.1.1 "><p id="evs_04_2067__p26880332151834">display_description</p>
</td>
<td class="cellrowborder" valign="top" width="15.229999999999999%" headers="mcps1.3.3.3.1.2.1.5.1.2 "><p id="evs_04_2067__p29823311151834">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.11%" headers="mcps1.3.3.3.1.2.1.5.1.3 "><p id="evs_04_2067__p66877970151834">No</p>
</td>
<td class="cellrowborder" valign="top" width="52.059999999999995%" headers="mcps1.3.3.3.1.2.1.5.1.4 "><p id="evs_04_2067__p48406461151834">Also the disk description. You can specify either parameter <strong id="evs_04_2067__b2118105858">description</strong> or <strong id="evs_04_2067__b779200592">display_description</strong>. If both parameters are specified, the <strong id="evs_04_2067__b742795857">description</strong> value is used. <span id="evs_04_2067__text764644858201439">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="evs_04_2067__ul28722627"><li id="evs_04_2067__li57177053">Example request<pre class="screen" id="evs_04_2067__screen64233787161318">{
"volume": {
"name": "test_volume",
"description": "test"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2067__section7093323"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2067__ul37131542"><li id="evs_04_2067__li144811317182310">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table1748117172239" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__row20481417172314"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_2067__p7481191752317">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_2067__p13481191712238">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.330000000000005%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_2067__p10481111716234">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__row204817173238"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2067__p16481161713233">volume</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2067__p74811417152312">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2067__p3481517182317">The information of the updated disk. For details, see <a href="#evs_04_2067__li3451542201439">Parameters in the volume field</a>.</p>
</td>
</tr>
<tr id="evs_04_2067__row8481121710237"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_2067__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_2067__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_2067__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2067__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2067__li3451542201439"><a name="evs_04_2067__li3451542201439"></a><a name="li3451542201439"></a>Parameters in the <strong id="evs_04_2067__b17521621133516">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table34701445142557" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__row12524911142557"><th align="left" class="cellrowborder" valign="top" width="20.24%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_2067__p7884856142557">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_2067__p34693598142557">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="58.330000000000005%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_2067__p58539486142557">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__row444782011610"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p18308336144438">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p6580236144438">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p21928856144438">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2067__row44077962142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p14226985144438">links</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p50073503191822">list&lt;map&lt;String,String&gt;&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p50473003144438">The disk URI. For details, see <a href="#evs_04_2067__li44312371185927">Parameters in the links field</a>.</p>
</td>
</tr>
<tr id="evs_04_2067__row16186817142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p19162411144438">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p8651439144438">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p55103877144438">The disk name.</p>
</td>
</tr>
<tr id="evs_04_2067__row2987651144410"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p39625821144438">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p55574965144438">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p24889213144438">The disk status. For details, see <a href="evs_04_0040.html">EVS Disk Status</a>.</p>
</td>
</tr>
<tr id="evs_04_2067__row45785905142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p24843442144438">attachments</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p66161799144438">list</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p27432950144438">The disk attachment information. For details, see <a href="#evs_04_2067__li55979002185927">Parameters in the attachments field</a>.</p>
</td>
</tr>
<tr id="evs_04_2067__row35247553142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p179170144438">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p14512814144438">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p58206487144438">The AZ to which the disk belongs.</p>
</td>
</tr>
<tr id="evs_04_2067__row27126244142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p19727534144438">bootable</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p54426427144438">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2067__evs_04_2010_p8780414125315">Whether the disk is bootable.<ul id="evs_04_2067__ul185931714111"><li id="evs_04_2067__li135936114118"><strong id="evs_04_2067__b1749195319245">true</strong>: indicates a bootable disk.</li><li id="evs_04_2067__li1593611917"><strong id="evs_04_2067__b1991012554247">false</strong>: indicates a non-bootable disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2067__row52922635184145"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p59662004184223">encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p784118184223">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p44329057184223"><span id="evs_04_2067__text63417197184223">This field is currently not supported.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row49237196142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p28651206144438">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p1296456144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p28821893144438">The time when the disk was created.</p>
<p id="evs_04_2067__p586613505312"><span id="evs_04_2067__text28661350936">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2067__row39017307142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p6085885144438">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p18611115144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p44410693144438">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2067__row20107664142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p28923171144438">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p22198851144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p9630579144438">The disk type.</p>
<div class="p" id="evs_04_2067__p12887229134510">The value can be <strong id="evs_04_2067__evs_04_2003_evs_04_2013_b18986209175810">ESSD</strong>, <strong id="evs_04_2067__evs_04_2003_evs_04_2013_b139865912588">GPSSD</strong>, <strong id="evs_04_2067__evs_04_2003_evs_04_2013_b198719145816">SSD</strong>, <strong id="evs_04_2067__evs_04_2003_evs_04_2013_b1198714910584">SAS</strong>, or <strong id="evs_04_2067__evs_04_2003_evs_04_2013_b17987193587">SATA</strong>.<ul id="evs_04_2067__evs_04_2003_evs_04_2013_ul13901722818"><li id="evs_04_2067__evs_04_2003_evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_2067__evs_04_2003_evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_2067__evs_04_2003_evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_2067__evs_04_2003_evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_2067__evs_04_2003_evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_2067__evs_04_2003_evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_2067__evs_04_2003_evs_04_2013_evs_04_2003_li1444614485511"><strong id="evs_04_2067__evs_04_2003_evs_04_2013_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="evs_04_2067__evs_04_2003_evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_2067__evs_04_2003_evs_04_2013_b529917133589">ESSD</strong>: the extreme SSD type</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2067__row12897861142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p41370851144438">replication_status</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p7354807144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p27786537144438"><span id="evs_04_2067__text6498181171119">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row45680217142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p56617581144438">consistencygroup_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p25180208144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p40860550144438"><span id="evs_04_2067__text13343838181111">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row47480567142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p58114746144438">source_volid</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p47440982144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p52975605144438">The source disk ID.</p>
<p id="evs_04_2067__p186622098367"><span id="evs_04_2067__text12532347191815">This field is currently not supported.</span></p>
</td>
</tr>
<tr id="evs_04_2067__row31517135142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p31619531144438">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p66078031144535">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p57055846144438">The snapshot ID.</p>
</td>
</tr>
<tr id="evs_04_2067__row15610713142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p53325033144438">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p24360403144438">Object</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p42403730144438">The disk metadata. For details, see <a href="#evs_04_2067__li29114110314">Parameters in the metadata field</a>.</p>
</td>
</tr>
<tr id="evs_04_2067__row5657368142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p42241765144438">size</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p66139813144438">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p17400122144438">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2067__row39412545144428"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p1113688144438">user_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p51894643144540">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p109947201368">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2067__row25381049144431"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p26680804144438">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p39072645144540">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p42877354144438">The time when the disk was updated.</p>
<p id="evs_04_2067__p128341116112619"><span id="evs_04_2067__text19834191618261">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="evs_04_2067__row48384415144425"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p51969649144438">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p48792012144438">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p15113052144438">Whether the disk is shareable.</p>
<div class="note" id="evs_04_2067__note1645730517525"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2067__evs_04_2013_p45212589213213">This field is no longer used. Use <strong id="evs_04_2067__evs_04_2013_b84235270610834">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2067__row42462677142557"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p11561839144438">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p64093800144438">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><div class="p" id="evs_04_2067__evs_04_2010_p4781191416535">Whether the disk is shareable.<ul id="evs_04_2067__ul161621719119"><li id="evs_04_2067__li91631519818"><strong id="evs_04_2067__b173868547256">true</strong>: indicates a shared disk.</li><li id="evs_04_2067__li1916311191410"><strong id="evs_04_2067__b11638597253">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2067__row410753425220"><td class="cellrowborder" valign="top" width="20.24%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_2067__p1110743415525">storage_cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_2067__p91072034185213">String</p>
</td>
<td class="cellrowborder" valign="top" width="58.330000000000005%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_2067__p19107163425219">The reserved field.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2067__li44312371185927"><a name="evs_04_2067__li44312371185927"></a><a name="li44312371185927"></a>Parameters in the <strong id="evs_04_2067__b3190144816178">links</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table24355024185927" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2067__p47699944185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_2067__p53015590185927">The corresponding shortcut link.</p>
</td>
</tr>
<tr id="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_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_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_2067__p57795935185927">The shortcut link marker name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2067__li55979002185927"><a name="evs_04_2067__li55979002185927"></a><a name="li55979002185927"></a>Parameters in the <strong id="evs_04_2067__b84235270692535">attachments</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__table6503386185927" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2067__p50913593185927">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_2067__p49891705185927">The ID of the server to which the disk is attached.</p>
</td>
</tr>
<tr id="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_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_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_2067__p35416329185927">The ID of the attachment information.</p>
</td>
</tr>
<tr id="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_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_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_2067__p38329099185927">The time when the disk was attached.</p>
<p id="evs_04_2067__p3414132514312"><span id="evs_04_2067__text7299269449">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</span></p>
</td>
</tr>
<tr id="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_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_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_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_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_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_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_2067__p48959624185927">The disk ID.</p>
</td>
</tr>
<tr id="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_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_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_2067__p22392462185927">The device name.</p>
</td>
</tr>
<tr id="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_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_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_2067__p14021450185927">The ID of the attached disk.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2067__li29114110314"><a name="evs_04_2067__li29114110314"></a><a name="li29114110314"></a>Parameters in the <strong id="evs_04_2067__evs_04_3004_b1734614164165">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__evs_04_3004_table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__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_2067__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_2067__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_2067__evs_04_3004_p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__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_2067__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_2067__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_2067__evs_04_3004_p177192813501">The encryption field in <strong id="evs_04_2067__evs_04_3004_b84235270614509">metadata</strong>.<ul id="evs_04_2067__evs_04_3004_ul141951225145011"><li id="evs_04_2067__evs_04_3004_li191951925125013"><strong id="evs_04_2067__evs_04_3004_b87781551824">0</strong>: indicates a non-encrypted disk.</li><li id="evs_04_2067__evs_04_3004_li11195192510508"><strong id="evs_04_2067__evs_04_3004_b181881011732">1</strong>: indicates an encrypted disk.</li><li id="evs_04_2067__evs_04_3004_li191958257506">If this parameter does not appear, the disk is not encrypted.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2067__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_2067__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_2067__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_2067__evs_04_3004_p4159804295622">The encryption CMK ID in <strong id="evs_04_2067__evs_04_3004_b84235270615116">metadata</strong>. This parameter is used together with <strong id="evs_04_2067__evs_04_3004_b842352706143827">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2067__evs_04_3004_b84235270614396">cmkid</strong> is fixed at 36 bytes.</p>
</td>
</tr>
<tr id="evs_04_2067__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_2067__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_2067__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_2067__evs_04_3004_p17177177145116">The parameter that describes the disk device type in <strong id="evs_04_2067__evs_04_3004_b13632941434">metadata</strong>. The value can be <strong id="evs_04_2067__evs_04_3004_b116336411432">true</strong> or <strong id="evs_04_2067__evs_04_3004_b36337410319">false</strong>.<ul id="evs_04_2067__evs_04_3004_ul14462208141855"><li id="evs_04_2067__evs_04_3004_li16942218141855"><strong id="evs_04_2067__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_2067__evs_04_3004_li42055621173515"><strong id="evs_04_2067__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_2067__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_2067__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_2067__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_2067__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_2067__evs_04_3004_p47931946183150">The clone method. If the disk is created from a snapshot, value <strong id="evs_04_2067__evs_04_3004_b337155114417">0</strong> indicates the linked cloning method.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2067__li0419202382514"><a name="evs_04_2067__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2067__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2067__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2067__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.6.2.1.4.1.1"><p id="evs_04_2067__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.6.2.1.4.1.2"><p id="evs_04_2067__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.6.2.1.4.1.3"><p id="evs_04_2067__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2067__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.1 "><p id="evs_04_2067__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.2 "><p id="evs_04_2067__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.6.2.1.4.1.3 "><p id="evs_04_2067__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2067__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.1 "><p id="evs_04_2067__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.6.2.1.4.1.2 "><p id="evs_04_2067__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.6.2.1.4.1.3 "><p id="evs_04_2067__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2067__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_2067__li65748423">Example response<pre class="screen" id="evs_04_2067__screen665746016141">{
"volume": {
"attachments": [ ],
"availability_zone": "az-dc-1",
"bootable": "false",
"consistencygroup_id": null,
"created_at": "2016-05-25T02:38:40.392463",
"description": "create for api test",
"encrypted": false,
"id": "8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"links": [
{
"href": "https://volume.localdomain.com:8776/v2/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"rel": "self"
},
{
"href": "https://volume.localdomain.com:8776/5dd0b0056f3d47b6ab4121667d35621a/volumes/8dd7c486-8e9f-49fe-bceb-26aa7e312b66",
"rel": "bookmark"
}
],
"metadata": {
"volume_owner": "openapi"
},
"name": "openapi_vol01",
"replication_status": "disabled",
"multiattach": false,
"size": 40,
"snapshot_id": null,
"source_volid": null,
"status": "creating",
"updated_at": null,
"user_id": "39f6696ae23740708d0f358a253c2637",
"volume_type": "SAS"
}
}</pre>
<p id="evs_04_2067__p8355436185729">or</p>
<pre class="screen" id="evs_04_2067__screen3661268914456">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
<p id="evs_04_2067__p5655715720175">In the preceding example, <strong id="evs_04_2067__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2067__b842352706144438">badRequest</strong> or <strong id="evs_04_2067__b842352706144454">itemNotFound</strong>. An example is provided as follows:</p>
<pre class="screen" id="evs_04_2067__screen54581143201731">{
"badRequest": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2067__section63839913"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2067__ul9862716"><li id="evs_04_2067__li21655584">Normal<p id="evs_04_2067__p60682533"><a name="evs_04_2067__li21655584"></a><a name="li21655584"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2067__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2067__evs_04_2013_p783819215242">For details, see <a href="evs_04_0038.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="evs_04_2064.html">Disk Management</a></div>
</div>
</div>
View Git Blame Copy Permalink