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

396 lines
36 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0022473688"></a><a name="EN-US_TOPIC_0022473688"></a>
<h1 class="topictitle1">Querying the Status of an Asynchronous Job</h1>
<div id="body1449025499002"><div class="section" id="EN-US_TOPIC_0022473688__section6534076917543"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0022473688__p5811096517543">This is an extension API. It is used to query for the execution status of an asynchronous job, for example, querying for the execution status of an image exporting job.</p>
</div>
<div class="section" id="EN-US_TOPIC_0022473688__section5323664117543"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0022473688__p5107674017543">GET /v1/{project_id}/jobs/{job_id}</p>
<div class="p" id="EN-US_TOPIC_0022473688__p16336635112616"><a href="#EN-US_TOPIC_0022473688__table4357530317543">Table 1</a> lists the parameters in the URI.
<div class="tablenoborder"><a name="EN-US_TOPIC_0022473688__table4357530317543"></a><a name="table4357530317543"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table4357530317543" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="EN-US_TOPIC_0022473688__row4437355317543"><th align="left" class="cellrowborder" valign="top" width="21.43%" id="mcps1.3.2.3.2.2.4.1.1"><p id="EN-US_TOPIC_0022473688__p3748803717543"><strong id="EN-US_TOPIC_0022473688__b24725868162658">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="29.349999999999998%" id="mcps1.3.2.3.2.2.4.1.2"><p id="EN-US_TOPIC_0022473688__p1663218617543">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="49.220000000000006%" id="mcps1.3.2.3.2.2.4.1.3"><p id="EN-US_TOPIC_0022473688__p502984817543">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row476451817543"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p5038164417543">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.349999999999998%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p5438136317543">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.220000000000006%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p4281427417543">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row4978415317543"><td class="cellrowborder" valign="top" width="21.43%" headers="mcps1.3.2.3.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p598456817543">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="29.349999999999998%" headers="mcps1.3.2.3.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p1498798817543">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="49.220000000000006%" headers="mcps1.3.2.3.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p606747617543">Specifies the asynchronous job ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0022473688__section5460728517543"><h4 class="sectiontitle">Request</h4><p id="EN-US_TOPIC_0022473688__p1888811378401">Request parameters</p>
<p id="EN-US_TOPIC_0022473688__p194382062717">None</p>
</div>
<div class="section" id="EN-US_TOPIC_0022473688__section194145754617"><h4 class="sectiontitle">Example Request</h4><p id="EN-US_TOPIC_0022473688__p9881954133918">Querying the status of an asynchronous job</p>
<pre class="screen" id="EN-US_TOPIC_0022473688__screen22176212477">GET /v1/ac234de25c6741d2b1273da49eea1b9e/jobs/ff8080814dbd65d7014dbe0d84db0013</pre>
</div>
<div class="section" id="EN-US_TOPIC_0022473688__section5889951917543"><h4 class="sectiontitle">Response</h4><ul id="EN-US_TOPIC_0022473688__ul5308951911520"><li id="EN-US_TOPIC_0022473688__li804362911520">Response parameters
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table528379811520" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0022473688__row1392930311520"><th align="left" class="cellrowborder" valign="top" width="19.470000000000002%" id="mcps1.3.5.2.1.1.1.4.1.1"><p id="EN-US_TOPIC_0022473688__p5453179311520">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.56%" id="mcps1.3.5.2.1.1.1.4.1.2"><p id="EN-US_TOPIC_0022473688__p574394205922">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.97%" id="mcps1.3.5.2.1.1.1.4.1.3"><p id="EN-US_TOPIC_0022473688__p5499914011520">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row2574533511520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p499736211520">status</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p46525967205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p213318211520">Specifies the job status. The value can be:</p>
<ul id="EN-US_TOPIC_0022473688__ul20396680017"><li id="EN-US_TOPIC_0022473688__li143961388019"><strong id="EN-US_TOPIC_0022473688__b39049298151716">SUCCESS</strong>: The job is successfully executed.</li><li id="EN-US_TOPIC_0022473688__li20396289013"><strong id="EN-US_TOPIC_0022473688__b55570798151716">FAIL</strong>: The job failed to be executed.</li><li id="EN-US_TOPIC_0022473688__li103962820013"><strong id="EN-US_TOPIC_0022473688__b3103968151716">RUNNING</strong>: The job is in progress.</li><li id="EN-US_TOPIC_0022473688__li14396388013"><strong id="EN-US_TOPIC_0022473688__b39990109151716">INIT</strong>: The job is being initialized.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row6606192511520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p4941574211520">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p10506968205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p4325217111520">Specifies the job ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row5372522511520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p5677596811520">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p45758078205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p3545068711520">Specifies the job type.</p>
<ul id="EN-US_TOPIC_0022473688__ul12384124515267"><li id="EN-US_TOPIC_0022473688__li1138484517262"><strong id="EN-US_TOPIC_0022473688__b64531157487">imsCreateImageByInstance</strong>: Creating a system disk image from a cloud server</li><li id="EN-US_TOPIC_0022473688__li188210493284"><strong id="EN-US_TOPIC_0022473688__b18130195719507">imsImportImageJob</strong>: Creating a system disk image from an external image file</li><li id="EN-US_TOPIC_0022473688__li688518492285"><strong id="EN-US_TOPIC_0022473688__b118927241517">imsImportOvaImageJob</strong>: Creating an image from an OVA image file</li><li id="EN-US_TOPIC_0022473688__li28882049112816"><strong id="EN-US_TOPIC_0022473688__b1470141175215">imsVolumeCreateImageJob</strong>: Creating a data disk image from a cloud server</li><li id="EN-US_TOPIC_0022473688__li7890249152812"><strong id="EN-US_TOPIC_0022473688__b54785571521">imsImportDataImageJob</strong>: Creating a data disk image from an external image file</li><li id="EN-US_TOPIC_0022473688__li1689212492286"><strong id="EN-US_TOPIC_0022473688__b19378195095310">imsCreateWholeImageByInstanceJob</strong>: Creating a full-ECS image from an ECS</li><li id="EN-US_TOPIC_0022473688__li188951149102817"><strong id="EN-US_TOPIC_0022473688__b1228825125413">imsCreateWholeImageByBackupJob</strong>: Creating a full-ECS image from a CBR or CSBS backup</li><li id="EN-US_TOPIC_0022473688__li8812131682910"><strong id="EN-US_TOPIC_0022473688__b1034043895516">imsNativeImportImageJob</strong>: Registering an image</li><li id="EN-US_TOPIC_0022473688__li58978497289"><strong id="EN-US_TOPIC_0022473688__b1458010415610">imsNativeExportImageJob</strong>: Exporting image</li><li id="EN-US_TOPIC_0022473688__li4773223102915"><strong id="EN-US_TOPIC_0022473688__b9297415125618">imsAddImageMembersJob</strong>: Adding tenants that can use a shared image</li><li id="EN-US_TOPIC_0022473688__li187261026142913"><strong id="EN-US_TOPIC_0022473688__b816342135616">imsDelImageMembersJob</strong>: Deleting tenants that can use a shared image</li><li id="EN-US_TOPIC_0022473688__li18899184932817"><strong id="EN-US_TOPIC_0022473688__b14767124155715">imsUpdateImageMembersJob</strong>: Updating status of tenants who will accept or reject shared images</li><li id="EN-US_TOPIC_0022473688__li1090118490284"><strong id="EN-US_TOPIC_0022473688__b15167161675013">imsCopyImageInRegionJob</strong>: Replicating images</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row5062073411520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p663876511520">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p15416808205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p86908111520">Specifies the start time of the job. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row782172911520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p2958027411520">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p40801918205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p4719198811520">Specifies the end time of the job. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row2207471011520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p4322112411520">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p16621098205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p1125016611520">Specifies the error code.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row3414263711520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p1409017611520">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p4131665205922">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p45364511520">Specifies the failure cause.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row408280811520"><td class="cellrowborder" valign="top" width="19.470000000000002%" headers="mcps1.3.5.2.1.1.1.4.1.1 "><p id="EN-US_TOPIC_0022473688__p6227201211520">entities</p>
</td>
<td class="cellrowborder" valign="top" width="25.56%" headers="mcps1.3.5.2.1.1.1.4.1.2 "><p id="EN-US_TOPIC_0022473688__p66229469205922">Object</p>
</td>
<td class="cellrowborder" valign="top" width="54.97%" headers="mcps1.3.5.2.1.1.1.4.1.3 "><p id="EN-US_TOPIC_0022473688__p287496515">Specifies the custom attributes of the job.</p>
<p id="EN-US_TOPIC_0022473688__p7619211219">If the job status is normal, the image ID will be returned. If the status is abnormal, an error code and details will be returned.</p>
<p id="EN-US_TOPIC_0022473688__p1086820511520">For details, see <a href="#EN-US_TOPIC_0022473688__table791935535712">Table 2</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0022473688__table791935535712"></a><a name="table791935535712"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table791935535712" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Data structure description of the entities field</caption><thead align="left"><tr id="EN-US_TOPIC_0022473688__row99193554577"><th align="left" class="cellrowborder" valign="top" width="23.522352235223522%" id="mcps1.3.5.2.1.2.2.4.1.1"><p id="EN-US_TOPIC_0022473688__p208253244593"><strong id="EN-US_TOPIC_0022473688__b978684968">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="21.67216721672167%" id="mcps1.3.5.2.1.2.2.4.1.2"><p id="EN-US_TOPIC_0022473688__p118251624185918">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="54.80548054805481%" id="mcps1.3.5.2.1.2.2.4.1.3"><p id="EN-US_TOPIC_0022473688__p198257249595">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row7919185585717"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p2091995520577">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p1091918553576">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p491975575711">Specifies the image ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row9688112614196"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p1568862612192">current_task</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p4934949192014">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p9688726131917">Specifies the job name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row6541819191913"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p0541519171911">image_name</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p16795115062019">String</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p15541161910196">Specifies the image name.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row22763015196"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p8271130101912">process_percent</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p15275301193">Double</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p102720303196">Specifies the job progress.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row32991914142016"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p1030061410208">results</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p14300141414200">Array of result objects</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p830091422016">Specifies job execution results. For details, see <a href="#EN-US_TOPIC_0022473688__table12914173422713">Table 3</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row9523124814614"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p9486656144612">sub_jobs_result</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p1972123323915">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p1748615615468">Specifies sub-job execution results. For details, see <a href="#EN-US_TOPIC_0022473688__table1966074735019">Table 4</a>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row19524184817468"><td class="cellrowborder" valign="top" width="23.522352235223522%" headers="mcps1.3.5.2.1.2.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p5486195694618">sub_jobs_list</p>
</td>
<td class="cellrowborder" valign="top" width="21.67216721672167%" headers="mcps1.3.5.2.1.2.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p948619563465">Array of string</p>
</td>
<td class="cellrowborder" valign="top" width="54.80548054805481%" headers="mcps1.3.5.2.1.2.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p18486135624612">Specifies the sub-job IDs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0022473688__table12914173422713"></a><a name="table12914173422713"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table12914173422713" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Data structure description of the result field</caption><thead align="left"><tr id="EN-US_TOPIC_0022473688__row091423402719"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.3.2.4.1.1"><p id="EN-US_TOPIC_0022473688__p89141134152714">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.3.2.4.1.2"><p id="EN-US_TOPIC_0022473688__p49141934182718">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.5.2.1.3.2.4.1.3"><p id="EN-US_TOPIC_0022473688__p291410343270">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row1914123472713"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p1391463492718">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p1091413432717">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p19914123417271">Specifies the image ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row15914193419273"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p7914133442718">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p13914834102713">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p091483410273">Specifies the project ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row7914103411276"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p19914734122719">status</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p10914173420273">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.5.2.1.3.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p12914834122714">Specifies the job status.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0022473688__table1966074735019"></a><a name="table1966074735019"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table1966074735019" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure description of the SubJobResult field</caption><thead align="left"><tr id="EN-US_TOPIC_0022473688__row1266120471506"><th align="left" class="cellrowborder" valign="top" width="17.301730173017297%" id="mcps1.3.5.2.1.4.2.4.1.1"><p id="EN-US_TOPIC_0022473688__p48161954115114"><strong id="EN-US_TOPIC_0022473688__b1453977599">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="24.71247124712471%" id="mcps1.3.5.2.1.4.2.4.1.2"><p id="EN-US_TOPIC_0022473688__p148161154105112">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="57.985798579857985%" id="mcps1.3.5.2.1.4.2.4.1.3"><p id="EN-US_TOPIC_0022473688__p1581695405113">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row66623476508"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p351917011512">status</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p115191302517">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p59291507523">Specifies the sub-job status. The value can be:</p>
<ul id="EN-US_TOPIC_0022473688__ul1679414202528"><li id="EN-US_TOPIC_0022473688__li15794102035210"><strong id="EN-US_TOPIC_0022473688__b1537509935">SUCCESS</strong>: The sub-job is successfully executed.</li><li id="EN-US_TOPIC_0022473688__li19794152015214"><strong id="EN-US_TOPIC_0022473688__b1868563242">FAIL</strong>: The sub-job failed to be executed.</li><li id="EN-US_TOPIC_0022473688__li164591145125217"><strong id="EN-US_TOPIC_0022473688__b16876898">RUNNING</strong>: The sub-job is in progress.</li><li id="EN-US_TOPIC_0022473688__li2794192005210"><strong id="EN-US_TOPIC_0022473688__b1078946285">INIT</strong>: The sub-job is being initialized.</li></ul>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row1066294715012"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p125191206515">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p1151910095112">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p205197013512">Specifies a sub-job ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row10662154715017"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p3519802516">job_type</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p65201907519">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p252040175114">Specifies the sub-job type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row766216471505"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p13520209516">begin_time</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p175208010519">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p752011055120">Specifies the start time of the sub-job. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row10662947165011"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p1652080165111">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p115201302513">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p252016025119">Specifies the end time of the sub-job. The value is in UTC format. </p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row26621547195019"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p11161192205110">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p14161122115118">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p151611522105116">Specifies the error code.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row518138165115"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p1016112212516">fail_reason</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p9161122155110">String</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p16161152210518">Specifies the failure cause.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row218112855115"><td class="cellrowborder" valign="top" width="17.301730173017297%" headers="mcps1.3.5.2.1.4.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p10161182216516">entities</p>
</td>
<td class="cellrowborder" valign="top" width="24.71247124712471%" headers="mcps1.3.5.2.1.4.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p9161822145116">Object</p>
</td>
<td class="cellrowborder" valign="top" width="57.985798579857985%" headers="mcps1.3.5.2.1.4.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p43467016532">Specifies the custom attributes of the sub-job. For details, see <a href="#EN-US_TOPIC_0022473688__table294510331539">Table 5</a>.</p>
<ul id="EN-US_TOPIC_0022473688__ul74268145312"><li id="EN-US_TOPIC_0022473688__li1642482532">If a sub-job is properly executed, an image ID is returned. </li><li id="EN-US_TOPIC_0022473688__li14220814539">If an exception occurs on the sub-job, an error code and associated information are returned.</li></ul>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0022473688__table294510331539"></a><a name="table294510331539"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table294510331539" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Data structure description of the SubJobEntities field</caption><thead align="left"><tr id="EN-US_TOPIC_0022473688__row89504333535"><th align="left" class="cellrowborder" valign="top" width="17.69%" id="mcps1.3.5.2.1.5.2.4.1.1"><p id="EN-US_TOPIC_0022473688__p19390121465414"><strong id="EN-US_TOPIC_0022473688__b264749953">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.75%" id="mcps1.3.5.2.1.5.2.4.1.2"><p id="EN-US_TOPIC_0022473688__p3390121405416">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.56%" id="mcps1.3.5.2.1.5.2.4.1.3"><p id="EN-US_TOPIC_0022473688__p1839051435417">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row9950633185310"><td class="cellrowborder" valign="top" width="17.69%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p187295812533">image_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.75%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p78724585534">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.56%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p9872258135315">Specifies the image ID.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row8951183385316"><td class="cellrowborder" valign="top" width="17.69%" headers="mcps1.3.5.2.1.5.2.4.1.1 "><p id="EN-US_TOPIC_0022473688__p2087335820532">image_name</p>
</td>
<td class="cellrowborder" valign="top" width="25.75%" headers="mcps1.3.5.2.1.5.2.4.1.2 "><p id="EN-US_TOPIC_0022473688__p48731258195315">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.56%" headers="mcps1.3.5.2.1.5.2.4.1.3 "><p id="EN-US_TOPIC_0022473688__p087365815310">Specifies the image name.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0022473688__ul613174517543"><li id="EN-US_TOPIC_0022473688__li5518571217543">Example response<pre class="codeblock" id="EN-US_TOPIC_0022473688__codeblock1424922094754">STATUS CODE 200</pre>
<div class="codecoloring" codetype="Java" id="EN-US_TOPIC_0022473688__screen1711074594724"><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>
<span class="normal">16</span>
<span class="normal">17</span>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span>
<span class="normal">21</span></pre></div></td><td class="code"><div><pre><span></span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SUCCESS&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;entities&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;image_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;e9e91bff-14b6-4a0b-8377-4ed0813e3360&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;image_name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;asdfasdfasdfas&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;process_percent&quot;</span><span class="p">:</span><span class="w"> </span><span class="mf">0.20</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;current_task&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;CreateImageByInstanceTask&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;results&quot;</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="p">{</span>
<span class="w"> </span><span class="s">&quot;image_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;49e9447f-7dff-41e0-8036-f66fe5488c8b&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;project_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;089b2f9a3d80d3062f24c00ca4ed5cbd&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;success&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="o">]</span>
<span class="w"> </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;ff8080814dbd65d7014dbe0d84db0013&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;job_type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;createImageByInstance&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;begin_time&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;04-Jun-2015 18:11:06:586&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;end_time&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;error_code&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span>
<span class="w"> </span><span class="s">&quot;fail_reason&quot;</span><span class="p">:</span><span class="w"> </span><span class="kc">null</span>
<span class="p">}</span>
</pre></div></td></tr></table></div>
</div>
</li></ul>
</div>
<div class="section" id="EN-US_TOPIC_0022473688__section3678893217543"><h4 class="sectiontitle">Returned Values</h4><ul id="EN-US_TOPIC_0022473688__ul2711350917543"><li id="EN-US_TOPIC_0022473688__li4269498917543">Normal<p id="EN-US_TOPIC_0022473688__p4871058617543"><a name="EN-US_TOPIC_0022473688__li4269498917543"></a><a name="li4269498917543"></a>200</p>
</li><li id="EN-US_TOPIC_0022473688__li3574209117543">Abnormal
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0022473688__table395981717657" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0022473688__row1597872817657"><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_0022473688__p1920862517657">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_0022473688__p1239479817657">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0022473688__row6445460017657"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0022473688__p5344010217657">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_0022473688__p3368100917657">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row3469362617657"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0022473688__p5872033917657">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_0022473688__p5872698817657">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row5878084417657"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0022473688__p6362789617657">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_0022473688__p5358597717657">You do not have the rights to perform the operation.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row1251175317657"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0022473688__p681909217657">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_0022473688__p1547559217657">Internal service error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0022473688__row506260017657"><td class="cellrowborder" valign="top" width="46.54%" headers="mcps1.3.6.2.2.1.1.3.1.1 "><p id="EN-US_TOPIC_0022473688__p741745117657">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_0022473688__p6394266717657">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_0000001311190309.html">Image Jobs</a></div>
</div>
</div>
View Git Blame Copy Permalink