Files
doc-exports/docs/ims/api-ref/en-us_topic_0133188204.html
wanghuijuan738 d5e281fd38 IMS API 20251110 VERSION.
Reviewed-by: Pristromskaia, Margarita <margarita.pristromskaia@t-systems.com>
Co-authored-by: wanghuijuan738 <wanghuijuan738@huawei.com>
Co-committed-by: wanghuijuan738 <wanghuijuan738@huawei.com>
2025-12-12 16:30:47 +00:00

479 lines
48 KiB
HTML

<a name="EN-US_TOPIC_0133188204"></a><a name="EN-US_TOPIC_0133188204"></a>
<h1 class="topictitle1">Importing an Image File Quickly</h1>
<div id="body1537962346204"><div class="section" id="EN-US_TOPIC_0133188204__section1194520316464"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0133188204__p664534215521">This API is used to quickly create a private image from an oversized external image file that has been uploaded to an OBS bucket. Currently, only ZVHD2 and RAW image files can be imported quickly, and the size of such an image file cannot exceed 1 TB.</p>
<p id="EN-US_TOPIC_0133188204__p109629473523">The fast image creation function is only available for image files in RAW or ZVHD2 format. For other formats of image files that are smaller than 128 GB, you are advised to import these files with the common method.</p>
<p id="EN-US_TOPIC_0133188204__p117122034194714">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>
</div>
<div class="section" id="EN-US_TOPIC_0133188204__section244817584484"><h4 class="sectiontitle">Constraints</h4><div class="p" id="EN-US_TOPIC_0133188204__p888910949">Before importing an image file, ensure that the file format is RAW or ZVHD2 and the following have been done:<ul id="EN-US_TOPIC_0133188204__ul19902104893118"><li id="EN-US_TOPIC_0133188204__li290218480317">For RAW, the image file has been optimized, and a bitmap file has been generated.</li><li id="EN-US_TOPIC_0133188204__li129021348103117">For ZVHD2, the image file has been optimized as required.</li></ul>
</div>
<div class="note" id="EN-US_TOPIC_0133188204__note197617242018"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="EN-US_TOPIC_0133188204__p19310557497">For how to convert image file formats and generate a bitmap file, see section "Quickly Importing an Image File" in the <em id="EN-US_TOPIC_0133188204__i84235269785921">Image Management Service User Guide</em>.</p>
</div></div>
</div>
<div class="section" id="EN-US_TOPIC_0133188204__section1594513117469"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0133188204__p10430195510476">POST /v2/cloudimages/quickimport/action</p>
</div>
<div class="section" id="EN-US_TOPIC_0133188204__section1394517316467"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0133188204__ul163050328461"><li id="EN-US_TOPIC_0133188204__li630573254612">Parameters in the request body when an image file in an OBS bucket is used to create a system disk image
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0133188204__table1996117311464" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0133188204__row230533204615"><th align="left" class="cellrowborder" valign="top" width="23.23232323232323%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0133188204__p13051332144610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.16161616161616%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0133188204__p1630520329462">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.2020202020202%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0133188204__p5305332184616">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.4040404040404%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0133188204__p73056327467">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0133188204__row430593218463"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p330543210463">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1630553264617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p3305932144610">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1551018218225">Specifies the image name.</p>
<p id="EN-US_TOPIC_0133188204__p630510326467">For detailed description, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row130503284613"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p73051932154620">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1430513324463">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p6305732154618">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p16554109232">Provides supplementary information about the image.</p>
<p id="EN-US_TOPIC_0133188204__p14983181319239">For detailed description, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
<p id="EN-US_TOPIC_0133188204__p1230533224616">The value contains a maximum of 1024 characters, including 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_0133188204__row143051632144610"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p18305432174611">os_version</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p123051332104613">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p14305183244611">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p5305203217468">Specifies the OS version.</p>
<p id="EN-US_TOPIC_0133188204__p430583213464">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>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row93058325464"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p103058329463">image_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p630533211465">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p1630593294615">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1230517327465">Specifies the URL of the external image file in the OBS bucket.</p>
<p id="EN-US_TOPIC_0133188204__p03051832114620">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_0133188204__i84235269710218">OBS bucket name</em>:<em id="EN-US_TOPIC_0133188204__i84235269710226">Image file name</em>.</p>
<div class="note" id="EN-US_TOPIC_0133188204__note683161117572"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0133188204__p1983121111571">The storage class of the OBS bucket must be <strong id="EN-US_TOPIC_0133188204__b19684172820416">Standard</strong>.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row730573215467"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p1430593274613">min_disk</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p4305193224619">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p2305632134614">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p143051632104617">Specifies the minimum size (GB) of the system disk.</p>
<ul id="EN-US_TOPIC_0133188204__ul2568215149"><li id="EN-US_TOPIC_0133188204__li35615217144">This parameter is mandatory if an external image file in the OBS bucket is used to create an image.</li><li id="EN-US_TOPIC_0133188204__li135614291410">The value ranges from 1 to 1024 and must be greater than the system disk size in the selected image file.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row16305113220466"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p1730583214460">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1230510329468">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p13058328463">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p10305732164620">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0133188204__p3106162222815">Set either <strong id="EN-US_TOPIC_0133188204__b68022071419">tags</strong> or <strong id="EN-US_TOPIC_0133188204__b17807204145">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row1259121152812"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p21354848113521">image_tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p29922489113521">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p56528150113521">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p58098807113521">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0133188204__p19190125113278">Set either <strong id="EN-US_TOPIC_0133188204__b64491227181417">tags</strong> or <strong id="EN-US_TOPIC_0133188204__b5450172718146">image_tags</strong>.</p>
<p id="EN-US_TOPIC_0133188204__p18181143565819">For details about <strong id="EN-US_TOPIC_0133188204__b3240122917588">image_tags</strong>, see <a href="#EN-US_TOPIC_0133188204__table1394012426522">Table 1</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row1330510320467"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p12305193254612">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p430514323464">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p13305183212463">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p61071357182213">Specifies the image type.</p>
<p id="EN-US_TOPIC_0133188204__p7563101192314">The value can be:</p>
<p id="EN-US_TOPIC_0133188204__p2066714822311"><strong id="EN-US_TOPIC_0133188204__b4878118416">ECS</strong>: ECS system disk image</p>
<p id="EN-US_TOPIC_0133188204__p1794105262313"><strong id="EN-US_TOPIC_0133188204__b198356233414">BMS</strong>: BMS system disk image</p>
<p id="EN-US_TOPIC_0133188204__p159162059182420">Default value:</p>
<p id="EN-US_TOPIC_0133188204__p968554257"><strong id="EN-US_TOPIC_0133188204__b18562174120416">ECS</strong></p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row108754514344"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p172919315292">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p172915311293">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p182911231172912">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p10305182217584">Specifies the enterprise project that the image belongs to.</p>
<ul id="EN-US_TOPIC_0133188204__ul76914342313"><li id="EN-US_TOPIC_0133188204__li06911382318">If the value is <strong id="EN-US_TOPIC_0133188204__b842352706111949">0</strong> or left blank, the image belongs to the default enterprise project.</li><li id="EN-US_TOPIC_0133188204__li186911342317">If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.<p id="EN-US_TOPIC_0133188204__p13705743174014"><a name="EN-US_TOPIC_0133188204__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_0133188204__i119223321415">Enterprise Management User Guide</em>.</p>
</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row134361944974"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p1531631810">architecture</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p35316311810">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p15318311813">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1710991214517">Specifies the image architecture type. The value can be:</p>
<ul id="EN-US_TOPIC_0133188204__ul12299918656"><li id="EN-US_TOPIC_0133188204__li10299818454">x86</li><li id="EN-US_TOPIC_0133188204__li1439817211559">arm</li></ul>
<p id="EN-US_TOPIC_0133188204__p186813286510">The default value is <strong id="EN-US_TOPIC_0133188204__b1460217264193">x86</strong>.</p>
<div class="note" id="EN-US_TOPIC_0133188204__note4599194110418"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0133188204__p892691311810">If the image architecture is Arm, the boot mode is automatically changed to UEFI.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row3140163124914"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p17337124893719">hw_firmware_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1058562083811">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p1658572013381">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1841725410273">Specifies the <span id="EN-US_TOPIC_0133188204__text10530369893236"></span><span id="EN-US_TOPIC_0133188204__text100617372393236">ECS</span> boot mode. The value can be:</p>
<ul id="EN-US_TOPIC_0133188204__ul149852572301"><li id="EN-US_TOPIC_0133188204__li1398575763013"><strong id="EN-US_TOPIC_0133188204__b46795704993310">bios</strong> indicates the BIOS boot mode.</li><li id="EN-US_TOPIC_0133188204__li143561356173116"><strong id="EN-US_TOPIC_0133188204__b11309416293317">uefi</strong> indicates the UEFI boot mode.</li></ul>
<div class="note" id="EN-US_TOPIC_0133188204__note1095419515220"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0133188204__p149543511229">If the image architecture is Arm, only the UEFI boot mode is supported.</p>
</div></div>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0133188204__li93051332124619">Parameters in the request body when an image file in an OBS bucket is used to create a data disk image
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0133188204__table399233124619" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0133188204__row163059328462"><th align="left" class="cellrowborder" valign="top" width="23.23232323232323%" id="mcps1.3.4.2.2.1.1.5.1.1"><p id="EN-US_TOPIC_0133188204__p13058328466">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="16.16161616161616%" id="mcps1.3.4.2.2.1.1.5.1.2"><p id="EN-US_TOPIC_0133188204__p130523214617">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.2020202020202%" id="mcps1.3.4.2.2.1.1.5.1.3"><p id="EN-US_TOPIC_0133188204__p8305103212461">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40.4040404040404%" id="mcps1.3.4.2.2.1.1.5.1.4"><p id="EN-US_TOPIC_0133188204__p1830563214461">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0133188204__row83058326463"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p3305173214616">name</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p53052032114616">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p630543214610">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p3305203234614">Specifies the image name. For detailed description, see <a href="en-us_topic_0020091562.html">Image Attributes</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row73051332174618"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p1230503213462">description</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1230513211468">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p18305532154612">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1630515328463">Provides supplementary information about the image. For detailed description, see <a href="en-us_topic_0020091562.html">Image Attributes</a>. The value contains a maximum of 1024 characters, including 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_0133188204__row830510326469"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p113057324467">os_type</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1130553284618">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p143052324463">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p183051732184612">Specifies the OS version.</p>
<p id="EN-US_TOPIC_0133188204__p1230518329464">When a data disk image created, the value can be <strong id="EN-US_TOPIC_0133188204__b18956127175">Linux</strong> or <strong id="EN-US_TOPIC_0133188204__b159510128177">Windows</strong>. The default is <strong id="EN-US_TOPIC_0133188204__b2096512141713">Linux</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row1330519329465"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p630533264610">image_url</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1130553244617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p14305123218469">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1830573213469">Specifies the URL of the external image file in the OBS bucket.</p>
<p id="EN-US_TOPIC_0133188204__p73051322460">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_0133188204__i84235269710445">OBS bucket name</em>:<em id="EN-US_TOPIC_0133188204__i84235269710449">Image file name</em>.</p>
<div class="note" id="EN-US_TOPIC_0133188204__note736211389571"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0133188204__p03621438175719">The storage class of the OBS bucket must be <strong id="EN-US_TOPIC_0133188204__b688975854">Standard</strong>.</p>
</div></div>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row73059326469"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p2030533214463">min_disk</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p19305123212467">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p193051332114620">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p130513264618">Specifies the minimum size of the system disk in the unit of GB.</p>
<p id="EN-US_TOPIC_0133188204__p15305173217466">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_0133188204__row430516321463"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p130523212468">tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p830512325469">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p1430514322463">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p1830518323464">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0133188204__p1879112459285">Set either <strong id="EN-US_TOPIC_0133188204__b8662228161411">tags</strong> or <strong id="EN-US_TOPIC_0133188204__b5663328171414">image_tags</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row1874183652819"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p182233972817">image_tags</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p52233962817">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p72273910288">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p622153910286">Lists the image tags. This parameter is left blank by default.</p>
<p id="EN-US_TOPIC_0133188204__p1222113913288">Set either <strong id="EN-US_TOPIC_0133188204__b21235334146">tags</strong> or <strong id="EN-US_TOPIC_0133188204__b17123833111414">image_tags</strong>.</p>
<p id="EN-US_TOPIC_0133188204__p91290541575">For details about <strong id="EN-US_TOPIC_0133188204__b08961630145815">image_tags</strong>, see <a href="#EN-US_TOPIC_0133188204__table1394012426522">Table 1</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row173051332174611"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p630519326463">type</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1430523210469">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p13305132164618">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p14591142116262">Specifies the image type.</p>
<p id="EN-US_TOPIC_0133188204__p176553305266">The value can be:</p>
<p id="EN-US_TOPIC_0133188204__p830513320465"><strong id="EN-US_TOPIC_0133188204__b556413407421">DataImage</strong>: data disk image</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row12938171493518"><td class="cellrowborder" valign="top" width="23.23232323232323%" headers="mcps1.3.4.2.2.1.1.5.1.1 "><p id="EN-US_TOPIC_0133188204__p1144371873517">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="16.16161616161616%" headers="mcps1.3.4.2.2.1.1.5.1.2 "><p id="EN-US_TOPIC_0133188204__p9443718163514">No</p>
</td>
<td class="cellrowborder" valign="top" width="20.2020202020202%" headers="mcps1.3.4.2.2.1.1.5.1.3 "><p id="EN-US_TOPIC_0133188204__p154430186356">String</p>
</td>
<td class="cellrowborder" valign="top" width="40.4040404040404%" headers="mcps1.3.4.2.2.1.1.5.1.4 "><p id="EN-US_TOPIC_0133188204__p13443141833517">Specifies the enterprise project that the image belongs to.</p>
<ul id="EN-US_TOPIC_0133188204__ul444316189359"><li id="EN-US_TOPIC_0133188204__en-us_topic_0133188204_li06911382318">If the value is <strong id="EN-US_TOPIC_0133188204__b2078105648">0</strong> or left blank, the image belongs to the default enterprise project.</li><li id="EN-US_TOPIC_0133188204__en-us_topic_0133188204_li186911342317">If the value is a UUID, the image belongs to the enterprise project corresponding to the UUID.<p id="EN-US_TOPIC_0133188204__p18739132816434"><a name="EN-US_TOPIC_0133188204__en-us_topic_0133188204_li186911342317"></a><a name="en-us_topic_0133188204_li186911342317"></a>For more information about enterprise projects and how to obtain enterprise project IDs, see <em id="EN-US_TOPIC_0133188204__i5214636131415">Enterprise Management User Guide</em>.</p>
</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<p id="EN-US_TOPIC_0133188204__p1417714762213"></p>
<div class="tablenoborder"><a name="EN-US_TOPIC_0133188204__table1394012426522"></a><a name="table1394012426522"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0133188204__table1394012426522" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure of the image_tags field</caption><thead align="left"><tr id="EN-US_TOPIC_0133188204__row594094225214"><th align="left" class="cellrowborder" valign="top" width="20.44%" id="mcps1.3.4.4.2.5.1.1"><p id="EN-US_TOPIC_0133188204__p863017285311">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.86%" id="mcps1.3.4.4.2.5.1.2"><p id="EN-US_TOPIC_0133188204__p116306213535">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.849999999999998%" id="mcps1.3.4.4.2.5.1.3"><p id="EN-US_TOPIC_0133188204__p16630182205318">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="43.85%" id="mcps1.3.4.4.2.5.1.4"><p id="EN-US_TOPIC_0133188204__p3630225536">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0133188204__row29401742195215"><td class="cellrowborder" valign="top" width="20.44%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0133188204__p1594064215521">key</p>
</td>
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0133188204__p4940194205214">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0133188204__p19940194275217">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.85%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0133188204__p15940942115214">Specifies the tag key.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row199401642195213"><td class="cellrowborder" valign="top" width="20.44%" headers="mcps1.3.4.4.2.5.1.1 "><p id="EN-US_TOPIC_0133188204__p79401542205214">value</p>
</td>
<td class="cellrowborder" valign="top" width="17.86%" headers="mcps1.3.4.4.2.5.1.2 "><p id="EN-US_TOPIC_0133188204__p1794044215216">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="17.849999999999998%" headers="mcps1.3.4.4.2.5.1.3 "><p id="EN-US_TOPIC_0133188204__p17940124216526">String</p>
</td>
<td class="cellrowborder" valign="top" width="43.85%" headers="mcps1.3.4.4.2.5.1.4 "><p id="EN-US_TOPIC_0133188204__p4940942205210">Specifies the tag value.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0133188204__section8454108133715"><h4 class="sectiontitle">Example Request</h4><ul id="EN-US_TOPIC_0133188204__ul234415106561"><li id="EN-US_TOPIC_0133188204__li165471377567">Creating a system disk image with parameter <strong id="EN-US_TOPIC_0133188204__b208016304617">tags</strong> using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0133188204__screen14532171917547"><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>
<span class="normal">14</span>
<span class="normal">15</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/quickimport/action</span>
<span class="p">{</span><span class="w"> </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="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create an image using 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.zvhd2&quot;</span><span class="p">,</span><span class="w"> </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="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="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="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="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="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0133188204__li466014810018">Creating a system disk image with parameter <strong id="EN-US_TOPIC_0133188204__b19364415873">image_tags</strong> using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0133188204__screen1987594417544"><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></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/quickimport/action</span>
<span class="p">{</span><span class="w"> </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="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create an image using 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.zvhd2&quot;</span><span class="p">,</span><span class="w"> </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="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="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="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_0133188204__li784473116569">Creating a data disk image with parameter <strong id="EN-US_TOPIC_0133188204__b11892230179">tags</strong> using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0133188204__screen39315535418"><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>
<span class="normal">14</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/quickimport/action</span>
<span class="p">{</span><span class="w"> </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="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create an image using 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.zvhd2&quot;</span><span class="p">,</span><span class="w"> </span>
<span class="w"> </span><span class="s">&quot;os_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Linux&quot;</span><span class="p">,</span><span class="w"> </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="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;DataImage&quot;</span><span class="p">,</span><span class="w"> </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="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0133188204__li54649219219">Creating a data disk image with parameter <strong id="EN-US_TOPIC_0133188204__b33721242376">image_tags</strong> using a file in an OBS bucket (file address in the bucket: ims-image:centos70.zvhd2)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0133188204__screen20772172105516"><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></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/quickimport/action</span>
<span class="p">{</span><span class="w"> </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="w"> </span><span class="s">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Create an image using 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.zvhd2&quot;</span><span class="p">,</span><span class="w"> </span>
<span class="w"> </span><span class="s">&quot;os_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;Linux&quot;</span><span class="p">,</span><span class="w"> </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="w"> </span><span class="s">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;DataImage&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="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0133188204__section639632154617"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0133188204__ul930573274617"><li id="EN-US_TOPIC_0133188204__li630543215463">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0133188204__table139163294618" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0133188204__row103054322469"><th align="left" class="cellrowborder" valign="top" width="23.68%" id="mcps1.3.6.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0133188204__p43051732184618">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.74%" id="mcps1.3.6.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0133188204__p113051332184618">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.58%" id="mcps1.3.6.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0133188204__p23051732124619">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0133188204__row83051832144620"><td class="cellrowborder" valign="top" width="23.68%" headers="mcps1.3.6.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0133188204__p730511328463">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="19.74%" headers="mcps1.3.6.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0133188204__p15305163211465">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.58%" headers="mcps1.3.6.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0133188204__p130583216466">Specifies the asynchronous job ID.</p>
<p id="EN-US_TOPIC_0133188204__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_0133188204__li193051132174613">Example response<pre class="codeblock" id="EN-US_TOPIC_0133188204__codeblock1130513321464">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0133188204__screen875016102508"><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_0133188204__section539103214611"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0133188204__ul133052032144613"><li id="EN-US_TOPIC_0133188204__li5305432134614">Normal<p id="EN-US_TOPIC_0133188204__p43051032164615"><a name="EN-US_TOPIC_0133188204__li5305432134614"></a><a name="li5305432134614"></a>200</p>
</li><li id="EN-US_TOPIC_0133188204__li1305103212463">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0133188204__table53911327463" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0133188204__row11305143214468"><th align="left" class="cellrowborder" valign="top" width="46.46%" id="mcps1.3.7.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0133188204__p63051132164612">Return Value</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="53.54%" id="mcps1.3.7.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0133188204__p133051932194617">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0133188204__row11305133204615"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0133188204__p13305143220466">400 Bad Request</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0133188204__p17305203244617">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_0133188204__row1130593211466"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0133188204__p16305183274616">401 Unauthorized</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0133188204__p19305532164619">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row43051832104610"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0133188204__p113057325469">403 Forbidden</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0133188204__p12305153214469">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row23051532194620"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0133188204__p1230553210462">404 Not Found</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0133188204__p9305432184614">The requested resource was not found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row1305132104618"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0133188204__p183056324469">500 Internal Server Error</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0133188204__p730533294620">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0133188204__row1730513326464"><td class="cellrowborder" valign="top" width="46.46%" headers="mcps1.3.7.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0133188204__p6305153284615">503 Service Unavailable</p>
</td>
<td class="cellrowborder" valign="top" width="53.54%" headers="mcps1.3.7.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0133188204__p6305133284616">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>