forked from docs/doc-exports
Zaoxu, Li
c236478734
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>
277 lines
25 KiB
HTML
277 lines
25 KiB
HTML
<a name="EN-US_TOPIC_0083905788"></a><a name="EN-US_TOPIC_0083905788"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Data Disk Image Using an External Image File</h1>
|
|
<div id="body1510715511729"><div class="section" id="EN-US_TOPIC_0083905788__section29995926"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0083905788__p12613921111454">This API is used to create a data disk image from a data disk image file uploaded to the OBS bucket. 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_0083905788__section1527883"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0083905788__p22881586111515">POST /v1/cloudimages/dataimages/action</p>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0083905788__section13750947"><h4 class="sectiontitle">Request</h4><ul id="EN-US_TOPIC_0083905788__ul38847270"><li id="EN-US_TOPIC_0083905788__li1731919311128">Request parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0083905788__table62551043151553" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0083905788__row63356413151553"><th align="left" class="cellrowborder" valign="top" width="18.42%" id="mcps1.3.3.2.1.1.1.5.1.1"><p id="EN-US_TOPIC_0083905788__p41292683151745">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.23%" id="mcps1.3.3.2.1.1.1.5.1.2"><p id="EN-US_TOPIC_0083905788__p51323166151745">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.85%" id="mcps1.3.3.2.1.1.1.5.1.3"><p id="EN-US_TOPIC_0083905788__p36943663151745">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.5%" id="mcps1.3.3.2.1.1.1.5.1.4"><p id="EN-US_TOPIC_0083905788__p16401653151745">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0083905788__row58293752151553"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p24173439151553">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p11891563151553">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p23692580151553">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p40050833151553">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_0083905788__row57744127151553"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p46762671151553">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p29679979151553">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p55268124151553">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p88441577299">Provides supplementary information about the image.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p47533098151553">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 (< >) are not allowed. This parameter is left blank by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row25144703151553"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p26913998111642">os_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p32550218111642">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p19321962111642">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p21575062111642">Specifies the OS type.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p59957837111642">It can only be Windows or Linux. The default is Linux.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row30504483181035"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p3325055511177">image_url</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p894042511177">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p5308582811177">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p498478711177">Specifies the URL of the external image file in the OBS bucket.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p1003131911177">The format is <em id="EN-US_TOPIC_0083905788__i84235269710218">OBS bucket name</em>:<em id="EN-US_TOPIC_0083905788__i84235269710226">Image file name</em>.</p>
|
|
<div class="note" id="EN-US_TOPIC_0083905788__note077114016594"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="EN-US_TOPIC_0083905788__p277840145919">The storage class of the OBS bucket must be <strong id="EN-US_TOPIC_0083905788__b7667162711298">Standard</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row52404160111723"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p55358975111759">min_disk</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p54892022111759">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p17068760111759">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p40392335111759">Specifies the minimum size of the data disk.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p27986702111759">Value range: 40 GB to 2048 GB</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row39879232111737"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p10803010111759">cmk_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p2628645111759">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p11593672111759">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p66672211111759">Specifies a custom key used for encrypting an image. For its value, see the <em id="EN-US_TOPIC_0083905788__i9753163002215">Key Management Service User Guide</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row44108176111744"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p17224683111759">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p53022050111759">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p66927678111759">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p55071526615">Lists the image tags. This parameter is left blank by default.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p52432871111759">For detailed parameter description, see <a href="en-us_topic_0020092110.html">Image Tag Data Formats</a>.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p20992085173243">Use either <strong id="EN-US_TOPIC_0083905788__b84235270693042">tags</strong> or <strong id="EN-US_TOPIC_0083905788__b84235270693044">image_tags</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row2323281018425"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p4480124311356">image_tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p3825882611356">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p4539910111356">Array of <a href="#EN-US_TOPIC_0083905788__table28981872587">ImageTag</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p62821058568">Lists the image tags. This parameter is left blank by default.</p>
|
|
<p id="EN-US_TOPIC_0083905788__p1407230811356">Use either <strong id="EN-US_TOPIC_0083905788__b2123004407">tags</strong> or <strong id="EN-US_TOPIC_0083905788__b148205695">image_tags</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row291543173011"><td class="cellrowborder" valign="top" width="18.42%" headers="mcps1.3.3.2.1.1.1.5.1.1 "><p id="EN-US_TOPIC_0083905788__p0274133393011">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.23%" headers="mcps1.3.3.2.1.1.1.5.1.2 "><p id="EN-US_TOPIC_0083905788__p1327418332305">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.85%" headers="mcps1.3.3.2.1.1.1.5.1.3 "><p id="EN-US_TOPIC_0083905788__p192741133163012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.5%" headers="mcps1.3.3.2.1.1.1.5.1.4 "><p id="EN-US_TOPIC_0083905788__p10305182217584">Specifies the enterprise project that the image belongs to.</p>
|
|
<ul id="EN-US_TOPIC_0083905788__ul76914342313"><li id="EN-US_TOPIC_0083905788__en-us_topic_0133188204_li06911382318">If the value is <strong id="EN-US_TOPIC_0083905788__b25944215162">0</strong> or left blank, the image belongs to the default enterprise project.</li><li id="EN-US_TOPIC_0083905788__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_0083905788__en-us_topic_0133188204_p13705743174014"><a name="EN-US_TOPIC_0083905788__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_0083905788__i1223032819161">Enterprise Management User Guide</em>.</p>
|
|
</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="EN-US_TOPIC_0083905788__table28981872587"></a><a name="table28981872587"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0083905788__table28981872587" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Data structure description of the image_tags field</caption><thead align="left"><tr id="EN-US_TOPIC_0083905788__row989815718584"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.1"><p id="EN-US_TOPIC_0083905788__p158981716589">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.2"><p id="EN-US_TOPIC_0083905788__p1389815719584">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.3"><p id="EN-US_TOPIC_0083905788__p1489814719588">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.1.2.2.5.1.4"><p id="EN-US_TOPIC_0083905788__p1589813717588">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0083905788__row1789867185816"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0083905788__p16898147205815">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0083905788__p789847165814">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0083905788__p158984745816">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0083905788__p12898147205817">Specifies the tag key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row08985785813"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="EN-US_TOPIC_0083905788__p19898117145814">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.2 "><p id="EN-US_TOPIC_0083905788__p589916725813">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="EN-US_TOPIC_0083905788__p189911775816">string</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="EN-US_TOPIC_0083905788__p48996718587">Specifies the tag value.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0083905788__section185671245142310"><h4 class="sectiontitle">Example Request</h4><ul id="EN-US_TOPIC_0083905788__ul4332184711321"><li id="EN-US_TOPIC_0083905788__li193305462249">Creating a data disk image with parameter <strong id="EN-US_TOPIC_0083905788__b1431494420121">tags</strong> using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0083905788__screen66166734111957"><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}/v1/cloudimages/dataimages/action</span>
|
|
<span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"name"</span><span class="p">:</span><span class="w"> </span><span class="s">"fedora-data1"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s">"image-test:fedora_data1.qcow2"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"description"</span><span class="p">:</span><span class="s">"Data disk 1 of Fedora"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"min_disk"</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">"tags"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
<span class="w"> </span><span class="s">"aaa.111"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"bbb.222"</span>
|
|
<span class="w"> </span><span class="o">]</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"os_type"</span><span class="p">:</span><span class="w"> </span><span class="s">"Linux"</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li><li id="EN-US_TOPIC_0083905788__li340283512262">Creating a data disk image with parameter <strong id="EN-US_TOPIC_0083905788__b3390173211183">image_tags</strong> using a file in an OBS bucket (file address in the bucket: image-test:fedora_data1.qcow2; OS: Linux; minimum size of the data disk: 40 GB)<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0083905788__screen57303158142114"><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}/v1/cloudimages/dataimages/action</span>
|
|
<span class="p">{</span>
|
|
<span class="w"> </span><span class="s">"name"</span><span class="p">:</span><span class="w"> </span><span class="s">"fedora-data2"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"image_url"</span><span class="p">:</span><span class="w"> </span><span class="s">"image-test:fedora_data1.qcow2"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"description"</span><span class="p">:</span><span class="s">"Data disk 2 of Fedora"</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"min_disk"</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">"image_tags"</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span><span class="s">"key"</span><span class="p">:</span><span class="s">"aaa"</span><span class="p">,</span><span class="s">"value"</span><span class="p">:</span><span class="s">"111"</span><span class="p">},{</span><span class="s">"key"</span><span class="p">:</span><span class="s">"bbb"</span><span class="p">,</span><span class="s">"value"</span><span class="p">:</span><span class="s">"222"</span><span class="p">}</span><span class="o">]</span><span class="p">,</span>
|
|
<span class="w"> </span><span class="s">"os_type"</span><span class="p">:</span><span class="w"> </span><span class="s">"Linux"</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0083905788__section56649665"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0083905788__ul5650340811159"><li id="EN-US_TOPIC_0083905788__li3876862611159">Response parameters
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0083905788__table1337332211159" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0083905788__row1133156911159"><th align="left" class="cellrowborder" valign="top" width="23.84%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0083905788__p4544189211159">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.97%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0083905788__p556206921988">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.19%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0083905788__p5691464411159">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0083905788__row4668343211159"><td class="cellrowborder" valign="top" width="23.84%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0083905788__p2326164111159">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.97%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0083905788__p89821791988">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.19%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0083905788__p514473411159">Specifies the asynchronous job ID.</p>
|
|
<p id="EN-US_TOPIC_0083905788__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_0083905788__li4519872011242">Example response<pre class="codeblock" id="EN-US_TOPIC_0083905788__codeblock6641838292551">STATUS CODE 200</pre>
|
|
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0083905788__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">"job_id"</span><span class="p">:</span><span class="w"> </span><span class="s">"4010a32b5f909853015f90aaa24b0015"</span>
|
|
<span class="p">}</span>
|
|
</pre></div></td></tr></table></div>
|
|
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="EN-US_TOPIC_0083905788__section40084941"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0083905788__ul4445458"><li id="EN-US_TOPIC_0083905788__li40009126">Normal<p id="EN-US_TOPIC_0083905788__p24537816"><a name="EN-US_TOPIC_0083905788__li40009126"></a><a name="li40009126"></a>200</p>
|
|
</li><li id="EN-US_TOPIC_0083905788__li19513753">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0083905788__table1069408417333" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0083905788__row4772021317333"><th align="left" class="cellrowborder" valign="top" width="46.54%" id="mcps1.3.6.2.2.1.1.3.1.1"><p id="EN-US_TOPIC_0083905788__p4013206717333">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.459999999999994%" id="mcps1.3.6.2.2.1.1.3.1.2"><p id="EN-US_TOPIC_0083905788__p2947196917333">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="EN-US_TOPIC_0083905788__row3841925517333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0083905788__p2495195017333">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0083905788__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_0083905788__row3122722917333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0083905788__p4637763817333">401 Unauthorized</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0083905788__p6560116717333">Authentication failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row5353959117333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0083905788__p4173958717333">403 Forbidden</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0083905788__p2546341217333">You do not have the rights to perform the operation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row5197513192250"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0083905788__p21898657192252">404 Not Found</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0083905788__p28960832192252">The requested resource was not found.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row2784412417333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0083905788__p4078159117333">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0083905788__p1497458717333">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="EN-US_TOPIC_0083905788__row55355517333"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0083905788__p4483799017333">503 Service Unavailable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.459999999999994%" headers="mcps1.3.6.2.2.1.1.3.1.2 "><p id="EN-US_TOPIC_0083905788__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>
|
|
|