doc-exports/docs/ims/api-ref/en-us_topic_0020092109.html
Zaoxu, Li c236478734 IMS API DOC
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: Zaoxu, Li <lizaoxu@huawei.com>
Co-committed-by: Zaoxu, Li <lizaoxu@huawei.com>
2024-06-05 07:22:50 +00:00

820 lines
87 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="EN-US_TOPIC_0020092109"></a><a name="EN-US_TOPIC_0020092109"></a>
<h1 class="topictitle1">Creating an Image</h1>
<div id="body29566423"><div class="section" id="EN-US_TOPIC_0020092109__section29995926"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0020092109__p14480653117">This API is used to create a private image. The following methods are supported:</p>
<ul id="EN-US_TOPIC_0020092109__ul96849380116"><li id="EN-US_TOPIC_0020092109__li368413891119">Create a system or data disk image from an <span id="EN-US_TOPIC_0020092109__text3433175716365"></span><span id="EN-US_TOPIC_0020092109__text3971598365">ECS</span>.</li><li id="EN-US_TOPIC_0020092109__li2684173820113">Create a system disk image from an external image file uploaded to an OBS bucket.</li><li id="EN-US_TOPIC_0020092109__li668463810111">Create a system disk image from a data disk.</li></ul>
<p id="EN-US_TOPIC_0020092109__p46070087">The API is an asynchronous one. If it is successfully called, the cloud service system receives the request. However, you need to use the asynchronous job query API to query the image creation status. For details, see <a href="en-us_topic_0022473688.html">Querying the Status of an Asynchronous Job</a>.</p>
<p id="EN-US_TOPIC_0020092109__p19605512476">You cannot export public images (such as Windows, SUSE, Red Hat, Oracle Linux, and Ubuntu) or private images created using these public images.</p>
</div>
<div class="section" id="EN-US_TOPIC_0020092109__section111371758488"><h4 class="sectiontitle">Constraints (Creating a System Disk Image Using a Data Disk)</h4><ul id="EN-US_TOPIC_0020092109__ul1588017444912"><li id="EN-US_TOPIC_0020092109__li108819412499">Before using a data disk to create a system disk image, ensure that an OS has been installed on the data disk and has been optimized. For details about the optimization, see "Optimizing a Windows Private Image" and "Optimizing a Linux Private Image" in the <em id="EN-US_TOPIC_0020092109__i842352697115226">Image Management Service User Guide</em>.</li><li id="EN-US_TOPIC_0020092109__li189251922101020">The system cannot verify that an OS has been installed on the data disk. Therefore, ensure that the value of <strong id="EN-US_TOPIC_0020092109__b940664051">os_version</strong> is valid when creating a system disk image from the data disk. For details, see <a href="en-us_topic_0031617666.html">Values of Related Parameters</a>.</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020092109__section1527883"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0020092109__p588929">POST /v2/cloudimages/action</p>
</div>
<div class="section" id="EN-US_TOPIC_0020092109__section13750947"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0020092109__ul38847270"><li id="EN-US_TOPIC_0020092109__li1731919311128">Parameters for creating a system or data disk image from an <span id="EN-US_TOPIC_0020092109__text0719923184911"></span><span id="EN-US_TOPIC_0020092109__text11719223174914">ECS</span>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table62551043151553" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020092109__row63356413151553"><th align="left" class="cellrowborder" valign="top" width="21.242124212421242%" id="mcps1.3.4.2.1.3.1.5.1.1"><p id="EN-US_TOPIC_0020092109__p41292683151745">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.172217221722175%" id="mcps1.3.4.2.1.3.1.5.1.2"><p id="EN-US_TOPIC_0020092109__p51323166151745">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.85148514851485%" id="mcps1.3.4.2.1.3.1.5.1.3"><p id="EN-US_TOPIC_0020092109__p36943663151745">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.73417341734174%" id="mcps1.3.4.2.1.3.1.5.1.4"><p id="EN-US_TOPIC_0020092109__p16401653151745">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row58293752151553"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p24173439151553">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p18429535194412">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p23692580151553">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p40050833151553">Specifies the name of the system disk image. For detailed description, see <a href="en-us_topic_0020091562.html#EN-US_TOPIC_0020091562__section61598810155254">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row57744127151553"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p46762671151553">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p29679979151553">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p55268124151553">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p47533098151553">Provides supplementary information about the image. For details, see <a href="en-us_topic_0020091562.html#EN-US_TOPIC_0020091562__section61598810155254">Image Attributes</a>. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (&lt; &gt;) are not allowed. This parameter is left blank by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row25144703151553"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p23455075151553">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p203181545144419">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p8122243151553">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p53921936151553">Specifies the ID of the <span id="EN-US_TOPIC_0020092109__text13824145813499"></span><span id="EN-US_TOPIC_0020092109__text78241658114918">ECS</span> used to create the image.</p>
<p id="EN-US_TOPIC_0020092109__p188578234320">To obtain the <span id="EN-US_TOPIC_0020092109__text19693162115016"></span><span id="EN-US_TOPIC_0020092109__text669317255014">ECS</span> ID, perform the following operations:</p>
<ol id="EN-US_TOPIC_0020092109__ol388062213448"><li id="EN-US_TOPIC_0020092109__li5880172212448">Log in to management console.</li><li id="EN-US_TOPIC_0020092109__li17881112214446">Under <strong id="EN-US_TOPIC_0020092109__b125126462014">Computing</strong>, click <strong id="EN-US_TOPIC_0020092109__b1298610211209">Elastic Cloud Server</strong>.</li><li id="EN-US_TOPIC_0020092109__li9881162219442">In the ECS list, click the name of the <span id="EN-US_TOPIC_0020092109__text19221104075012"></span><span id="EN-US_TOPIC_0020092109__text4221184010501">ECS</span> and view its ID.</li></ol>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row24935094113949"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p2769180113957">data_images</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p22843825113957">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p12614986113957">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p877019466455">Specifies the data disk information to be converted. This parameter is mandatory when the data disk of an <span id="EN-US_TOPIC_0020092109__text188721725125318"></span><span id="EN-US_TOPIC_0020092109__text0872625115317">ECS</span> is used to create a private data disk image. For details, see <a href="#EN-US_TOPIC_0020092109__table19600131217507">Table 1</a>.</p>
<p id="EN-US_TOPIC_0020092109__p88041225142519">If the ECS data disk is not used to create a data disk image, the parameter is empty by default.</p>
<div class="note" id="EN-US_TOPIC_0020092109__note131418296548"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020092109__p43151290549">When you create a data disk image using a data disk, if other parameters (such as <strong id="EN-US_TOPIC_0020092109__b141191829546">name</strong>, <strong id="EN-US_TOPIC_0020092109__b172221432445">description</strong>, and <strong id="EN-US_TOPIC_0020092109__b271084317411">tags</strong>) in this table have values, the system uses the value of <strong id="EN-US_TOPIC_0020092109__b196401971651">data_images</strong>. You cannot specify <strong id="EN-US_TOPIC_0020092109__b438516291553">instance_id</strong>.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row30504483181035"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p56306980181056">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p64571566181056">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p62914385181056">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p62900404181056">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p20992085173243">Use either <strong id="EN-US_TOPIC_0020092109__b84235270693042">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b84235270693044">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row36234066184027"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p30481145184039">image_tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p53053656184039">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p2378868184039">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p5510142012586">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p58470580184039">Use either <strong id="EN-US_TOPIC_0020092109__b360294093">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b1559769757">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row15885142772916"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p172919315292">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p172915311293">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p182911231172912">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p10305182217584">Specifies the enterprise project that the image belongs to.</p>
<ul id="EN-US_TOPIC_0020092109__ul76914342313"><li id="EN-US_TOPIC_0020092109__li06911382318">If the value is <strong id="EN-US_TOPIC_0020092109__b842352706111949">0</strong> or left blank, the image belongs to the default enterprise project.</li><li id="EN-US_TOPIC_0020092109__li186911342317">If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.<p id="EN-US_TOPIC_0020092109__p0738134925819"><a name="EN-US_TOPIC_0020092109__li186911342317"></a><a name="li186911342317"></a>For more information about enterprise projects and how to obtain enterprise project IDs, see <em id="EN-US_TOPIC_0020092109__i4746124014158">Enterprise Management User Guide</em>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row542396829715"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p313381039715">max_ram</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p553584299715">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p548477719715">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p134845069715">Specifies the maximum memory of the image in the unit of MB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row345004879812"><td class="cellrowborder" valign="top" width="21.242124212421242%" headers="mcps1.3.4.2.1.3.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p430760399812">min_ram</p>
</td>
<td class="cellrowborder" valign="top" width="22.172217221722175%" headers="mcps1.3.4.2.1.3.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p666071449812">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.85148514851485%" headers="mcps1.3.4.2.1.3.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p264695859812">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="41.73417341734174%" headers="mcps1.3.4.2.1.3.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p636616759812">Specifies the minimum memory of the image in the unit of MB. The default value is <strong id="EN-US_TOPIC_0020092109__b84235270617155">0</strong>, indicating that the memory is not restricted.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020092109__table19600131217507"></a><a name="table19600131217507"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table19600131217507" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure description of the data_images field</caption><thead align="left"><tr id="EN-US_TOPIC_0020092109__row660120127503"><th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.4.2.1.4.2.5.1.1"><p id="EN-US_TOPIC_0020092109__p1268419544509">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.55%" id="mcps1.3.4.2.1.4.2.5.1.2"><p id="EN-US_TOPIC_0020092109__p1268475455020">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.23%" id="mcps1.3.4.2.1.4.2.5.1.3"><p id="EN-US_TOPIC_0020092109__p11684354145015">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="48.480000000000004%" id="mcps1.3.4.2.1.4.2.5.1.4"><p id="EN-US_TOPIC_0020092109__p1268725475017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row1060141285015"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p960112128502">name</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p660115122507">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p060181211501">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.480000000000004%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p196011512175018">Specifies the name of a data disk image.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row16601512145018"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p14601112195015">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p460114121505">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1060191295017">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.480000000000004%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p9601141215507">Specifies the data disk ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row1991233195111"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1699313318516">description</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p13372545165110">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p19993203319512">String</p>
</td>
<td class="cellrowborder" valign="top" width="48.480000000000004%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1993113395112">Specifies the data disk description.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row11650164016513"><td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.4.2.1.4.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1065112403516">tags</p>
</td>
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.2.1.4.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p19397194545118">No</p>
</td>
<td class="cellrowborder" valign="top" width="16.23%" headers="mcps1.3.4.2.1.4.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p7651134011512">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="48.480000000000004%" headers="mcps1.3.4.2.1.4.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p2651174010519">Specifies the data disk image tag.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020092109__li3688227151754">Parameters for creating an image using an image file uploaded to the OBS bucket
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table2165501011128" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020092109__row2548881211128"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="EN-US_TOPIC_0020092109__p5132791211128">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="22.18%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="EN-US_TOPIC_0020092109__p6392024111128">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.84%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="EN-US_TOPIC_0020092109__p1015703811128">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="41.55%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="EN-US_TOPIC_0020092109__p1741376811128">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row122909411128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p3244779311128">name</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p1102555211128">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p2065450811128">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p25100359152023">Specifies the image name. For detailed description, see <a href="en-us_topic_0020091562.html#EN-US_TOPIC_0020091562__section61598810155254">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row2475079711128"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p5865753511128">description</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p5363988111128">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p4986312411128">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1238125611128">Provides supplementary information about the image. For detailed description, see <a href="en-us_topic_0020091562.html#EN-US_TOPIC_0020091562__section61598810155254">Image Attributes</a>. The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (&lt; &gt;) are not allowed. This parameter is left blank by default.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row39976861514"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p8997687153">os_type</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p129979821519">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p39971984157">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1099798111518">Specifies the OS type.</p>
<p id="EN-US_TOPIC_0020092109__p11611164381516">The value can be <strong id="EN-US_TOPIC_0020092109__b37171745192714">Linux</strong>, <strong id="EN-US_TOPIC_0020092109__b17732194514279">Windows</strong>, or <strong id="EN-US_TOPIC_0020092109__b157331445152713">Other</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row21556993144512"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1647705215747">os_version</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p5957279815747">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p6066734915747">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p16255898151029">Specifies the OS version.</p>
<p id="EN-US_TOPIC_0020092109__p1510826515747">This parameter is valid if an external image file uploaded to the OBS bucket is used to create an image. For its value, see <a href="en-us_topic_0031617666.html">Values of Related Parameters</a>.</p>
<div class="note" id="EN-US_TOPIC_0020092109__note3761115934712"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020092109__p187626595478">If the uploaded file is in ISO format, this parameter is mandatory.</p>
<p id="EN-US_TOPIC_0020092109__p1373820819201">This parameter is mandatory when the value of <span class="parmname" id="EN-US_TOPIC_0020092109__parmname4504181862020"><b>is_quick_import</b></span> is <span class="parmvalue" id="EN-US_TOPIC_0020092109__parmvalue3505161820202"><b>true</b></span>, that is, a system disk image is imported using the quick import method.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row35447872144512"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p2534737915133">image_url</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p3987185215133">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p839458515133">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p18464621151313">Specifies the URL of the external image file in the OBS bucket.</p>
<p id="EN-US_TOPIC_0020092109__p58228438102659">This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The format is <em id="EN-US_TOPIC_0020092109__i84235269710445">OBS bucket name</em>:<em id="EN-US_TOPIC_0020092109__i84235269710449">Image file name</em>.</p>
<ul id="EN-US_TOPIC_0020092109__ul412396910"><li id="EN-US_TOPIC_0020092109__li5702165313122">To obtain an OBS bucket name:<ol id="EN-US_TOPIC_0020092109__ol25431558171218"><li id="EN-US_TOPIC_0020092109__li1810818171310">Log in to the management console and choose <strong id="EN-US_TOPIC_0020092109__b3218204215359">Storage</strong> &gt; <strong id="EN-US_TOPIC_0020092109__b2325144623516">Object Storage Service</strong>.<p id="EN-US_TOPIC_0020092109__p169219328125">All OBS buckets are displayed in the list.</p>
</li><li id="EN-US_TOPIC_0020092109__li654365819122">Filter the OBS buckets by region and locate the target bucket in the current region.</li></ol>
</li><li id="EN-US_TOPIC_0020092109__li151389397">To obtain an OBS image file name:<ol id="EN-US_TOPIC_0020092109__ol15383031310"><li id="EN-US_TOPIC_0020092109__li153113016130">Log in to the management console and choose <strong id="EN-US_TOPIC_0020092109__b18928182754010">Storage</strong> &gt; <strong id="EN-US_TOPIC_0020092109__b15931112794014">Object Storage Service</strong>.<p id="EN-US_TOPIC_0020092109__p3296145111212">All OBS buckets are displayed in the list.</p>
</li><li id="EN-US_TOPIC_0020092109__li20781415131718">Filter the OBS buckets by region and locate the target bucket in the current region.</li><li id="EN-US_TOPIC_0020092109__li3274143481320">Click the name of the target bucket to go to the bucket details page.</li><li id="EN-US_TOPIC_0020092109__li1092611278156">In the navigation pane on the left, choose <strong id="EN-US_TOPIC_0020092109__b4995110154315">Objects</strong> to display objects in the OBS bucket and then locate the external image file used to create an image.</li></ol>
</li></ul>
<div class="note" id="EN-US_TOPIC_0020092109__note1225492811382"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020092109__p19254112843816">The storage class of the OBS bucket must be <strong id="EN-US_TOPIC_0020092109__b84235270695721">Standard</strong>.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row52667843144512"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p9282872151517">min_disk</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p13715176151517">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p37187452151517">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p39357309151539">Specifies the minimum size of the system disk in the unit of GB.</p>
<p id="EN-US_TOPIC_0020092109__p22166530152043">This parameter is mandatory if an external image file in the OBS bucket is used to create an image. The value ranges from 1 GB to 1,024 GB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row65041573144517"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p37508960152058">is_config</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p18326949152058">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p8087923152058">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p39377742152947">Specifies whether automatic configuration is enabled.</p>
<p id="EN-US_TOPIC_0020092109__p36345323152949">The value can be <strong id="EN-US_TOPIC_0020092109__b2021115381211">true</strong> or <strong id="EN-US_TOPIC_0020092109__b1421293822118">false</strong>.</p>
<p id="EN-US_TOPIC_0020092109__p886649318525">If automatic configuration is required, set the value to <strong id="EN-US_TOPIC_0020092109__b842352706165031">true</strong>. Otherwise, set the value to <strong id="EN-US_TOPIC_0020092109__b842352706165047">false</strong> The default value is <strong id="EN-US_TOPIC_0020092109__b842352706145544">false</strong>.</p>
<p id="EN-US_TOPIC_0020092109__p51142001152058">For details about automatic configuration, see <strong id="EN-US_TOPIC_0020092109__b842352706165430">Creating a Linux System Disk Image from an External Image File</strong> &gt; <strong id="EN-US_TOPIC_0020092109__b842352706165449">Registering an External Image File as a Private Image (Linux)</strong> in <em id="EN-US_TOPIC_0020092109__i73616130509">Image Management Service User Guide</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row396276471500"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p211045061500">cmk_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p950318415538">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p210781641500">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p296097181500">Specifies a custom key used for encrypting an image. For its value, see the <em id="EN-US_TOPIC_0020092109__i1520141385015">Key Management Service User Guide</em>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row65425243181152"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p27909231181157">tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p46055199181157">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p39483611181157">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p04478170592">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p14856631113148">Use either <strong id="EN-US_TOPIC_0020092109__b762116418247">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b762214132417">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row59883440184127"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1916128184130">image_tags</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p20988681184130">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p22361635184130">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p66462038184130">Lists the image tags. This parameter is left blank by default. Use either <strong id="EN-US_TOPIC_0020092109__b1129391205">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b2025234019">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row44624222161131"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p57792233161131">type</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p50659272161131">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p9760356161131">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p5522511816122">Specifies the image type.</p>
<p id="EN-US_TOPIC_0020092109__p52391332161131">The value can be <strong id="EN-US_TOPIC_0020092109__b173421322135016">ECS</strong>, <strong id="EN-US_TOPIC_0020092109__b23431222115013">BMS</strong>, <strong id="EN-US_TOPIC_0020092109__b434317221507">FusionCompute</strong>, <strong id="EN-US_TOPIC_0020092109__b1343152216502">IsoImage</strong>, or <strong id="EN-US_TOPIC_0020092109__b8343822125018">Ironic</strong>. The default value is <strong id="EN-US_TOPIC_0020092109__b3972135917553">ECS</strong>.</p>
<ul id="EN-US_TOPIC_0020092109__ul861233019438"><li id="EN-US_TOPIC_0020092109__li11612133034317"><strong id="EN-US_TOPIC_0020092109__b1684814112568">ECS</strong> and <strong id="EN-US_TOPIC_0020092109__b28496155615">FusionCompute</strong>: indicate an ECS image.</li><li id="EN-US_TOPIC_0020092109__li16612330134318"><strong id="EN-US_TOPIC_0020092109__b94781739564">BMS</strong> and <strong id="EN-US_TOPIC_0020092109__b64793317564">Ironic</strong>: indicate a BMS image.</li><li id="EN-US_TOPIC_0020092109__li166127302437"><strong id="EN-US_TOPIC_0020092109__b192859585617">IsoImage</strong>: indicates an image created using an ISO file.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row88221746172920"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p17978147142913">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p209783478295">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p29784476296">String</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1246345212398">Specifies the enterprise project that the image belongs to.</p>
<ul id="EN-US_TOPIC_0020092109__ul9463252133912"><li id="EN-US_TOPIC_0020092109__li447935219394">If the value is <strong id="EN-US_TOPIC_0020092109__b1176647872">0</strong> or left blank, the image belongs to the default enterprise project.</li><li id="EN-US_TOPIC_0020092109__li64790525398">If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.<p id="EN-US_TOPIC_0020092109__p13705743174014"><a name="EN-US_TOPIC_0020092109__li64790525398"></a><a name="li64790525398"></a>For more information about enterprise projects and how to obtain enterprise project IDs, see <em id="EN-US_TOPIC_0020092109__i445082520593">Enterprise Management User Guide</em>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row22066143995"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p42527152995">max_ram</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p22147253995">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p49097046995">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p17437821995">Specifies the maximum memory of the image in the unit of MB.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row4319589949"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p349886759949">min_ram</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p155104169949">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p483841659949">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p268033079949">Specifies the minimum memory required by the image in the unit of MB. The default value is <strong id="EN-US_TOPIC_0020092109__b833478215">0</strong>, indicating that the memory is not restricted.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row1564134318217"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p117131450152317">data_images</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p187136501238">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1071314503234">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p725981419507">Specifies the data disk information to be imported.</p>
<p id="EN-US_TOPIC_0020092109__p14450142143014">An external image file can contain a maximum of three data disks. In this case, one system disk and three data disks will be created.</p>
<p id="EN-US_TOPIC_0020092109__p8713165015233">For details, see <a href="#EN-US_TOPIC_0020092109__table1719811465261">Table 2</a>.</p>
<div class="note" id="EN-US_TOPIC_0020092109__note3599175012314"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="EN-US_TOPIC_0020092109__ul1351151212575"><li id="EN-US_TOPIC_0020092109__li75171214576">If a data disk image file is used to create a data disk image, the OS type of the data disk image must be the same as that of the system disk image.</li><li id="EN-US_TOPIC_0020092109__li951151214579">If other parameters (such as <strong id="EN-US_TOPIC_0020092109__b01738814276">name</strong>, <strong id="EN-US_TOPIC_0020092109__b1017416812275">description</strong>, and <strong id="EN-US_TOPIC_0020092109__b16174689272">tags</strong>) in <a href="#EN-US_TOPIC_0020092109__table1719811465261">Table 2</a> are set, the system uses the values in <strong id="EN-US_TOPIC_0020092109__b1617615810275">data_images</strong>.</li></ul>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row18543639102215"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1119811409248">is_quick_import</p>
</td>
<td class="cellrowborder" valign="top" width="22.18%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p41981340152411">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.84%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p919864016243">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="41.55%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p7320350122412">Specifies whether to use the quick import method to import a system disk image.</p>
<ul id="EN-US_TOPIC_0020092109__ul20717163416443"><li id="EN-US_TOPIC_0020092109__li771733414447">If yes, set the value to <strong id="EN-US_TOPIC_0020092109__b84235270615360">true</strong>.</li><li id="EN-US_TOPIC_0020092109__li471783410441">If no, set the value to <strong id="EN-US_TOPIC_0020092109__b84235270683846">false</strong>.</li></ul>
<p id="EN-US_TOPIC_0020092109__p419824018246">For details about the restrictions on quick import of image files, see <a href="en-us_topic_0133188204.html">Importing an Image File Quickly</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0020092109__table1719811465261"></a><a name="table1719811465261"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table1719811465261" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure description of the images field</caption><thead align="left"><tr id="EN-US_TOPIC_0020092109__row11198246132618"><th align="left" class="cellrowborder" valign="top" width="23.599999999999998%" id="mcps1.3.4.2.2.2.2.5.1.1"><p id="EN-US_TOPIC_0020092109__p14641142292917">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.25%" id="mcps1.3.4.2.2.2.2.5.1.2"><p id="EN-US_TOPIC_0020092109__p76411224292">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.82%" id="mcps1.3.4.2.2.2.2.5.1.3"><p id="EN-US_TOPIC_0020092109__p06419220292">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.33%" id="mcps1.3.4.2.2.2.2.5.1.4"><p id="EN-US_TOPIC_0020092109__p1964122218298">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row1419964620268"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p17642122112913">name</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p5642222132917">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p196421522132915">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p19303615310">Specifies the image name.</p>
<p id="EN-US_TOPIC_0020092109__p10642182212290">For more details, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row171998466265"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p7642122272910">description</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p36428220299">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p146421022172914">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p18269194053119">Provides supplementary information about the image. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p16284152203213">The value contains a maximum of 1024 characters and consists of only letters and digits. Carriage returns and angle brackets (&lt; &gt;) are not allowed.</p>
<p id="EN-US_TOPIC_0020092109__p3109454163110">For more details, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row1119913465264"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p9642152215297">image_url</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p66421622122918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p156421722102912">String</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p20642152217290">Specifies the URL of the external image file in the OBS bucket.</p>
<p id="EN-US_TOPIC_0020092109__p964242210295">The format is <em id="EN-US_TOPIC_0020092109__i84235269710218">OBS bucket name</em>:<em id="EN-US_TOPIC_0020092109__i84235269710226">Image file name</em>.</p>
<ul id="EN-US_TOPIC_0020092109__ul270414534200"><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li5702165313122">To obtain an OBS bucket name:<ol id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_ol25431558171218"><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li1810818171310">Log in to the management console and choose <strong id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_b3218204215359">Storage</strong> &gt; <strong id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_b2325144623516">Object Storage Service</strong>.<p id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_p169219328125">All OBS buckets are displayed in the list.</p>
</li><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li654365819122">Filter the OBS buckets by region and locate the target bucket in the current region.</li></ol>
</li><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li151389397">To obtain an OBS image file name:<ol id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_ol15383031310"><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li153113016130">Log in to the management console and choose <strong id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_b18928182754010">Storage</strong> &gt; <strong id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_b15931112794014">Object Storage Service</strong>.<p id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_p3296145111212">All OBS buckets are displayed in the list.</p>
</li><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li20781415131718">Filter the OBS buckets by region and locate the target bucket in the current region.</li><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li3274143481320">Click the name of the target bucket to go to the bucket details page.</li><li id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_li1092611278156">In the navigation pane on the left, choose <strong id="EN-US_TOPIC_0020092109__en-us_topic_0020092109_b4995110154315">Objects</strong> to display objects in the OBS bucket and then locate the external image file used to create an image.</li></ol>
</li></ul>
<div class="note" id="EN-US_TOPIC_0020092109__note9339184563215"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0020092109__p43398459325">The storage class of the OBS bucket must be <strong id="EN-US_TOPIC_0020092109__b84235270695634">Standard</strong>.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row10199184610262"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p146421422162915">min_disk</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p2642922162918">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1664262220295">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p586675218447">Specifies the minimum size of the data disk.</p>
<p id="EN-US_TOPIC_0020092109__p206421422112912">Unit: GB</p>
<p id="EN-US_TOPIC_0020092109__p208805207359">Value range: 12048</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row61996463260"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p206428225299">is_quick_import</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p3642622102912">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p20642152282916">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p16732122383414">Specifies whether an image file is imported quickly to create a data disk image.</p>
<ul id="EN-US_TOPIC_0020092109__ul1645516813510"><li id="EN-US_TOPIC_0020092109__li14455187517">If yes, set the value to <strong id="EN-US_TOPIC_0020092109__b4160165374516">true</strong>.</li><li id="EN-US_TOPIC_0020092109__li34553805111">If no, set the value to <strong id="EN-US_TOPIC_0020092109__b6674155419451">false</strong>.</li></ul>
<p id="EN-US_TOPIC_0020092109__p864222202914">For details about the restrictions on quick import of image files, see <a href="en-us_topic_0133188204.html">Importing an Image File Quickly</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row119912467266"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p26425222292">tags</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p14642172292916">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p764292292916">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p136431422142919">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p464362232913">For detailed parameter descriptions, see <a href="en-us_topic_0020092110.html">Image Tag Data Formats</a>.</p>
<p id="EN-US_TOPIC_0020092109__p1643132242910">Use either <strong id="EN-US_TOPIC_0020092109__b1804686152">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b1844521209">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row3199194611262"><td class="cellrowborder" valign="top" width="23.599999999999998%" headers="mcps1.3.4.2.2.2.2.5.1.1 "><p id="EN-US_TOPIC_0020092109__p156431022152917">image_tags</p>
</td>
<td class="cellrowborder" valign="top" width="13.25%" headers="mcps1.3.4.2.2.2.2.5.1.2 "><p id="EN-US_TOPIC_0020092109__p364312210298">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.82%" headers="mcps1.3.4.2.2.2.2.5.1.3 "><p id="EN-US_TOPIC_0020092109__p4643192213291">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="47.33%" headers="mcps1.3.4.2.2.2.2.5.1.4 "><p id="EN-US_TOPIC_0020092109__p16643022112915">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p166431922112920">For detailed parameter descriptions, see <a href="en-us_topic_0020092110.html">Image Tag Data Formats</a>.</p>
<p id="EN-US_TOPIC_0020092109__p864392282911">Use either <strong id="EN-US_TOPIC_0020092109__b67901171472">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b4791617194714">image_tags</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020092109__li9344185321610">Parameters for creating a system disk image using a data disk
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table57282886154747" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020092109__row33194661154747"><th align="left" class="cellrowborder" valign="top" width="17.938206179382064%" id="mcps1.3.4.2.3.1.1.5.1.1"><p id="EN-US_TOPIC_0020092109__p27251539657">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.388361163883612%" id="mcps1.3.4.2.3.1.1.5.1.2"><p id="EN-US_TOPIC_0020092109__p137321639956">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.858414158584141%" id="mcps1.3.4.2.3.1.1.5.1.3"><p id="EN-US_TOPIC_0020092109__p10736113913514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.81501849815018%" id="mcps1.3.4.2.3.1.1.5.1.4"><p id="EN-US_TOPIC_0020092109__p57403391355">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row24393852154747"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1991902322419">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p11919152311247">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1792012232242">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p12848125310282">Specifies the name of the system disk image.</p>
<p id="EN-US_TOPIC_0020092109__p209201023182416">For more details, see <a href="en-us_topic_0020091562.html#EN-US_TOPIC_0020091562__section61598810155254">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row835962711950"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p15920172392410">volume_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p7920192318248">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p392082315241">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p692062332412">Specifies the data disk ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row118831657162315"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p10920172318241">os_version</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p2920623162418">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p16920192311248">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p19201237241">Specifies the OS version.</p>
<p id="EN-US_TOPIC_0020092109__p481024411427">Set the parameter value based on <a href="en-us_topic_0031617666.html">Values of Related Parameters</a>. Otherwise, the created system disk image may be unavailable.</p>
<p id="EN-US_TOPIC_0020092109__p1920323132413">During the creation of a system disk image, if the OS can be detected from the data disk, the OS version in the data disk is used. In this case, the <strong id="EN-US_TOPIC_0020092109__b842352706124017">os_version</strong> value is invalid. If the OS can be detected from the data disk, the <strong id="EN-US_TOPIC_0020092109__b842352706124118">os_version</strong> value is used.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row1988316572239"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p69201823172414">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p1092042319245">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1692092392412">Sting</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1392072316240">Specifies the image type.</p>
<p id="EN-US_TOPIC_0020092109__p13920923102418">The value can be <strong id="EN-US_TOPIC_0020092109__b842352706142732">ECS</strong>, <strong id="EN-US_TOPIC_0020092109__b842352706142735">BMS</strong>, <strong id="EN-US_TOPIC_0020092109__b842352706142738">FusionCompute</strong>, or <strong id="EN-US_TOPIC_0020092109__b842352706142742">Ironic</strong>.</p>
<ul id="EN-US_TOPIC_0020092109__ul10285150153317"><li id="EN-US_TOPIC_0020092109__li62851550183312"><strong id="EN-US_TOPIC_0020092109__b1679920156268">ECS</strong> and <strong id="EN-US_TOPIC_0020092109__b570711972619">FusionCompute</strong>: indicates an <span id="EN-US_TOPIC_0020092109__text37371895211"></span><span id="EN-US_TOPIC_0020092109__text1351161220214">ECS</span> image.</li><li id="EN-US_TOPIC_0020092109__li1428525011339"><strong id="EN-US_TOPIC_0020092109__b17886339202614">BMS</strong> and <strong id="EN-US_TOPIC_0020092109__b11573143112613">Ironic</strong>: indicates a <span id="EN-US_TOPIC_0020092109__text952615201120"></span><span id="EN-US_TOPIC_0020092109__text91461922926">BMS</span> image.</li></ul>
<p id="EN-US_TOPIC_0020092109__p1092012236246">The default value is <strong id="EN-US_TOPIC_0020092109__b842352706141017">ECS</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row17288142411"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p149911643152415">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p19911443122420">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1599120439243">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p6561225191515">Specifies the image description. This parameter is left blank by default. For details, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
<p id="EN-US_TOPIC_0020092109__p1612923614554">The image description must meet the following requirements:</p>
<ul id="EN-US_TOPIC_0020092109__ul1695092311560"><li id="EN-US_TOPIC_0020092109__li149505237567">Contains only letters and digits.</li><li id="EN-US_TOPIC_0020092109__li139501239563">Cannot contain carriage returns and angle brackets (&lt; &gt;).</li><li id="EN-US_TOPIC_0020092109__li16950823155616">Cannot exceed 1024 characters.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row773158172418"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p6991243102410">min_ram</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p49916436247">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1299113431240">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p749312765711">Specifies the minimum memory size (MB) required for running the image.</p>
<p id="EN-US_TOPIC_0020092109__p12991443142417">The parameter value depends on the <span id="EN-US_TOPIC_0020092109__text157021615104810"></span><span id="EN-US_TOPIC_0020092109__text3702171515487">ECS</span> specifications. The default value is <strong id="EN-US_TOPIC_0020092109__b7611192911913">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row97348132415"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p99915435246">max_ram</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p6992743152410">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p199923433247">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p873711325720">Specifies the maximum memory size (MB) required for running the image.</p>
<p id="EN-US_TOPIC_0020092109__p169921243182416">The parameter value depends on the <span id="EN-US_TOPIC_0020092109__text1547593105610"></span><span id="EN-US_TOPIC_0020092109__text134761931165610">ECS</span> specifications. The default value is <strong id="EN-US_TOPIC_0020092109__b64761631185611">0</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row57318815242"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p0992843192420">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p0992104310243">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p19992184322413">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1399213430241">Specifies tags of the image. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p10992184302416">Use either <strong id="EN-US_TOPIC_0020092109__b1990384923">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b1139575486">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row189015152240"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p89921243122410">image_tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p1399315436246">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p59931243112412">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p20170175335712">Specifies tags of the image. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0020092109__p13993843182416">Use either <strong id="EN-US_TOPIC_0020092109__b1214584693">tags</strong> or <strong id="EN-US_TOPIC_0020092109__b1407631960">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row290111572411"><td class="cellrowborder" valign="top" width="17.938206179382064%" headers="mcps1.3.4.2.3.1.1.5.1.1 "><p id="EN-US_TOPIC_0020092109__p1399364310249">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.388361163883612%" headers="mcps1.3.4.2.3.1.1.5.1.2 "><p id="EN-US_TOPIC_0020092109__p159934434247">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.858414158584141%" headers="mcps1.3.4.2.3.1.1.5.1.3 "><p id="EN-US_TOPIC_0020092109__p1399374317246">String</p>
</td>
<td class="cellrowborder" valign="top" width="49.81501849815018%" headers="mcps1.3.4.2.3.1.1.5.1.4 "><p id="EN-US_TOPIC_0020092109__p1999334392410">Specifies the enterprise project that the image belongs to.</p>
<ul id="EN-US_TOPIC_0020092109__ul1199394318242"><li id="EN-US_TOPIC_0020092109__li16993204342419">If the value is <strong id="EN-US_TOPIC_0020092109__b1895693334">0</strong> or left blank, the image belongs to the default enterprise project.</li><li id="EN-US_TOPIC_0020092109__li26962020105817">If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.<p id="EN-US_TOPIC_0020092109__p1584912513425"><a name="EN-US_TOPIC_0020092109__li26962020105817"></a><a name="li26962020105817"></a>For more information about enterprise projects and how to obtain enterprise project IDs, see <em id="EN-US_TOPIC_0020092109__i1895691004">Enterprise Management User Guide</em>.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020092109__section175971523154019"><h4 class="sectiontitle">Example Request</h4><ul id="EN-US_TOPIC_0020092109__ul1757419314298"><li id="EN-US_TOPIC_0020092109__li2395001314298">Creating a system disk image with parameter <strong id="EN-US_TOPIC_0020092109__b8952124814716">tags</strong> using an <span id="EN-US_TOPIC_0020092109__text24441350723"></span><span id="EN-US_TOPIC_0020092109__text0445195011215">ECS</span> (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)<pre class="screen" id="EN-US_TOPIC_0020092109__screen215813172014">POST https://{Endpoint}/v2/cloudimages/action
{
"name": "ims_test",
"description": "Create a system disk image from an <span id="EN-US_TOPIC_0020092109__text1432512101233"></span><span id="EN-US_TOPIC_0020092109__text63251910537">ECS</span>",
"instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
"tags": [
"aaa.111",
"bbb.333",
"ccc.444"
]
}</pre>
</li><li id="EN-US_TOPIC_0020092109__li4007687614298">Creating a data disk image with parameter <strong id="EN-US_TOPIC_0020092109__b1341715165017">tags</strong> using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an <span id="EN-US_TOPIC_0020092109__text07291441548"></span><span id="EN-US_TOPIC_0020092109__text16730941043">ECS</span><div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen2500152314298"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{Endpoint}/v2/cloudimages/action</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;data_images&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims_data_image_test&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create a data disk image from the data disk of an ECS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;volume_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;c5dfbd0c-bf0a-4798-a453-61dc6b54aa30&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;aaa.111&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;bbb.333&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ccc.444&quot;</span>
<span class="w"> </span><span class="o">]</span>
<span class="w"> </span><span class="p">}</span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0020092109__li2368711814298">Creating an image with parameter <strong id="EN-US_TOPIC_0020092109__b138415165549">tags</strong> using a file in an OBS bucket (file address in the bucket: ims-image:centos70.qcow2)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen3960840914298"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{Endpoint}/v2/cloudimages/action</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims_test_file&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create an image from a file in an OBS bucket&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;image_url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims-image:centos70.qcow2&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;os_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;CentOS 7.0 64bit&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;min_disk&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="w"> </span>
<span class="w"> </span><span class="s">&quot;aaa.111&quot;</span><span class="p">,</span><span class="w"> </span>
<span class="w"> </span><span class="s">&quot;bbb.333&quot;</span><span class="p">,</span><span class="w"> </span>
<span class="w"> </span><span class="s">&quot;ccc.444&quot;</span><span class="w"> </span>
<span class="w"> </span><span class="o">]</span><span class="w"> </span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0020092109__ul24159091151619"><li id="EN-US_TOPIC_0020092109__li5156003151615">Creating a system disk image with parameter <strong id="EN-US_TOPIC_0020092109__b19625816571">image_tags</strong> using an <span id="EN-US_TOPIC_0020092109__text76257118574"></span><span id="EN-US_TOPIC_0020092109__text1162518119577">ECS</span> (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)<pre class="screen" id="EN-US_TOPIC_0020092109__screen57307544571">POST https://{Endpoint}/v2/cloudimages/action
{
"name": "ims_test",
"description": "Create a system disk image from an <span id="EN-US_TOPIC_0020092109__text16268192613585">ECS</span><span id="EN-US_TOPIC_0020092109__text14168202911589"></span>",
"instance_id": "877a2cda-ba63-4e1e-b95f-e67e48b6129a",
"image_tags": [
{
"key": "key2",
"value": "value2"
},
{
"key": "key1",
"value": "value1"
}
]
}</pre>
</li><li id="EN-US_TOPIC_0020092109__li6464842114139">Creating a data disk image with parameter <strong id="EN-US_TOPIC_0020092109__b11362347175715">image_tags</strong> using a data disk (ID: c5dfbd0c-bf0a-4798-a453-61dc6b54aa30) of an <span id="EN-US_TOPIC_0020092109__text1435123695717"></span><span id="EN-US_TOPIC_0020092109__text1836183635712">ECS</span><div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen651981114139"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="o">/</span><span class="n">v2</span><span class="o">/</span><span class="n">cloudimages</span><span class="o">/</span><span class="n">action</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;data_images&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims_data_image_test&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create a data disk image from the data disk of an ECS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;volume_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;c5dfbd0c-bf0a-4798-a453-61dc6b54aa30&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;image_tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="s">&quot;key2&quot;</span><span class="p">,</span><span class="s">&quot;value&quot;</span><span class="p">:</span><span class="s">&quot;value2&quot;</span><span class="p">},{</span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="s">&quot;key1&quot;</span><span class="p">,</span><span class="s">&quot;value&quot;</span><span class="p">:</span><span class="s">&quot;value1&quot;</span><span class="p">}</span><span class="o">]</span>
<span class="w"> </span><span class="p">}</span><span class="o">]</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0020092109__li23069350151626">Creating an image with parameter <strong id="EN-US_TOPIC_0020092109__b821945718573">image_tags</strong> using a file in an OBS bucket (file address in the bucket: ims-image:centos70.qcow2)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen3416680115360"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span>
<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{Endpoint}/v2/cloudimages/action</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims_test_file&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create an image from a file in an OBS bucket&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;image_url&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims-image:centos70.qcow2&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;os_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;CentOS 7.0 64bit&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;min_disk&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">40</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;image_tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="s">&quot;key2&quot;</span><span class="p">,</span><span class="s">&quot;value&quot;</span><span class="p">:</span><span class="s">&quot;value2&quot;</span><span class="p">},{</span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="s">&quot;key1&quot;</span><span class="p">,</span><span class="s">&quot;value&quot;</span><span class="p">:</span><span class="s">&quot;value1&quot;</span><span class="p">}</span><span class="o">]</span><span class="w"> </span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0020092109__li6755299102749">Creating a system disk image with parameter <strong id="EN-US_TOPIC_0020092109__b1216133195819">tags</strong> using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen18882661507"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{Endpoint}/v2/cloudimages/action</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims_test&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create a system disk image from a data disk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;volume_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;877a2cda-ba63-4e1e-b95f-e67e48b6129a&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ECS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;os_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;CentOS 7.0 64bit&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
<span class="w"> </span><span class="s">&quot;aaa.111&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;bbb.333&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;ccc.444&quot;</span><span class="w"> </span>
<span class="w"> </span><span class="o">]</span>
<span class="w"> </span><span class="p">}</span><span class="w"> </span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0020092109__li1735061410133">Creating a system disk image with parameter <strong id="EN-US_TOPIC_0020092109__b152080503">image_tags</strong> using a data disk (ID: 877a2cda-ba63-4e1e-b95f-e67e48b6129a)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen172513586503"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span>
<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{Endpoint}/v2/cloudimages/action</span>
<span class="p">{</span>
<span class="w"> </span><span class="s">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ims_test&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create a system disk image from a data disk&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;volume_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;877a2cda-ba63-4e1e-b95f-e67e48b6129a&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;ECS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;os_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;CentOS 7.0 64bit&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;image_tags&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="s">&quot;key2&quot;</span><span class="p">,</span><span class="s">&quot;value&quot;</span><span class="p">:</span><span class="s">&quot;value2&quot;</span><span class="p">},{</span><span class="s">&quot;key&quot;</span><span class="p">:</span><span class="s">&quot;key1&quot;</span><span class="p">,</span><span class="s">&quot;value&quot;</span><span class="p">:</span><span class="s">&quot;value1&quot;</span><span class="p">}</span><span class="o">]</span><span class="w"> </span>
<span class="w"> </span><span class="p">}</span><span class="w"> </span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020092109__section56649665"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0020092109__ul5650340811159"><li id="EN-US_TOPIC_0020092109__li3876862611159">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table1337332211159" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020092109__row1133156911159"><th align="left" class="cellrowborder" valign="top" width="23.84%" id="mcps1.3.6.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0020092109__p4544189211159">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.6.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0020092109__p556206921988">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.19%" id="mcps1.3.6.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0020092109__p5691464411159">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row4668343211159"><td class="cellrowborder" valign="top" width="23.84%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0020092109__p2326164111159">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0020092109__p89821791988">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.19%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0020092109__p514473411159">Specifies the asynchronous job ID.</p>
<p id="EN-US_TOPIC_0020092109__p19968122117312">For details, see <a href="en-us_topic_0022473688.html">Querying the Status of an Asynchronous Job</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0020092109__li4519872011242">Example response<pre class="codeblock" id="EN-US_TOPIC_0020092109__codeblock6641838292551">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0020092109__screen57817692534"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;job_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;8a12fc664fb4daa3014fb4e581380005&quot;</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0020092109__section40084941"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0020092109__ul4445458"><li id="EN-US_TOPIC_0020092109__li40009126">Normal<p id="EN-US_TOPIC_0020092109__p24537816"><a name="EN-US_TOPIC_0020092109__li40009126"></a><a name="li40009126"></a>200</p>
</li><li id="EN-US_TOPIC_0020092109__li19513753">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0020092109__table1069408417333" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0020092109__row4772021317333"><th align="left" class="cellrowborder" valign="top" width="46.54%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0020092109__p4013206717333">Returned Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.459999999999994%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0020092109__p2947196917333">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0020092109__row3841925517333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020092109__p2495195017333">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020092109__p784206117333">Request error. For details about the returned error code, see <a href="en-us_topic_0022473689.html">Error Codes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row3122722917333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020092109__p4637763817333">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020092109__p6560116717333">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row5353959117333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020092109__p4173958717333">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020092109__p2546341217333">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row5197513192250"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020092109__p21898657192252">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020092109__p28960832192252">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row2784412417333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020092109__p4078159117333">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020092109__p1497458717333">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0020092109__row55355517333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0020092109__p4483799017333">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0020092109__p799858217333">The service is unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0135460761.html">Image</a></div>
</div>
</div>