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

320 lines
33 KiB
HTML
Raw Blame History

<a name="evs_04_3003"></a><a name="evs_04_3003"></a>
<h1 class="topictitle1">Creating EVS Disks</h1>
<div id="body1521458935930"><div class="section" id="evs_04_3003__section2630087"><h4 class="sectiontitle">Function</h4><p id="evs_04_3003__p12872118">This API is used to create one or multiple EVS disks. <span id="evs_04_3003__text320136745112710"></span></p>
</div>
<div class="section" id="evs_04_3003__section23670787"><h4 class="sectiontitle">URI</h4><ul id="evs_04_3003__ul36008632"><li id="evs_04_3003__li55642234">URI format<p id="evs_04_3003__p10727144"><a name="evs_04_3003__li55642234"></a><a name="li55642234"></a>POST /v3/{project_id}/cloudvolumes</p>
</li><li id="evs_04_3003__li63592346">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3003__table35460209" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3003__row34639550"><th align="left" class="cellrowborder" valign="top" width="28.822882288228826%" id="mcps1.3.2.2.2.1.1.4.1.1"><p id="evs_04_3003__p54340147">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="26.752675267526755%" id="mcps1.3.2.2.2.1.1.4.1.2"><p id="evs_04_3003__p39475801">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.42444244424442%" id="mcps1.3.2.2.2.1.1.4.1.3"><p id="evs_04_3003__p43423319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3003__row27627990"><td class="cellrowborder" valign="top" width="28.822882288228826%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_3003__p23274750">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="26.752675267526755%" headers="mcps1.3.2.2.2.1.1.4.1.2 "><p id="evs_04_3003__p6206582">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="44.42444244424442%" headers="mcps1.3.2.2.2.1.1.4.1.3 "><p id="evs_04_3003__p32971110">The project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_3003__section11710498"><h4 class="sectiontitle">Request</h4><ul id="evs_04_3003__evs_04_2013_ul53414263"><li id="evs_04_3003__evs_04_2013_li18478559163718">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3003__evs_04_2013_table99446146381" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3003__evs_04_2013_row14945201493812"><th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="evs_04_3003__evs_04_2013_p49451414203813">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="evs_04_3003__evs_04_2013_p7945514153819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="evs_04_3003__evs_04_2013_p14945114203813">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.515151515151516%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="evs_04_3003__evs_04_2013_p4946111443810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3003__evs_04_2013_row11946111410383"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p11946214173818">volume</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p394615141385">Object</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p1494601423811">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p9946141418386">The information of the disk to be created. For details, see <a href="#evs_04_3003__evs_04_2013_li10966323">Parameters in the volume field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_3003__evs_04_2013_li10966323"><a name="evs_04_3003__evs_04_2013_li10966323"></a><a name="evs_04_2013_li10966323"></a>Parameters in the <strong id="evs_04_3003__evs_04_2013_b1989195217584">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3003__evs_04_2013_table31588048" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3003__evs_04_2013_row57330849"><th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.2.2.2.1.5.1.1"><p id="evs_04_3003__evs_04_2013_p13287175">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.14141414141414%" id="mcps1.3.3.2.2.2.1.5.1.2"><p id="evs_04_3003__evs_04_2013_p2519427">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.17171717171717%" id="mcps1.3.3.2.2.2.1.5.1.3"><p id="evs_04_3003__evs_04_2013_p2747002">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.515151515151516%" id="mcps1.3.3.2.2.2.1.5.1.4"><p id="evs_04_3003__evs_04_2013_p21180630">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3003__evs_04_2013_row56407950"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p5641212">backup_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p54284994">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p35008393">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p17107576">The backup ID. This parameter is mandatory when you create the disk from a backup.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note4897195216919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p36962210273">For how to obtain the backup ID, see <strong id="evs_04_3003__evs_04_2013_b12309418634">Querying All Backups</strong> in the <em id="evs_04_3003__evs_04_2013_i491717520">Cloud Backup and Recovery API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row19750463"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p56283646">availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p62681466">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p12823082184254">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p66510234184157">The AZ where you want to create the disk. If the specified AZ does not exist, the disk will fail to be created.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note18354235112810"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p14110155594414">For details about how to obtain the AZ, see <a href="evs_04_2081.html">Querying All AZs</a>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row22709757"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p27551015">description</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p17039762">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p38043494">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p58865735113756">The disk description, which can contain a maximum of 255 bytes.</p>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row17746329"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p28166553">size</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p66898301">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p50053294">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><div class="p" id="evs_04_3003__evs_04_2013_p27784979">The disk size, in GB. The value can be as follows:<ul id="evs_04_3003__evs_04_2013_ul24506304547"><li id="evs_04_3003__evs_04_2013_li13450103010545">System disk: 1 GB to 1024 GB</li><li id="evs_04_3003__evs_04_2013_li124501630205416">Data disk: 10 GB to 32768 GB</li></ul>
</div>
<p id="evs_04_3003__evs_04_2013_p1869819398426">This parameter is mandatory when you create an empty disk. You can specify the parameter value as required within the value range.</p>
<p id="evs_04_3003__evs_04_2013_p433134181712">This parameter is mandatory when you create the disk from a snapshot. Ensure that the disk size is greater than or equal to the snapshot size.</p>
<p id="evs_04_3003__evs_04_2013_p108486266429">This parameter is mandatory when you create the disk from an image. Ensure that the disk size is greater than or equal to the minimum disk capacity required by <strong id="evs_04_3003__evs_04_2013_b11901953203815">min_disk</strong> in the image attributes.</p>
<p id="evs_04_3003__evs_04_2013_p55481787">This parameter is optional when you create the disk from a backup. If this parameter is not specified, the disk size is equal to the backup size.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note6528620415911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p5070492815911">If the specified value is a decimal, the number part of the value will be used.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row29574043"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p46687245">name</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p23570516">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p30163672">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p30342314172932">The disk name.</p>
<ul id="evs_04_3003__evs_04_2013_ul46606633102055"><li id="evs_04_3003__evs_04_2013_li66471928102058">If you create disks one by one, the <strong id="evs_04_3003__evs_04_2013_b14321251122719">name</strong> value is the disk name, which can contain a maximum of 255 characters.</li><li id="evs_04_3003__evs_04_2013_li1866543818464">If you create multiple disks (the <strong id="evs_04_3003__evs_04_2013_b153177451299">count</strong> value greater than <strong id="evs_04_3003__evs_04_2013_b9330184518293">1</strong>), the system will automatically add a hyphen followed by a four-digit incremental number, such as <strong id="evs_04_3003__evs_04_2013_b9331345192917">-0000</strong>, to the end of each disk name. For example, the disk names can be <strong id="evs_04_3003__evs_04_2013_b1926735592916">volume-0001</strong> and <strong id="evs_04_3003__evs_04_2013_b1926810550294">volume-0002</strong>. The value can contain a maximum of 250 bytes.</li></ul>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row30068235161750"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p41087296161752">snapshot_id</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p39736646161752">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p64551757161752">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p61309820161752">The snapshot ID. If this parameter is specified, the disk will be created from a snapshot.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note13293123112911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p129419232297">For details about how to obtain the snapshot ID, see <a href="evs_04_3060.html">Querying Details About EVS Snapshots</a>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row65447007"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p66716242">imageRef</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p35306501">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p41254304">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p53264332">The image ID. If this parameter is specified, the disk will be created from an image.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note13789049151930"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p56992577151930">BMS system disks cannot be created from BMS images.</p>
<p id="evs_04_3003__evs_04_2013_p257253253318">For how to obtain the image ID, see <strong id="evs_04_3003__evs_04_2013_b53641122183918">Querying Images</strong> in the <em id="evs_04_3003__evs_04_2013_i448612173612">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row9616944"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p40774967">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p14438051">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p41198362184535">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p14380476104717">The disk type.</p>
<div class="p" id="evs_04_3003__evs_04_2013_p12887229134510">The value can be <strong id="evs_04_3003__evs_04_2013_b18986209175810">ESSD</strong>, <strong id="evs_04_3003__evs_04_2013_b139865912588">GPSSD</strong>, <strong id="evs_04_3003__evs_04_2013_b198719145816">SSD</strong>, <strong id="evs_04_3003__evs_04_2013_b1198714910584">SAS</strong>, or <strong id="evs_04_3003__evs_04_2013_b17987193587">SATA</strong>.<ul id="evs_04_3003__evs_04_2013_ul13901722818"><li id="evs_04_3003__evs_04_2013_evs_04_2003_li15488111934310"><strong id="evs_04_3003__evs_04_2013_b2038683423316">SSD</strong>: the ultra-high I/O type</li><li id="evs_04_3003__evs_04_2013_evs_04_2003_li0488119194318"><strong id="evs_04_3003__evs_04_2013_b769013365337">SAS</strong>: the high I/O type</li><li id="evs_04_3003__evs_04_2013_evs_04_2003_li348881917438"><strong id="evs_04_3003__evs_04_2013_b581443819334">SATA</strong>: the common I/O type</li><li id="evs_04_3003__evs_04_2013_evs_04_2003_li1444614485511"><strong id="evs_04_3003__evs_04_2013_b616518497339">GPSSD</strong>: the general purpose SSD type</li><li id="evs_04_3003__evs_04_2013_evs_04_2003_li17697121195818"><strong id="evs_04_3003__evs_04_2013_b529917133589">ESSD</strong>: the extreme SSD type</li></ul>
</div>
<p id="evs_04_3003__evs_04_2013_p62741351184614">If the specified disk type is not available in the AZ, the disk will fail to be created.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note21808274104217"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="evs_04_3003__evs_04_2013_ul5307015718498"><li id="evs_04_3003__evs_04_2013_li51745800123738">When the disk is created from a backup:<p id="evs_04_3003__evs_04_2013_p60300043123750"><a name="evs_04_3003__evs_04_2013_li51745800123738"></a><a name="evs_04_2013_li51745800123738"></a>If the type of the backup's source disk is <strong id="evs_04_3003__evs_04_2013_b4869418451723">SSD</strong>, <strong id="evs_04_3003__evs_04_2013_b10527307431723">SAS</strong>, <strong id="evs_04_3003__evs_04_2013_b17340922121723">SATA</strong>, <strong id="evs_04_3003__evs_04_2013_b0892223142219">GPSSD</strong>, or <strong id="evs_04_3003__evs_04_2013_b154030415257">ESSD</strong>, you can create disks of any of these types.</p>
</li><li id="evs_04_3003__evs_04_2013_p62056744104217">When the disk is created from a snapshot, the disk type of the new disk will be consistent with that of the snapshot's source disk.</li><li id="evs_04_3003__evs_04_2013_li1553612312507">For details about disk types, see <strong id="evs_04_3003__evs_04_2013_b68971258152816">Disk Types and Performance</strong> in the <em id="evs_04_3003__evs_04_2013_i176361210290">Elastic Volume Service User Guide</em>.</li></ul>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row7461047"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p365031">count</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p29567523">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p428797710293">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p47906786">The number of disks to be created in a batch. If this parameter is not specified, only one disk will be created. You can create a maximum of 100 disks in a batch.</p>
<p id="evs_04_3003__evs_04_2013_p9550502101436">If disks are created from backups, batch creation is not supported, and this parameter must be set to <span class="parmname" id="evs_04_3003__evs_04_2013_parmname1151762787105851"><b>1</b></span>.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note57300341151148"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_evs_04_2013_p5070492815911">If the specified value is a decimal, the number part of the value will be used.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row2434599211437"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p1778734011437">shareable</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p3148844911437">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p42756211437">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p3463256011437">Whether the disk is shareable. The value can be <strong id="evs_04_3003__evs_04_2013_b1234733726161036">true</strong> (shared disk) or <strong id="evs_04_3003__evs_04_2013_b441872521161041">false</strong> (common disk).</p>
<div class="note" id="evs_04_3003__evs_04_2013_note3800959821323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p45212589213213">This field is no longer used. Use <strong id="evs_04_3003__evs_04_2013_b84235270610834">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row494599159816"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p424860529816">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p153174581512">Map&lt;String,String&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p478805289816">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p651813253119">The metadata of the disk to be created.</p>
<p id="evs_04_3003__evs_04_2013_p1467718484304">Optional parameters:</p>
<p id="evs_04_3003__evs_04_2013_p1831134571512">The encryption CMK ID in <strong id="evs_04_3003__evs_04_2013_b4382183513251">metadata</strong>. This parameter is used together with <strong id="evs_04_3003__evs_04_2013_b1383173513255">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_3003__evs_04_2013_b43831035172513">cmkid</strong> is fixed at 36 bytes.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note19323458151"><span class="notetitle"> NOTE: </span><div class="notebody"></div></div>
<p id="evs_04_3003__evs_04_2013_p1232174511518"><strong id="evs_04_3003__evs_04_2013_b148563315167">__system__encrypted</strong>: the encryption field in <strong id="evs_04_3003__evs_04_2013_b1067134151520">metadata</strong>. The value can be <strong id="evs_04_3003__evs_04_2013_b156711741141516">0</strong> (does not encrypt the disk) or <strong id="evs_04_3003__evs_04_2013_b1167210411156">1</strong> (encrypts the disk). If this parameter is not specified, the encryption attribute of the disk will be the same as that of the data source. If the disk is not created from a data source, the disk will not be encrypted by default.</p>
<p id="evs_04_3003__evs_04_2013_p632745111517"><strong id="evs_04_3003__evs_04_2013_b139114590176">full_clone</strong>: If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to <strong id="evs_04_3003__evs_04_2013_b20639104441710">0</strong>.</p>
<p id="evs_04_3003__evs_04_2013_p1632134519157"><strong id="evs_04_3003__evs_04_2013_b34056208185">hw:passthrough</strong>:</p>
<ul id="evs_04_3003__evs_04_2013_ul14321245201520"><li id="evs_04_3003__evs_04_2013_li1732144511157">If this parameter is set to <strong id="evs_04_3003__evs_04_2013_b16462191016183">true</strong>, the disk device type will be SCSI, which allows ECS OSs to directly access underlying storage media. SCSI reservation commands are supported.</li><li id="evs_04_3003__evs_04_2013_li153316452155">If this parameter is set to <strong id="evs_04_3003__evs_04_2013_b84235270620394">false</strong>, the disk device type will be VBD, which supports only simple SCSI read/write commands.</li><li id="evs_04_3003__evs_04_2013_li733184517152">If this parameter is not specified, the disk device type will be VBD.</li></ul>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row4752931910472"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p2466966510472">multiattach</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p5208587610472">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p5820640710472">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><div class="p" id="evs_04_3003__evs_04_2013_p4531155053519">Whether the disk is shareable. The default value is <strong id="evs_04_3003__evs_04_2013_b842352706193458">false</strong>.<ul id="evs_04_3003__evs_04_2013_ul202952187368"><li id="evs_04_3003__evs_04_2013_li182958188365"><strong id="evs_04_3003__evs_04_2013_b1238122216397">true</strong>: indicates a shared disk.</li><li id="evs_04_3003__evs_04_2013_li0295171811366"><strong id="evs_04_3003__evs_04_2013_b13618324103910">false</strong>: indicates a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row42399185112340"><td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.1 "><p id="evs_04_3003__evs_04_2013_p11781930112340">tags</p>
</td>
<td class="cellrowborder" valign="top" width="14.14141414141414%" headers="mcps1.3.3.2.2.2.1.5.1.2 "><p id="evs_04_3003__evs_04_2013_p14812235112340">Object</p>
</td>
<td class="cellrowborder" valign="top" width="17.17171717171717%" headers="mcps1.3.3.2.2.2.1.5.1.3 "><p id="evs_04_3003__evs_04_2013_p58940381112340">No</p>
</td>
<td class="cellrowborder" valign="top" width="51.515151515151516%" headers="mcps1.3.3.2.2.2.1.5.1.4 "><p id="evs_04_3003__evs_04_2013_p9441543112340">The tags to be added to the disk during the disk creation.</p>
<p id="evs_04_3003__evs_04_2013_p41351845163840">A maximum of 10 tags can be added to a disk.</p>
<p id="evs_04_3003__evs_04_2013_p51240272203459">A tag key must be unique. Deduplication will be performed for duplicate keys. Therefore, only one tag key in the duplicate keys is valid.</p>
<ul id="evs_04_3003__evs_04_2013_ul3346152218352"><li id="evs_04_3003__evs_04_2013_li1713192431710">Tag key: String type<ul id="evs_04_3003__evs_04_2013_ul20512635161710"><li id="evs_04_3003__evs_04_2013_li9842040193117">Cannot be left blank.</li><li id="evs_04_3003__evs_04_2013_li757155223116">Must be unique for each resource.</li><li id="evs_04_3003__evs_04_2013_li13340142763215">Can contain a maximum of 36 characters.</li><li id="evs_04_3003__evs_04_2013_li284614435329">Can contain only digits, letters, hyphens (-), and underscores (_).</li></ul>
</li><li id="evs_04_3003__evs_04_2013_li16591753161712">Tag value: String type<ul id="evs_04_3003__evs_04_2013_ul145918711181"><li id="evs_04_3003__evs_04_2013_li1762413242333">Can contain a maximum of 43 characters.</li><li id="evs_04_3003__evs_04_2013_li1469543121810">Can contain only digits, letters, hyphens (-), and underscores (_).</li></ul>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="evs_04_3003__evs_04_2013_note1826402105335"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="evs_04_3003__evs_04_2013_p16437621105335">Specifying either two of the <span class="parmname" id="evs_04_3003__evs_04_2013_parmname119748728110175"><b>backup_id</b></span>, <span class="parmname" id="evs_04_3003__evs_04_2013_parmname148606182110175"><b>snapshot_id</b></span>, and <span class="parmname" id="evs_04_3003__evs_04_2013_parmname173323291010175"><b>imageRef</b></span> fields is not supported.</p>
</div></div>
</li><li id="evs_04_3003__evs_04_2013_li111671101086">Example request<pre class="screen" id="evs_04_3003__evs_04_2013_screen333951331086">{
"volume": {
"backup_id": null,
"count": 1,
"availability_zone": "az-dc-1",
"description": "test_volume_1",
"size": 120,
"name": "test_volume_1",
"volume_type": "SSD",
"metadata": {
"__system__encrypted": "1",
"__system__cmkid": "37b0d52e-c249-40d6-83cb-2b93f22445bd"
}
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_3003__section38285619"><h4 class="sectiontitle">Response</h4><ul id="evs_04_3003__evs_04_2013_ul54938922"><li id="evs_04_3003__evs_04_2013_li1435395814311">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3003__evs_04_2013_table735313581437" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3003__evs_04_2013_row153536585313"><th align="left" class="cellrowborder" valign="top" width="21.157884211578843%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="evs_04_3003__evs_04_2013_p123541158732">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.197880211978802%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="evs_04_3003__evs_04_2013_p1435411581320">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="evs_04_3003__evs_04_2013_p13541058036">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3003__evs_04_2013_row1135495819312"><td class="cellrowborder" valign="top" width="21.157884211578843%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3003__evs_04_2013_p33545583319">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.197880211978802%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3003__evs_04_2013_p19354165810317">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3003__evs_04_2013_p435416581936">The task ID.</p>
<div class="note" id="evs_04_3003__evs_04_2013_note335410589314"><span class="notetitle"> NOTE: </span><div class="notebody"></div></div>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row195162113414"><td class="cellrowborder" valign="top" width="21.157884211578843%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="evs_04_3003__evs_04_2013_p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="21.197880211978802%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="evs_04_3003__evs_04_2013_evs_04_2010_p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="evs_04_3003__evs_04_2013_p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_3003__evs_04_2013_li24688256">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_3003__evs_04_2013_li24688256"><a name="evs_04_3003__evs_04_2013_li24688256"></a><a name="evs_04_2013_li24688256"></a>Parameters in the <strong id="evs_04_3003__evs_04_2013_b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_3003__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_3003__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.1"><p id="evs_04_3003__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.4.2.2.2.1.4.1.2"><p id="evs_04_3003__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.4.2.2.2.1.4.1.3"><p id="evs_04_3003__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_3003__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3003__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3003__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3003__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_3003__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.1 "><p id="evs_04_3003__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.4.2.2.2.1.4.1.2 "><p id="evs_04_3003__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.4.2.2.2.1.4.1.3 "><p id="evs_04_3003__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_3003__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_3003__evs_04_2013_li5754377220640">Example response<pre class="screen" id="evs_04_3003__evs_04_2013_screen32948417142534">{
"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}</pre>
<p id="evs_04_3003__evs_04_2013_p45960129">or</p>
<pre class="screen" id="evs_04_3003__evs_04_2013_screen333297795753">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_3003__section8169161010338"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_3003__evs_04_2013_ul47411987"><li id="evs_04_3003__evs_04_2013_li24054701">Normal<p id="evs_04_3003__evs_04_2013_p15165719"><a name="evs_04_3003__evs_04_2013_li24054701"></a><a name="evs_04_2013_li24054701"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_3003__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_3003__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_3002.html">Disk Management</a></div>
</div>
</div>
View Git Blame Copy Permalink