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

448 lines
35 KiB
HTML
Raw Blame History

<a name="evs_04_2086"></a><a name="evs_04_2086"></a>
<h1 class="topictitle1">Exporting EVS Disk Data as an Image</h1>
<div id="body1516677130142"><div class="section" id="evs_04_2086__section54187005111229"><h4 class="sectiontitle">Function</h4><p id="evs_04_2086__p27071300111229">This API is used to export the system disk data or data disk data as an IMS image. The exported image will be displayed in the IMS private image list and can be viewed and used.</p>
</div>
<div class="section" id="evs_04_2086__section44817321519"><h4 class="sectiontitle">Constraints</h4><p id="evs_04_2086__p138812403518">If the target disk is in the <strong id="evs_04_2086__b1431011166298">in-use</strong> state, stop the server where the disk has been attached before calling this API. If the target disk is a shared disk, stop all servers where the shared disk has been attached before calling this API.</p>
</div>
<div class="section" id="evs_04_2086__section44750704111229"><h4 class="sectiontitle">URI</h4><ul id="evs_04_2086__ul928421111229"><li id="evs_04_2086__li8355791111229">URI format<p id="evs_04_2086__p51574484111229"><a name="evs_04_2086__li8355791111229"></a><a name="li8355791111229"></a>POST /v2/{project_id}/volumes/{volume_id}/action</p>
</li><li id="evs_04_2086__li61517173111229">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__table16835088111229" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__row36762725111229"><th align="left" class="cellrowborder" valign="top" width="27.88%" id="mcps1.3.3.2.2.1.1.4.1.1"><p id="evs_04_2086__p24990771111229">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.599999999999998%" id="mcps1.3.3.2.2.1.1.4.1.2"><p id="evs_04_2086__p10986545111229">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="51.519999999999996%" id="mcps1.3.3.2.2.1.1.4.1.3"><p id="evs_04_2086__p17494919111229">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__row7802334111229"><td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2086__p28009309111229">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.599999999999998%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2086__p54161581111229">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2086__p25011958111229">The project ID.</p>
</td>
</tr>
<tr id="evs_04_2086__row22284688111229"><td class="cellrowborder" valign="top" width="27.88%" headers="mcps1.3.3.2.2.1.1.4.1.1 "><p id="evs_04_2086__p60229298111229">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="20.599999999999998%" headers="mcps1.3.3.2.2.1.1.4.1.2 "><p id="evs_04_2086__p46734956111229">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="51.519999999999996%" headers="mcps1.3.3.2.2.1.1.4.1.3 "><p id="evs_04_2086__p27435111111229">The disk ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2086__section2478043111340"><h4 class="sectiontitle">Request</h4><ul id="evs_04_2086__ul66503807111340"><li id="evs_04_2086__li61663351111340">Request parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__table28675530111340" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__row30444615111340"><th align="left" class="cellrowborder" valign="top" width="23.232323232323232%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="evs_04_2086__p50094757111340">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.35143514351435%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="evs_04_2086__p31143556111340">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.96169616961696%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="evs_04_2086__p39600140111340">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454545%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="evs_04_2086__p53494756111340">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__row38107956111340"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="evs_04_2086__p66845605111340">os-volume_upload_image</p>
</td>
<td class="cellrowborder" valign="top" width="14.35143514351435%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="evs_04_2086__p45784926111340">Object</p>
</td>
<td class="cellrowborder" valign="top" width="16.96169616961696%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="evs_04_2086__p17591560111340">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="evs_04_2086__p15630283111340">The image export operation marker. For details, see <a href="#evs_04_2086__li49734540111454">Parameters in the os-volume_upload_image field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2086__li49734540111454"><a name="evs_04_2086__li49734540111454"></a><a name="li49734540111454"></a>Parameters in the <strong id="evs_04_2086__b1724433494415">os-volume_upload_image</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__table1029161111454" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__row17873550111454"><th align="left" class="cellrowborder" valign="top" width="23.232323232323232%" id="mcps1.3.4.2.2.2.1.5.1.1"><p id="evs_04_2086__p61357386111454">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.541454145414543%" id="mcps1.3.4.2.2.2.1.5.1.2"><p id="evs_04_2086__p3892401111454">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.77167716771677%" id="mcps1.3.4.2.2.2.1.5.1.3"><p id="evs_04_2086__p46849027111454">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.45454545454545%" id="mcps1.3.4.2.2.2.1.5.1.4"><p id="evs_04_2086__p36674858111454">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__row34643012111454"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.4.2.2.2.1.5.1.1 "><p id="evs_04_2086__p38471446111454">disk_format</p>
</td>
<td class="cellrowborder" valign="top" width="14.541454145414543%" headers="mcps1.3.4.2.2.2.1.5.1.2 "><p id="evs_04_2086__p29179435111454">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.77167716771677%" headers="mcps1.3.4.2.2.2.1.5.1.3 "><p id="evs_04_2086__p14724020111454">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.4.2.2.2.1.5.1.4 "><p id="evs_04_2086__p846816504210">The format of the image to be exported.</p>
<p id="evs_04_2086__p51794970111454">The value can be <strong id="evs_04_2086__b842352706173625">vhd</strong>, <strong id="evs_04_2086__b842352706173628">zvhd</strong>, <strong id="evs_04_2086__b13481118111020">zvhd2</strong>, <strong id="evs_04_2086__b842352706173630">raw</strong>, or <strong id="evs_04_2086__b842352706173635">qcow2</strong>. The default value is <strong id="evs_04_2086__b842352706165234">zvhd2</strong>.</p>
</td>
</tr>
<tr id="evs_04_2086__row65355785111454"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.4.2.2.2.1.5.1.1 "><p id="evs_04_2086__p43351654111454">image_name</p>
</td>
<td class="cellrowborder" valign="top" width="14.541454145414543%" headers="mcps1.3.4.2.2.2.1.5.1.2 "><p id="evs_04_2086__p21823090111454">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.77167716771677%" headers="mcps1.3.4.2.2.2.1.5.1.3 "><p id="evs_04_2086__p22839862111454">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.4.2.2.2.1.5.1.4 "><div class="p" id="evs_04_2086__p38089563111454">The name of the image to be exported.<ul id="evs_04_2086__ul728185834617"><li id="evs_04_2086__li18281205814610">It cannot start or end with space.</li><li id="evs_04_2086__li1128225812467">It can contain 1 to 128 characters.</li><li id="evs_04_2086__li02821958164616">It can contain the following characters: letters, digits, special characters including hyphens (-), periods (.), and underscores (_), and spaces.</li></ul>
</div>
</td>
</tr>
<tr id="evs_04_2086__row28028525111454"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.4.2.2.2.1.5.1.1 "><p id="evs_04_2086__p51331154111454">force</p>
</td>
<td class="cellrowborder" valign="top" width="14.541454145414543%" headers="mcps1.3.4.2.2.2.1.5.1.2 "><p id="evs_04_2086__p64182815111454">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="16.77167716771677%" headers="mcps1.3.4.2.2.2.1.5.1.3 "><p id="evs_04_2086__p31425545111454">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.4.2.2.2.1.5.1.4 "><p id="evs_04_2086__p62441207111454">Whether to forcibly export the image. The default value is <strong id="evs_04_2086__b842352706201136">false</strong>.</p>
<ul id="evs_04_2086__ul24573010111454"><li id="evs_04_2086__li25099955111454">If this parameter is set to <strong id="evs_04_2086__b1993418132411">false</strong>, images cannot be forcibly exported when the disk status is <strong id="evs_04_2086__b1964611662414">in-use</strong>.</li></ul>
<ul id="evs_04_2086__ul44256769111454"><li id="evs_04_2086__li19830499111454">If this parameter is set to <strong id="evs_04_2086__b15110434152413">true</strong>, images can be forcibly exported even when the disk status is <strong id="evs_04_2086__b1469314389246">in-use</strong>.</li></ul>
</td>
</tr>
<tr id="evs_04_2086__row43451869111454"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.4.2.2.2.1.5.1.1 "><p id="evs_04_2086__p50930133111454">container_format</p>
</td>
<td class="cellrowborder" valign="top" width="14.541454145414543%" headers="mcps1.3.4.2.2.2.1.5.1.2 "><p id="evs_04_2086__p31700070111454">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.77167716771677%" headers="mcps1.3.4.2.2.2.1.5.1.3 "><p id="evs_04_2086__p17568872111454">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.4.2.2.2.1.5.1.4 "><p id="evs_04_2086__p18456652114510">The container type of the image to be exported.</p>
<p id="evs_04_2086__p13792514111454">The value can be <strong id="evs_04_2086__b175891242151414">ami</strong>, <strong id="evs_04_2086__b826474991410">ari</strong>, <strong id="evs_04_2086__b9987253181416">aki</strong>, <strong id="evs_04_2086__b27561756131410">ovf</strong>, or <strong id="evs_04_2086__b1692065815142">bare</strong>. The default value is <strong id="evs_04_2086__b155421405154">bare</strong>.</p>
</td>
</tr>
<tr id="evs_04_2086__row148648415911"><td class="cellrowborder" valign="top" width="23.232323232323232%" headers="mcps1.3.4.2.2.2.1.5.1.1 "><p id="evs_04_2086__p846811317910">__os_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.541454145414543%" headers="mcps1.3.4.2.2.2.1.5.1.2 "><p id="evs_04_2086__p946810131899">String</p>
</td>
<td class="cellrowborder" valign="top" width="16.77167716771677%" headers="mcps1.3.4.2.2.2.1.5.1.3 "><p id="evs_04_2086__p12469713496">No</p>
</td>
<td class="cellrowborder" valign="top" width="45.45454545454545%" headers="mcps1.3.4.2.2.2.1.5.1.4 "><p id="evs_04_2086__p246912131294">The OS type of the image to be exported. Only <strong id="evs_04_2086__b842352706201052">windows</strong> and <strong id="evs_04_2086__b842352706201055">linux</strong> are supported currently. The default value is <strong id="evs_04_2086__b84235270620112">linux</strong>.</p>
<div class="note" id="evs_04_2086__note18753145612918"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="evs_04_2086__ul198423111019"><li id="evs_04_2086__li174692135911">There are two underscores (_) in front of <strong id="evs_04_2086__b842352706172646">os</strong> and one underscore (_) after <strong id="evs_04_2086__b842352706172711">os</strong>.</li><li id="evs_04_2086__li13469213391">This parameter setting takes effect only when the <strong id="evs_04_2086__b8423527061761">__os_type</strong> field is not included in <strong id="evs_04_2086__b84235270617623">volume_image_metadata</strong> and the disk status is <strong id="evs_04_2086__b84235270617633">available</strong>.</li><li id="evs_04_2086__li099183131016">If this parameter is not specified, default value <strong id="evs_04_2086__b842352706171511">linux</strong> is used.</li></ul>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2086__li6579149011178">Example request<pre class="screen" id="evs_04_2086__screen630117411189">{
"os-volume_upload_image": {
"image_name": "sxmatch2",
"force": true,
"container_format": "bare",
"disk_format": "vhd",
"__os_type": "linux"
}
}</pre>
</li></ul>
</div>
<div class="section" id="evs_04_2086__section5535081111830"><h4 class="sectiontitle">Response</h4><ul id="evs_04_2086__ul45688426111830"><li id="evs_04_2086__li15527813121252">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__table5532594121252" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__row60048709121252"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="evs_04_2086__p32107236121252">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="evs_04_2086__p50549312121252">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="evs_04_2086__p2030156121252">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__row1599615332144"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2086__p799653310145">os-volume_upload_image</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2086__p499603310144">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2086__p159971233141420">The image export operation marker. For details, see <a href="#evs_04_2086__li8542654111830">Parameters in the os-volume_upload_image field</a>.</p>
</td>
</tr>
<tr id="evs_04_2086__row30224973121252"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="evs_04_2086__p129522216412">error</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="evs_04_2086__p1595262111415">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="evs_04_2086__p109527215417">The error message returned if an error occurs. For details, see <a href="#evs_04_2086__li0419202382514">Parameters in the error field</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2086__li8542654111830"><a name="evs_04_2086__li8542654111830"></a><a name="li8542654111830"></a>Parameters in the <strong id="evs_04_2086__b661004422">os-volume_upload_image</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__table9775027111830" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__row50835692111830"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.5.2.2.2.1.4.1.1"><p id="evs_04_2086__p24050370111830">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.5.2.2.2.1.4.1.2"><p id="evs_04_2086__p1922990111830">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.5.2.2.2.1.4.1.3"><p id="evs_04_2086__p271585111830">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__row21998458111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p37044679111830">status</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p47829041111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p5292410111830">The disk status after the image is exported. The correct value is <strong id="evs_04_2086__b842352706201545">uploading</strong>.</p>
</td>
</tr>
<tr id="evs_04_2086__row47631691111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p32961780111830">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p52658493111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p15940816111830">The ID of the exported image.</p>
</td>
</tr>
<tr id="evs_04_2086__row9249618111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p11021632111830">image_name</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p20337010111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p18706116111830">The name of the exported image.</p>
</td>
</tr>
<tr id="evs_04_2086__row34137321111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p13659606111830">volume_type</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p32686283111830">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p41886703111830">The disk type information. For details, see <a href="#evs_04_2086__li28869709111957">Parameters in the volume_type field</a>.</p>
</td>
</tr>
<tr id="evs_04_2086__row41436015111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p874086111830">container_format</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p3692104111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p64707827111830">The container type of the exported image.</p>
<p id="evs_04_2086__p1432717114914">The value can be <strong id="evs_04_2086__b459311179">ami</strong>, <strong id="evs_04_2086__b2060151101710">ari</strong>, <strong id="evs_04_2086__b14611910174">aki</strong>, <strong id="evs_04_2086__b8622119172">ovf</strong>, or <strong id="evs_04_2086__b136318117173">bare</strong>. The default value is <strong id="evs_04_2086__b198418781710">bare</strong>.</p>
</td>
</tr>
<tr id="evs_04_2086__row45499535111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p61583720111830">size</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p22225458111830">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p60782776111830">The disk size, in GB.</p>
</td>
</tr>
<tr id="evs_04_2086__row10174073111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p18793567111830">disk_format</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p45883995111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p61636782111830">The format of the exported image.</p>
<p id="evs_04_2086__p110543734915">The value can be <strong id="evs_04_2086__b944918918171">vhd</strong>, <strong id="evs_04_2086__b164501093179">zvhd</strong>, <strong id="evs_04_2086__b164516931717">zvhd2</strong>, <strong id="evs_04_2086__b194511094178">raw</strong>, or <strong id="evs_04_2086__b345239191717">qcow2</strong>. The default value is <strong id="evs_04_2086__b16430101113170">vhd</strong>.</p>
</td>
</tr>
<tr id="evs_04_2086__row17860134111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p37384724111830">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p8263770111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p61744912111830">The disk ID.</p>
</td>
</tr>
<tr id="evs_04_2086__row18833303111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p49102550111830">display_description</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p17883602111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p28018462111830">The disk description.</p>
</td>
</tr>
<tr id="evs_04_2086__row50839573111830"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.1 "><p id="evs_04_2086__p24364735111830">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.5.2.2.2.1.4.1.2 "><p id="evs_04_2086__p27386538111830">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.2.2.1.4.1.3 "><p id="evs_04_2086__p32651105111830">The time when the disk was updated.</p>
<p id="evs_04_2086__p22151829479">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2086__li28869709111957"><a name="evs_04_2086__li28869709111957"></a><a name="li28869709111957"></a>Parameters in the <strong id="evs_04_2086__b249641714614">volume_type</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__table58500796111957" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__row41681908111957"><th align="left" class="cellrowborder" valign="top" width="22.35%" id="mcps1.3.5.2.3.2.1.4.1.1"><p id="evs_04_2086__p20791387111957">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.18%" id="mcps1.3.5.2.3.2.1.4.1.2"><p id="evs_04_2086__p6380778111957">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.47%" id="mcps1.3.5.2.3.2.1.4.1.3"><p id="evs_04_2086__p55467427111957">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__row63676572111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p57528669111957">id</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p29310607111957">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p39999332111957">The disk type ID.</p>
</td>
</tr>
<tr id="evs_04_2086__row24449673111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p34266520111957">name</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p24124731111957">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p39662687111957">The disk type name.</p>
</td>
</tr>
<tr id="evs_04_2086__row21419866111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p57287600111957">deleted</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p9784030111957">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p36953317111957">Whether the disk has been deleted.</p>
</td>
</tr>
<tr id="evs_04_2086__row64144399111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p28313846111957">is_public</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p11720218111957">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p56704311111957">The reserved field.</p>
</td>
</tr>
<tr id="evs_04_2086__row40576753111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p65491588111957">extra_spec</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p3218391111957">Object</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p43680990111957">The disk type specifications. For details, see <a href="#evs_04_2086__li105361616191716">Parameters in the extra_specs field</a>.</p>
</td>
</tr>
<tr id="evs_04_2086__row57584594111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p33840505111957">description</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p56726405111957">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p63298283111957">The disk type description.</p>
</td>
</tr>
<tr id="evs_04_2086__row32813641111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p40659264111957">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p5066079111957">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p19661880111957">The time when the disk type was created.</p>
<p id="evs_04_2086__p1176814616477">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2086__row42739193111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p39322569111957">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p31011493111957">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p59444132111957">The time when the disk type was updated.</p>
<p id="evs_04_2086__p12839783477">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
<tr id="evs_04_2086__row65235145111957"><td class="cellrowborder" valign="top" width="22.35%" headers="mcps1.3.5.2.3.2.1.4.1.1 "><p id="evs_04_2086__p49555405111957">deleted_at</p>
</td>
<td class="cellrowborder" valign="top" width="21.18%" headers="mcps1.3.5.2.3.2.1.4.1.2 "><p id="evs_04_2086__p54564832111957">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.47%" headers="mcps1.3.5.2.3.2.1.4.1.3 "><p id="evs_04_2086__p41188442111957">The time when the disk type was deleted.</p>
<p id="evs_04_2086__p1971441016471">Time format: UTC YYYY-MM-DDTHH:MM:SS.XXXXXX</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2086__li105361616191716"><a name="evs_04_2086__li105361616191716"></a><a name="li105361616191716"></a>Parameters in the <strong id="evs_04_2086__b639321211570">extra_specs</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__evs_04_2071_table1763545695210" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__evs_04_2071_row16361656165213"><th align="left" class="cellrowborder" valign="top" width="21.45%" id="mcps1.3.5.2.4.2.1.4.1.1"><p id="evs_04_2086__evs_04_2071_p1763619566527">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.41%" id="mcps1.3.5.2.4.2.1.4.1.2"><p id="evs_04_2086__evs_04_2071_p18636105619529">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.14%" id="mcps1.3.5.2.4.2.1.4.1.3"><p id="evs_04_2086__evs_04_2071_p186361556155214">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__evs_04_2071_row56365565526"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2086__evs_04_2071_p063625610529">volume_backend_name</p>
</td>
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2086__evs_04_2071_p3636165635219">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><p id="evs_04_2086__evs_04_2071_p17636185614527"><span id="evs_04_2086__evs_04_2071_text205233101097">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2086__evs_04_2071_row156362568523"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2086__evs_04_2071_p863675695214">availability-zone</p>
</td>
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2086__evs_04_2071_p8636175665214">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><p id="evs_04_2086__evs_04_2071_p18636356185213"><span id="evs_04_2086__text158869383573">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2086__evs_04_2071_row17844276596"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2086__evs_04_2071_p178418274593">HW:availability_zone</p>
</td>
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2086__evs_04_2071_p168416276599">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><p id="evs_04_2086__evs_04_2071_p1540410211408"><span id="evs_04_2086__text18615134212576">The reserved field.</span></p>
</td>
</tr>
<tr id="evs_04_2086__evs_04_2071_row3637135611527"><td class="cellrowborder" valign="top" width="21.45%" headers="mcps1.3.5.2.4.2.1.4.1.1 "><p id="evs_04_2086__evs_04_2071_p163710561529">RESKEY:availability_zones</p>
</td>
<td class="cellrowborder" valign="top" width="21.41%" headers="mcps1.3.5.2.4.2.1.4.1.2 "><p id="evs_04_2086__evs_04_2071_p166374562525">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.14%" headers="mcps1.3.5.2.4.2.1.4.1.3 "><p id="evs_04_2086__evs_04_2071_p3637756205214">The AZs that support the current disk type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="evs_04_2086__li0419202382514"><a name="evs_04_2086__li0419202382514"></a><a name="li0419202382514"></a>Parameters in the <strong id="evs_04_2086__b4691021115810">error</strong> field
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="evs_04_2086__evs_04_2013_table15441099103019" frame="border" border="1" rules="all"><thead align="left"><tr id="evs_04_2086__evs_04_2013_row54094047103019"><th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.5.2.1.4.1.1"><p id="evs_04_2086__evs_04_2013_p19541716103019">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.17788221177882%" id="mcps1.3.5.2.5.2.1.4.1.2"><p id="evs_04_2086__evs_04_2013_p39375186103019">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.64423557644236%" id="mcps1.3.5.2.5.2.1.4.1.3"><p id="evs_04_2086__evs_04_2013_p38578950103019">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="evs_04_2086__evs_04_2013_row59401790103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.1 "><p id="evs_04_2086__evs_04_2013_p46815658103019">message</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.2 "><p id="evs_04_2086__evs_04_2013_p33971979103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.5.2.1.4.1.3 "><p id="evs_04_2086__evs_04_2013_p21623243103019">The error message returned if an error occurs.</p>
</td>
</tr>
<tr id="evs_04_2086__evs_04_2013_row60391466103019"><td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.1 "><p id="evs_04_2086__evs_04_2013_p59870541103019">code</p>
</td>
<td class="cellrowborder" valign="top" width="21.17788221177882%" headers="mcps1.3.5.2.5.2.1.4.1.2 "><p id="evs_04_2086__evs_04_2013_p17675690103019">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.64423557644236%" headers="mcps1.3.5.2.5.2.1.4.1.3 "><p id="evs_04_2086__evs_04_2013_p6087468103019">The error code returned if an error occurs.</p>
<p id="evs_04_2086__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_2086__li3683315211219">Example response<pre class="screen" id="evs_04_2086__screen33637409112142">{
"os-volume_upload_image": {
"status": "uploading",
"size": 40,
"id": "16369c5d-384d-4e64-b37a-56d898769362",
"image_id": "c5333daa-fbc8-4d1d-bf79-b0567bb45d15",
"image_name": "evs-ims-test1027",
"volume_type": {
"description": "None",
"deleted": false,
"created_at": "2015-05-24T14:47:22.132268",
"updated_at": "2017-07-29T11:29:33.730076",
"extra_specs": {
"volume_backend_name": "&lt;or&gt; iaas blockstorage_SAS &lt;or&gt; iaas blockstorage_SAS &lt;or&gt; iaas blockstoragesas",
"XX:availability_zone": "az-dc-1"
},
"is_public": true,
"deleted_at": null,
"id": "8247b6ed-37f0-4c48-8ef1-f0027fb332bc",
"name": "SAS"
},
"container_format": "bare",
"disk_format": "vhd",
"display_description": "",
"updated_at": "2018-01-11T01:50:25.800931"
}
}</pre>
<div class="p" id="evs_04_2086__p6076356411223">or<pre class="screen" id="evs_04_2086__screen51113023112235">{
"error": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</div>
<div class="p" id="evs_04_2086__p12122797112243">In the preceding example, <strong id="evs_04_2086__b842352706143959">error</strong> indicates a general error, for example, <strong id="evs_04_2086__b842352706144438">badRequest</strong> or <strong id="evs_04_2086__b842352706144454">itemNotFound</strong>. An example is provided as follows:<pre class="screen" id="evs_04_2086__screen8896194112310">{
"itemNotFound": {
"message": "XXXX",
"code": "XXX"
}
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="evs_04_2086__section28290342112319"><h4 class="sectiontitle">Status Codes</h4><ul id="evs_04_2086__ul63237267113043"><li id="evs_04_2086__li15987916113043">Normal<p id="evs_04_2086__p58453267112437"><a name="evs_04_2086__li15987916113043"></a><a name="li15987916113043"></a>202</p>
</li></ul>
</div>
<div class="section" id="evs_04_2086__section431317151242"><h4 class="sectiontitle">Error Codes</h4><p id="evs_04_2086__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