vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/evs/api-ref/evs_04_2013.html
Zaoxu, Li 305c41bb57 EVS 2.0.38 SP1 version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2022-10-19 22:27:18 +00:00

375 lines
37 KiB
HTML
Raw Permalink Blame History

<a name="evs_04_2013"></a><a name="evs_04_2013"></a>
<h1 class="topictitle1">Creating EVS Disks</h1>
<div id="body3472933"><div class="section" id="evs_04_2013__section2630087"><h4 class="sectiontitle">Function</h4><p id="evs_04_2013__p1384316781514">This API is used to create one or multiple EVS disks. <span id="evs_04_2013__text1621411586193057"></span></p>
</div>
<div class="section" id="evs_04_2013__section23670787"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2013__ul36008632"><li id="evs_04_2013__li55642234">URI format<p id="evs_04_2013__p10727144"><a name="evs_04_2013__li55642234"></a><a name="li55642234"></a>POST /v2/{project_id}/cloudvolumes</p>
</li><li id="evs_04_2013__li63592346">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2013__table35460209" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2013__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_2013__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_2013__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_2013__p43423319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2013__row27627990"><td class="cellrowborder" valign="top" width="28.822882288228826%" headers="mcps1.3.2.2.2.1.1.4.1.1 "><p id="evs_04_2013__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_2013__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_2013__p32971110">Specifies the project ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2013__section11710498"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2013__ul53414263"><li id="evs_04_2013__li18478559163718">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2013__table99446146381" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_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_2013__p4946111443810">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_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_2013__p9946141418386">Specifies the information of the disks to be created. For details, see <a href="#evs_04_2013__li10966323">Parameters in the volume field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2013__li10966323"><a name="evs_04_2013__li10966323"></a><a name="li10966323"></a>Parameters in the <strong id="evs_04_2013__b1989195217584">volume</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2013__table31588048" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_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_2013__p21180630">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_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_2013__p17107576">Specifies the ID of the backup that can be used to create a disk. This parameter is mandatory when you use a backup to create the disk.</p>
<div class="note" id="evs_04_2013__note4897195216919"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p36962210273">For how to obtain the backup ID, see <strong id="evs_04_2013__b12309418634">Querying All Backups</strong> in the <em id="evs_04_2013__i491717520">Cloud Backup and Recovery API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p66510234184157">Specifies the AZ where you want to create the disk. If the AZ does not exist, the disk will fail to create.</p>
<div class="note" id="evs_04_2013__note18354235112810"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="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_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_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_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_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_2013__p58865735113756">Specifies the disk description. <span id="evs_04_2013__text110681216113820">The value can contain a maximum of 255 bytes.</span></p>
</td>
</tr>
<tr id="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_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_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_2013__p50053294">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_2013__p27784979">Specifies the disk size, in GB. Its value can be as follows:<ul id="evs_04_2013__ul24506304547"><li id="evs_04_2013__li13450103010545">System disk: 1 GB to 1024 GB</li><li id="evs_04_2013__li124501630205416">Data disk: 10 GB to 32768 GB</li></ul>
</div>
<p id="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_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_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_2013__b11901953203815">min_disk</strong> in the image attributes.</p>
<p id="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_2013__note6528620415911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p5070492815911">If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p30342314172932">Specifies the disk name.</p>
<ul id="evs_04_2013__ul46606633102055"><li id="evs_04_2013__li66471928102058">If you create disks one by one, the <strong id="evs_04_2013__b842352706172858">name</strong> value is the disk name. <span id="evs_04_2013__text101368932114053">The value can contain a maximum of 255 bytes.</span></li><li id="evs_04_2013__li1866543818464">If you create multiple disks (the <strong id="evs_04_2013__b153177451299">count</strong> value is greater than <strong id="evs_04_2013__b9330184518293">1</strong>), the system automatically adds a hyphen followed by a four-digit incremental number, such as <strong id="evs_04_2013__b9331345192917">-0000</strong>, to the end of each disk name. For example, the disk names can be <strong id="evs_04_2013__b682272110417">volume-0001</strong> and <strong id="evs_04_2013__b187076249411">volume-0002</strong>. <span id="evs_04_2013__text688013214465">The value can contain a maximum of 250 bytes.</span></li></ul>
</td>
</tr>
<tr id="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_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_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_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_2013__p61309820161752">Specifies the snapshot ID. If this parameter is specified, the disk is created from a snapshot.</p>
<div class="note" id="evs_04_2013__note13293123112911"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p129419232297">For details about how to obtain the snapshot ID, see <a href="evs_04_2097.html">Querying Details About EVS Snapshots</a>.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p53264332">Specifies the image ID. If this parameter is specified, the disk is created from an image.</p>
<div class="note" id="evs_04_2013__note13789049151930"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p56992577151930">BMS system disks cannot be created from BMS images.</p>
<p id="evs_04_2013__p257253253318">For how to obtain the image ID, see <strong id="evs_04_2013__b53641122183918">Querying Images</strong> in the <em id="evs_04_2013__i448612173612">Image Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p14380476104717">Specifies the disk type.</p>
<div class="p" id="evs_04_2013__p12887229134510">Currently, the value can be <strong id="evs_04_2013__evs_04_2003_b842352706164929">SSD</strong>, <strong id="evs_04_2013__evs_04_2003_b842352706164932">SAS</strong>, <strong id="evs_04_2013__evs_04_2003_b842352706164937">SATA</strong>, <strong id="evs_04_2013__evs_04_2003_b842352706164941">co-p1</strong>, or <strong id="evs_04_2013__evs_04_2003_b842352706164944">uh-l1</strong>.<ul id="evs_04_2013__evs_04_2003_ul11489121916439"><li id="evs_04_2013__evs_04_2003_li15488111934310"><strong id="evs_04_2013__evs_04_2003_b842352706165021">SSD</strong>: specifies the ultra-high I/O disk type.</li><li id="evs_04_2013__evs_04_2003_li0488119194318"><strong id="evs_04_2013__evs_04_2003_b1784237562165049">SAS</strong>: specifies the high I/O disk type.</li><li id="evs_04_2013__evs_04_2003_li348881917438"><strong id="evs_04_2013__evs_04_2003_b3295367816515">SATA</strong>: specifies the common I/O disk type.</li><li id="evs_04_2013__evs_04_2003_li848817193433"><strong id="evs_04_2013__evs_04_2003_b141033785">co-p1</strong>: specifies the high I/O (performance-optimized I) disk type.</li><li id="evs_04_2013__evs_04_2003_li548917194430"><strong id="evs_04_2013__evs_04_2003_b1336833005">uh-l1</strong>: specifies the ultra-high I/O (latency-optimized) disk type.<p id="evs_04_2013__evs_04_2003_p14488819154320">Disks of the <strong id="evs_04_2013__evs_04_2003_b108664633815116">co-p1</strong> and <strong id="evs_04_2013__evs_04_2003_b104594858115116">uh-l1</strong> types are used exclusively for HPC ECSs and SAP HANA ECSs.</p>
</li></ul>
</div>
<p id="evs_04_2013__p62741351184614">If the specified disk type is not available in the AZ, the disk will fail to create.</p>
<div class="note" id="evs_04_2013__note21808274104217"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="evs_04_2013__ul5307015718498"><li id="evs_04_2013__li51745800123738">When the disk is created from a backup:<p id="evs_04_2013__p60300043123750"><a name="evs_04_2013__li51745800123738"></a><a name="li51745800123738"></a>If the type of the backup's source disk is <strong id="evs_04_2013__b4869418451723">SSD</strong>, <strong id="evs_04_2013__b10527307431723">SAS</strong>, or <strong id="evs_04_2013__b17340922121723">SATA</strong>, you can create disks of any of these types.</p>
<p id="evs_04_2013__p59443049123759">If the type of the backup's source disk is <strong id="evs_04_2013__b84235270617530">co-p1</strong> or <strong id="evs_04_2013__b84235270617547">uh-l1</strong>, you can create disks of any of the two types.</p>
</li><li id="evs_04_2013__p62056744104217"><span id="evs_04_2013__text7492111913438">If the disk is created from a snapshot, the volume_type field must be the same as that of the snapshot's source disk.</span></li><li id="evs_04_2013__li1553612312507">For details about disk types, see <strong id="evs_04_2013__b68971258152816">Disk Types and Disk Performance</strong> in the <em id="evs_04_2013__i176361210290">Elastic Volume Service User Guide</em>.</li></ul>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p47906786">Specifies the number of disks to be created in a batch. If this parameter is not specified, only one disk is created. You can create a maximum of 100 disks in a batch.</p>
<p id="evs_04_2013__p9550502101436">If disks are created from a backup, batch creation is not supported, and this parameter must be set to <span class="parmname" id="evs_04_2013__parmname1151762787105851"><b>1</b></span>.</p>
<div class="note" id="evs_04_2013__note57300341151148"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__evs_04_2013_p5070492815911">If the specified parameter value is a decimal, the integral part of the value is used by default when the request is sent.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p3463256011437">Specifies whether the disk is shareable. The value can be <strong id="evs_04_2013__b1234733726161036">true</strong> (shared disk) or <strong id="evs_04_2013__b441872521161041">false</strong> (common disk).</p>
<div class="note" id="evs_04_2013__note3800959821323"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p45212589213213">This field is no longer used. Use <strong id="evs_04_2013__b84235270610834">multiattach</strong>.</p>
</div></div>
</td>
</tr>
<tr id="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_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_2013__p188182169816">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_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_2013__p323873209920">Specifies the metadata of the created disk. <span id="evs_04_2013__text308561318143517">The length of the key or value in the metadata cannot exceed 255 bytes.</span></p>
<p id="evs_04_2013__p862801317585">For details about <strong id="evs_04_2013__b842352706103929">metadata</strong>, see <a href="#evs_04_2013__li4145283210319">Parameters in the metadata field</a>. Only the listed parameters can be specified when creating a disk.</p>
<div class="note" id="evs_04_2013__note660019322131"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p1600173216137">Parameter values under <strong id="evs_04_2013__b8423527062049">metadata</strong> cannot be <strong id="evs_04_2013__b842352706103415">null</strong>.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_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_2013__p4531155053519">Specifies whether the disk is shareable. The default value is <strong id="evs_04_2013__b842352706193458">false</strong>.<ul id="evs_04_2013__ul202952187368"><li id="evs_04_2013__li182958188365"><strong id="evs_04_2013__b1827893224315">true</strong>: specifies a shared disk.</li><li id="evs_04_2013__li0295171811366"><strong id="evs_04_2013__b11816235164319">false</strong>: specifies a non-shared disk.</li></ul>
</div>
</td>
</tr>
<tr id="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_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_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_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_2013__p9441543112340">Specifies the tags added to the disk during the disk creation.</p>
<p id="evs_04_2013__p41351845163840">A maximum of 10 tags can be created for a disk.</p>
<p id="evs_04_2013__p51240272203459">Tag keys of a tag 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_2013__ul3346152218352"><li id="evs_04_2013__li1713192431710">Tag key: String type<ul id="evs_04_2013__ul20512635161710"><li id="evs_04_2013__li9842040193117">Cannot be left blank.</li><li id="evs_04_2013__li757155223116">Must be unique for each resource.</li><li id="evs_04_2013__li13340142763215">Can contain a maximum of 36 characters.</li><li id="evs_04_2013__li284614435329">Can contain only digits, letters, hyphens (-), and underscores (_).</li></ul>
</li><li id="evs_04_2013__li16591753161712">Tag value: String type<ul id="evs_04_2013__ul145918711181"><li id="evs_04_2013__li1762413242333">Can contain a maximum of 43 characters.</li><li id="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_2013__note1826402105335"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="evs_04_2013__p16437621105335">Specifying either two of the <span class="parmname" id="evs_04_2013__parmname119748728110175"><b>backup_id</b></span>, <span class="parmname" id="evs_04_2013__parmname148606182110175"><b>snapshot_id</b></span>, and <span class="parmname" id="evs_04_2013__parmname173323291010175"><b>imageRef</b></span> fields is not supported.</p>
</div></div>
</li><li id="evs_04_2013__li4145283210319"><a name="evs_04_2013__li4145283210319"></a><a name="li4145283210319"></a>Parameters in the <strong id="evs_04_2013__b842352706152641">metadata</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2013__table3430728295554" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2013__row4496975195554"><th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.3.2.3.2.1.5.1.1"><p id="evs_04_2013__p8809200174410">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.409999999999998%" id="mcps1.3.3.2.3.2.1.5.1.2"><p id="evs_04_2013__p168135017449">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.48%" id="mcps1.3.3.2.3.2.1.5.1.3"><p id="evs_04_2013__p1381850154410">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.63%" id="mcps1.3.3.2.3.2.1.5.1.4"><p id="evs_04_2013__p1282213034412">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2013__row456195295554"><td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.1 "><p id="evs_04_2013__p1562408795622">__system__encrypted</p>
</td>
<td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.3.2.1.5.1.2 "><p id="evs_04_2013__p5759155095622">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.3 "><p id="evs_04_2013__p3440400295622">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.3.2.3.2.1.5.1.4 "><p id="evs_04_2013__p729227516614">Specifies the encryption field in <strong id="evs_04_2013__b11476119724">metadata</strong>. The value can be <strong id="evs_04_2013__b44831891022">0</strong> (not encrypted) or <strong id="evs_04_2013__b9483597213">1</strong> (encrypted).</p>
<p id="evs_04_2013__p3526077895622">If this parameter does not exist, the disk will not be encrypted by default.</p>
</td>
</tr>
<tr id="evs_04_2013__row247050109562"><td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.1 "><p id="evs_04_2013__p241272995622">__system__cmkid</p>
</td>
<td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.3.2.1.5.1.2 "><p id="evs_04_2013__p6121338895622">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.3 "><p id="evs_04_2013__p5933737595622">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.3.2.3.2.1.5.1.4 "><p id="evs_04_2013__p4159804295622">Specifies the encryption CMK ID in <strong id="evs_04_2013__b8113436218">metadata</strong>. This parameter is used together with <strong id="evs_04_2013__b31015431229">__system__encrypted</strong> for encryption. The length of <strong id="evs_04_2013__b11117435215">cmkid</strong> is fixed at 36 bytes.</p>
<div class="note" id="evs_04_2013__note16994174013320"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p399515405333">For details about how to obtain the CMK ID, see <strong id="evs_04_2013__b842352706154213">Querying the List of CMKs</strong> in the <em id="evs_04_2013__i842352697153936">Key Management Service API Reference</em>.</p>
</div></div>
</td>
</tr>
<tr id="evs_04_2013__row60499086104915"><td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.1 "><p id="evs_04_2013__p1478896104915">hw:passthrough</p>
</td>
<td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.3.2.1.5.1.2 "><p id="evs_04_2013__p52681767104915">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.3 "><p id="evs_04_2013__p39364763104915">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.3.2.3.2.1.5.1.4 "><ul id="evs_04_2013__ul14462208141855"><li id="evs_04_2013__li16942218141855">If this parameter is set to <strong id="evs_04_2013__b84235270620365">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_2013__li42055621173515">If this parameter is set to <strong id="evs_04_2013__b84235270620394">false</strong>, the disk device type will be VBD, that is, Virtual Block Device, which supports only simple SCSI read/write commands.</li><li id="evs_04_2013__li922714915316">If this parameter does not appear, the disk device type is VBD.</li></ul>
</td>
</tr>
<tr id="evs_04_2013__row991210132288"><td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.1 "><p id="evs_04_2013__p3500156018292">full_clone</p>
</td>
<td class="cellrowborder" valign="top" width="15.409999999999998%" headers="mcps1.3.3.2.3.2.1.5.1.2 "><p id="evs_04_2013__p1655411118292">String</p>
</td>
<td class="cellrowborder" valign="top" width="17.48%" headers="mcps1.3.3.2.3.2.1.5.1.3 "><p id="evs_04_2013__p6581460618292">No</p>
</td>
<td class="cellrowborder" valign="top" width="49.63%" headers="mcps1.3.3.2.3.2.1.5.1.4 "><p id="evs_04_2013__p47931946183150">If the disk is created from a snapshot and linked cloning needs to be used, set this parameter to <strong id="evs_04_2013__b1229424292111849">0</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="evs_04_2013__note2244462910238"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="evs_04_2013__p338316393614">When creating a disk, you can only specify the fields of <strong id="evs_04_2013__b842352706104255">metadata</strong> listed in the preceding table.</p>
<ul id="evs_04_2013__ul157155141073"><li id="evs_04_2013__li672755311017">If the disk is created from a snapshot, <span class="parmname" id="evs_04_2013__parmname7812047010180"><b>__system__encrypted</b></span> and <span class="parmname" id="evs_04_2013__parmname92561345110180"><b>__system__cmkid</b></span> are not supported, and the newly created disk has the same encryption attribute as that of the snapshot's source disk.</li><li id="evs_04_2013__li6525963611054">If the disk is created from an image, <span class="parmname" id="evs_04_2013__parmname663022275101940"><b>__system__encrypted</b></span> and <span class="parmname" id="evs_04_2013__parmname809594445101940"><b>__system__cmkid</b></span> are not supported, and the newly created disk has the same encryption attribute as that of the image.</li><li id="evs_04_2013__li238323541073">If the disk is created from a snapshot, <span class="parmname" id="evs_04_2013__parmname1169725898102044"><b>hw:passthrough</b></span> is not supported, and the newly created disk has the same device type as that of the snapshot's source disk.</li><li id="evs_04_2013__li425622071076">If the disk is created from an image, <span class="parmname" id="evs_04_2013__parmname150998616102812"><b>hw:passthrough</b></span> is not supported, and the device type of newly created disk is VBD.</li></ul>
</div></div>
</li><li id="evs_04_2013__li111671101086">Example request<pre class="screen" id="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_2013__section38285619"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2013__ul54938922"><li id="evs_04_2013__li1435395814311">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2013__table735313581437" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2013__p13541058036">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_2013__p435416581936">Specifies the task ID.</p>
<div class="note" id="evs_04_2013__note335410589314"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="evs_04_2013__p1435514588312">For details about how to query the task status, see <a href="evs_04_0054.html">Querying Task Status</a>.</p>
</div></div>
</td>
</tr>
<tr id="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_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_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_2013__p109527215417">Specifies the error message returned when an error occurs. For details, see <a href="#evs_04_2013__li24688256">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2013__li24688256"><a name="evs_04_2013__li24688256"></a><a name="li24688256"></a>Parameters in the <strong id="evs_04_2013__b1288034833610">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2013__table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="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_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_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_2013__p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="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_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_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_2013__p21623243103019">Specifies the error message returned when an error occurs.</p>
</td>
</tr>
<tr id="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_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_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_2013__p6087468103019">Specifies the error code returned when an error occurs.</p>
<p id="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_2013__li5754377220640">Example response<pre class="screen" id="evs_04_2013__screen32948417142534">{
"job_id": "70a599e0-31e7-49b7-b260-868f441e862b"
}</pre>
<p id="evs_04_2013__p45960129">or</p>
<pre class="screen" id="evs_04_2013__screen333297795753">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2013__section9026257"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2013__ul47411987"><li id="evs_04_2013__li24054701">Normal<p id="evs_04_2013__p15165719"><a name="evs_04_2013__li24054701"></a><a name="li24054701"></a>200</p>
</li></ul>
</div>
<div class="section" id="evs_04_2013__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="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">EVS Disk</a></div>
</div>
</div>
View Git Blame Copy Permalink