forked from docs/doc-exports
Dong, Qiu Jian
3336ba8df7
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Dong, Qiu Jian <qiujiandong1@huawei.com> Co-committed-by: Dong, Qiu Jian <qiujiandong1@huawei.com>
324 lines
24 KiB
HTML
324 lines
24 KiB
HTML
<a name="cce_02_0247"></a><a name="cce_02_0247"></a>
|
|
|
|
<h1 class="topictitle1">Reading Job Progress</h1>
|
|
<div id="body1521448221833"><div class="section" id="cce_02_0247__section1686113493165"><h4 class="sectiontitle">Function</h4><p id="cce_02_0247__p149381951101714">This API is used to query the progress of a job with a specified job ID returned after a job request is issued.</p>
|
|
<div class="note" id="cce_02_0247__note815071332616"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="cce_02_0247__ul14941525152710"><li id="cce_02_0247__li549452542712">The URL for cluster management is in the format of https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the path for API access.</li><li id="cce_02_0247__li52264290271">You can call this API when:<ul id="cce_02_0247__ul78861016192816"><li id="cce_02_0247__li578605510277">Creating or deleting a cluster</li><li id="cce_02_0247__li126601115282">Creating or deleting a node</li></ul>
|
|
</li></ul>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="cce_02_0247__section8403243161416"><h4 class="sectiontitle">URI</h4><p id="cce_02_0247__p23575517439">GET /api/v3/projects/{project_id}/jobs/{job_id}</p>
|
|
<p id="cce_02_0247__p2037362514220"><a href="#cce_02_0247__table2027961241820">Table 1</a> describes the parameters of the API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__table2027961241820"></a><a name="table2027961241820"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__table2027961241820" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="cce_02_0247__row122809120186"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.4.1.1"><p id="cce_02_0247__p91421758131813">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.4.2.4.1.2"><p id="cce_02_0247__p101421758131816">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68%" id="mcps1.3.2.4.2.4.1.3"><p id="cce_02_0247__p19143115818187">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__row32801312121810"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0247__p1714415589184">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.4.2.4.1.2 "><p id="cce_02_0247__p814518580186">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0247__p5145175891811">Project ID. For details about how to obtain the project ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row1649094164612"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.4.1.1 "><p id="cce_02_0247__p749015414462">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.4.2.4.1.2 "><p id="cce_02_0247__p1849084134615">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68%" headers="mcps1.3.2.4.2.4.1.3 "><p id="cce_02_0247__p8491141114617">Job ID. For details about how to obtain the job ID, see <a href="cce_02_0271.html">How to Obtain Parameters in the API URI</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="cce_02_0247__section947084713911"><h4 class="sectiontitle">Request</h4><p id="cce_02_0247__p520684017211"><strong id="cce_02_0247__b16801947122110">Request parameters</strong>:</p>
|
|
<p id="cce_02_0247__en-us_topic_0079614900_p54374860"><a href="#cce_02_0247__table189325395020">Table 2</a> describes the request parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__table189325395020"></a><a name="table189325395020"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__table189325395020" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the request header</caption><thead align="left"><tr id="cce_02_0247__en-us_topic_0102499074_row55001954122614"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.4.1.1"><p id="cce_02_0247__en-us_topic_0102499074_p115009545264">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.95%" id="mcps1.3.3.4.2.4.1.2"><p id="cce_02_0247__en-us_topic_0102499074_p175001547265">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.050000000000004%" id="mcps1.3.3.4.2.4.1.3"><p id="cce_02_0247__en-us_topic_0102499074_p16500154162611">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__en-us_topic_0102499074_row199801811203412"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0247__en-us_topic_0102499074_p69808112344">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.95%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0247__en-us_topic_0102499074_p3980111103414">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.050000000000004%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0247__en-us_topic_0102499074_p169801011203416">Message body type (format). Possible values:</p>
|
|
<p id="cce_02_0247__p82611618850">Default: <strong id="cce_02_0247__b10270115219514">application/json</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__en-us_topic_0102499074_row3500125412260"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.4.1.1 "><p id="cce_02_0247__en-us_topic_0102499074_p105001654202618">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.95%" headers="mcps1.3.3.4.2.4.1.2 "><p id="cce_02_0247__en-us_topic_0102499074_p20500954182618">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.050000000000004%" headers="mcps1.3.3.4.2.4.1.3 "><p id="cce_02_0247__p18824197845">Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details on how to obtain a user token, see <a href="cce_02_0344.html">API Usage Guidelines</a>.</p>
|
|
<p id="cce_02_0247__p7895195369">Maximum: <strong id="cce_02_0247__b146766131612">16384</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0247__p1611232212217"><strong id="cce_02_0247__b18637103252113">Example request</strong>:</p>
|
|
<p id="cce_02_0247__p10992402120">N/A</p>
|
|
</div>
|
|
<div class="section" id="cce_02_0247__section61819725020"><h4 class="sectiontitle">Response</h4><p id="cce_02_0247__en-us_topic_0079614900_p2018733"><strong id="cce_02_0247__b13729205219819">Response parameters</strong>:</p>
|
|
<p id="cce_02_0247__p16966318249"><a href="#cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242">Table 3</a> describes the response parameters.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242"></a><a name="en-us_topic_0079616779_en-us_topic_0079614912_ref458774242"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_row38450714"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_p27500114">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.4.4.2.4.1.2"><p id="cce_02_0247__p1654581422214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.4.4.2.4.1.3"><p id="cce_02_0247__p125451914132219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_row48220637"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0247__p108391536181311">kind</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0247__p1056311621716">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0247__p45119571162">API type. The value is fixed at <strong id="cce_02_0247__b19261991711">Job</strong> and cannot be changed.</p>
|
|
<p id="cce_02_0247__p25111357665">Default: <strong id="cce_02_0247__b11718521672">Job</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row1698782994313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0247__p1785493610136">apiVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0247__p757801610179">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0247__p1081815191171">API version. The value is fixed at <strong id="cce_02_0247__b132021726478">v3</strong> and cannot be changed.</p>
|
|
<p id="cce_02_0247__p1181819191570">Default: <strong id="cce_02_0247__b2045773016713">v3</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_row28135397"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0247__p1185493615135">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0247__p734131363510"><a href="#cce_02_0247__table13456192212">metadata</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0247__p10343195011177">Node metadata.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row12484123982118"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0247__p6532732161518">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0247__p5359350141715"><a href="#cce_02_0247__table620623542313">spec</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0247__p173598507179">Detailed node parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row1482918413216"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="cce_02_0247__p15204203610152">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.4.4.2.4.1.2 "><p id="cce_02_0247__p1920413611513"><a href="#cce_02_0247__table5445161610255">status</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48%" headers="mcps1.3.4.4.2.4.1.3 "><p id="cce_02_0247__p9204133661512">Node status.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__table13456192212"></a><a name="table13456192212"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__table13456192212" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Data structure of the <strong id="cce_02_0247__b11948162942113">metadata</strong> field</caption><thead align="left"><tr id="cce_02_0247__row031056182217"><th align="left" class="cellrowborder" valign="top" width="25.252525252525253%" id="mcps1.3.4.5.2.4.1.1"><p id="cce_02_0247__p1225365992218">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26.262626262626267%" id="mcps1.3.4.5.2.4.1.2"><p id="cce_02_0247__p1526815942214">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.484848484848484%" id="mcps1.3.4.5.2.4.1.3"><p id="cce_02_0247__p112681259142219">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__row6345613224"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0247__p103256202220">uid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.262626262626267%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0247__p3305622213">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0247__p73185662212">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row10311567226"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0247__p133756162217">creationTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.262626262626267%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0247__p831856162219">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0247__p173145615222">Job creation time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row10365619222"><td class="cellrowborder" valign="top" width="25.252525252525253%" headers="mcps1.3.4.5.2.4.1.1 "><p id="cce_02_0247__p1931356152218">updateTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26.262626262626267%" headers="mcps1.3.4.5.2.4.1.2 "><p id="cce_02_0247__p73356202217">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.484848484848484%" headers="mcps1.3.4.5.2.4.1.3 "><p id="cce_02_0247__p1330568223">Job update time.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__table620623542313"></a><a name="table620623542313"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__table620623542313" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Data structure of the <strong id="cce_02_0247__b1199613218223">spec</strong> field</caption><thead align="left"><tr id="cce_02_0247__row520663552315"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="cce_02_0247__p208332952414">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="26%" id="mcps1.3.4.6.2.4.1.2"><p id="cce_02_0247__p1184914917244">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49%" id="mcps1.3.4.6.2.4.1.3"><p id="cce_02_0247__p118491295245">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__row12206153513232"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0247__p6206135142317">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0247__p1320643516238">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0247__p19206135162314">Job type, for example, <strong id="cce_02_0247__b119911581564">CreateCluster</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row12206143515238"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0247__p11206235122312">clusterUID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0247__p132061435132316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0247__p6206173582312">ID of the cluster where the job runs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row9206123518238"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0247__p12061135112315">resourceID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0247__p1920643502317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0247__p18206113582316">ID of the resource on which a job is executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row72396288246"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0247__p823992812416">resourceName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0247__p023912892419">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0247__p99811242122710">Name of the resource on which a job is executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row177561327249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0247__p175620323246">extendParam</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0247__p184033616362">Map<String,String></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0247__p1275643219249">Extended parameter. This field is not supported for the current version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row18896173620241"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="cce_02_0247__p1689693612416">subJobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="26%" headers="mcps1.3.4.6.2.4.1.2 "><p id="cce_02_0247__p88941746133512">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49%" headers="mcps1.3.4.6.2.4.1.3 "><p id="cce_02_0247__p1089603642417">List of sub-jobs. For details, see <a href="#cce_02_0247__en-us_topic_0079616779_en-us_topic_0079614912_ref458774242">Table 3</a>.</p>
|
|
<ul id="cce_02_0247__ul725172425411"><li id="cce_02_0247__li192592417547">The sub-job list contains details about all sub-jobs.</li><li id="cce_02_0247__li10365131165411">Usually, a cluster/node creation job consists of multiple sub-jobs. The job is complete only after all sub-jobs are complete.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__table5445161610255"></a><a name="table5445161610255"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__table5445161610255" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Data structure of the <strong id="cce_02_0247__b4342217132416">status</strong> field</caption><thead align="left"><tr id="cce_02_0247__row184611916162519"><th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.4.7.2.4.1.1"><p id="cce_02_0247__p19320122372514">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25.742574257425744%" id="mcps1.3.4.7.2.4.1.2"><p id="cce_02_0247__p103201823182517">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.51485148514851%" id="mcps1.3.4.7.2.4.1.3"><p id="cce_02_0247__p12336122362513">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__row6461141613257"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0247__p6461916102517">phase</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0247__p11461131692514">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0247__p1346114167250">Job status. The options are as follows:</p>
|
|
<ul id="cce_02_0247__ul51301755102811"><li id="cce_02_0247__li91301755182812">JobPhaseInitializing JobPhase = "Initializing"</li><li id="cce_02_0247__li013035511286">JobPhaseRunning JobPhase = "Running"</li><li id="cce_02_0247__li6131145515281">JobPhaseFailed JobPhase = "Failed"</li><li id="cce_02_0247__li8131105532810">JobPhaseSuccess JobPhase = "Success"</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="cce_02_0247__row1646161615257"><td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.7.2.4.1.1 "><p id="cce_02_0247__p946118163258">reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25.742574257425744%" headers="mcps1.3.4.7.2.4.1.2 "><p id="cce_02_0247__p1446161618259">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.51485148514851%" headers="mcps1.3.4.7.2.4.1.3 "><p id="cce_02_0247__p15461171652519">Reason why the job is in the current state.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0247__en-us_topic_0079614900_p24465425"><strong id="cce_02_0247__b1163515418124">Example response</strong>:</p>
|
|
<pre class="screen" id="cce_02_0247__screen16311941183117">{
|
|
"kind": "Job",
|
|
"apiVersion": "v3",
|
|
"metadata": {
|
|
"uid": "354331b2c-229a-11e8-9c75-0255ac100ceb",
|
|
"creationTimestamp": "2020-02-02 08:12:40.672772389 +0000 UTC",
|
|
"updateTimestamp": "2020-02-02 08:21:50.478108569 +0000 UTC"
|
|
},
|
|
"spec": {
|
|
"type": "CreateCluster",
|
|
"clusterUID": "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
|
|
"resourceID": "6f4dcb2c-229a-11e8-9c75-0255ac100ceb",
|
|
"resourceName": "cluster-name",
|
|
"extendParam": {
|
|
"serverID": "bc467e3a-2338-11e8-825b-0255ac100c13"
|
|
},
|
|
"subJobs": [
|
|
{
|
|
"kind": "Job",
|
|
"apiVersion": "v3",
|
|
"metadata": {
|
|
"uid": "fd474fab-9606-11e8-baa9-0255ac10215d",
|
|
"creationTimestamp": "2020-02-02 03:52:34.615819618 +0000 UTC",
|
|
"updateTimestamp": "2020-02-02 04:05:29.196243031 +0000 UTC"
|
|
},
|
|
"spec": {
|
|
"type": "InstallMaster",
|
|
"clusterUID": "fcc72de0-9606-11e8-baa8-0255ac10215d",
|
|
"resourceID": "fd3b4ac0-9606-11e8-baa8-0255ac10215d",
|
|
"extendParam": {
|
|
"serverID": "fd3b4ac0-9606-11e8-baa8-0255ac10215d"
|
|
}
|
|
},
|
|
"status": {
|
|
"phase": "Success"
|
|
}
|
|
},
|
|
{
|
|
"kind": "Job",
|
|
"apiVersion": "v3",
|
|
"metadata": {
|
|
"uid": "fd474f82-9606-11e8-baa8-0255ac10215d",
|
|
"creationTimestamp": "2020-02-02 03:52:33.859150791 +0000 UTC",
|
|
"updateTimestamp": "2020-02-02 03:52:34.615655429 +0000 UTC"
|
|
},
|
|
"spec": {
|
|
"type": "CreatePSMCert",
|
|
"clusterUID": "fcc72de0-9606-11e8-baa8-0255ac10215d"
|
|
},
|
|
"status": {
|
|
"phase": "Success"
|
|
}
|
|
}
|
|
],
|
|
},
|
|
"status": {
|
|
"phase": "Running",
|
|
"reason": ""
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="cce_02_0247__s50f1049a6a4d404c895cf636eb8f3bf1"><h4 class="sectiontitle">Status Code</h4><p id="cce_02_0247__en-us_topic_0079614900_p21869221"><a href="#cce_02_0247__en-us_topic_0079614900_table46761928">Table 7</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="cce_02_0247__en-us_topic_0079614900_table46761928"></a><a name="en-us_topic_0079614900_table46761928"></a><table cellpadding="4" cellspacing="0" summary="" id="cce_02_0247__en-us_topic_0079614900_table46761928" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status code</caption><thead align="left"><tr id="cce_02_0247__en-us_topic_0079614900_row33254664"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.1"><p id="cce_02_0247__p55616028205955">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.3.1.2"><p id="cce_02_0247__p8604418205955">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="cce_02_0247__en-us_topic_0079614900_row41084259"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.1 "><p id="cce_02_0247__en-us_topic_0079614900_p39490674">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.3.1.2 "><p id="cce_02_0247__en-us_topic_0079614900_p44628050">The progress of the specified job is successfully obtained.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="cce_02_0247__p347213715512">For details about error status codes, see <a href="cce_02_0084.html">Status Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="cce_02_0092.html">Cluster Management</a></div>
|
|
</div>
|
|
</div>
|
|
|