forked from docs/doc-exports
Su, Xiaomeng
04ae6632a7
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
132 lines
13 KiB
HTML
132 lines
13 KiB
HTML
<a name="dli_02_0127"></a><a name="dli_02_0127"></a>
|
|
|
|
<h1 class="topictitle1">Querying a Batch Processing Job Status</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_s1f0e4fd3d502405199f36f78e68721aa"><h4 class="sectiontitle">Function</h4><p id="dli_02_0127__en-us_topic_0103345065_p3806970216193">This API is used to obtain the execution status of a batch processing job.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077927_ul10082125"><li id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0127__en-us_topic_0103345065_p9086136161940"><a name="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077927_li23630265"></a>GET /v2.0/{project_id}/batches/{batch_id}/state</p>
|
|
</li><li id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_li1725612218454">Parameter descriptions
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="15.76%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_a420a62a594f9410eaea229ffc8037a61">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.45%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077803_p873025824211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="68.78999999999999%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_a692d3cd97b464aed90ba6d841900a4a5">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="15.76%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.45%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.78999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dli_02_0127__p12841111193519"><strong id="dli_02_0127__b40207154441045">Definition</strong></p>
|
|
<p id="dli_02_0127__p18513202722714">Project ID, which is used for resource isolation. For how to obtain a project ID, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
<p id="dli_02_0127__p476513559276">Example: <strong id="dli_02_0127__b4207689044286">48cc2c48765f481480c7db940d6409d1</strong></p>
|
|
<p id="dli_02_0127__p1779921913513"><strong id="dli_02_0127__b17597641241039">Constraints</strong></p>
|
|
<p id="dli_02_0127__p16166233143510">None</p>
|
|
<p id="dli_02_0127__p19789423113517"><strong id="dli_02_0127__b12183415841022">Range</strong></p>
|
|
<p id="dli_02_0127__p20527112713361">The value can contain 1 to 64 characters. Only letters and digits are allowed.</p>
|
|
<p id="dli_02_0127__p1049772653519"><strong id="dli_02_0127__b15624088914756">Default Value</strong></p>
|
|
<p id="dli_02_0127__p6928441113513">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0127__en-us_topic_0103345065_row40002247161527"><td class="cellrowborder" valign="top" width="15.76%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dli_02_0127__en-us_topic_0103345065_p11474470161527">batch_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.45%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dli_02_0127__en-us_topic_0103345065_p57016873161527">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="68.78999999999999%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dli_02_0127__p1765413361252"><strong id="dli_02_0127__b165797952241045">Definition</strong></p>
|
|
<p id="dli_02_0127__p1581524272518">ID of a batch processing job. For details about how to obtain an ID, see <strong id="dli_02_0127__b1682173513529">appId</strong> in the response parameters in <a href="dli_02_0125.html">Listing Batch Processing Jobs</a>.</p>
|
|
<p id="dli_02_0127__en-us_topic_0103345065_p54964009161527">Example: <strong id="dli_02_0127__b7274971037507">0a324461-d9d9-45da-a52a-3b3c7a3d809e</strong></p>
|
|
<p id="dli_02_0127__p11654636162511"><strong id="dli_02_0127__b180058241441039">Constraints</strong></p>
|
|
<p id="dli_02_0127__p1735891916185">The parameter value must be a string matching the regular expression <strong id="dli_02_0127__b4359173135413">^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$</strong>.</p>
|
|
<p id="dli_02_0127__p1765453622511"><strong id="dli_02_0127__b1824803141105039">Range</strong></p>
|
|
<p id="dli_02_0127__p765415362252">None</p>
|
|
<p id="dli_02_0127__p1654103622516"><strong id="dli_02_0127__b98526234756">Default Value</strong></p>
|
|
<p id="dli_02_0127__p1865411360253">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_section20458182103"><h4 class="sectiontitle">Request Parameters</h4><p id="dli_02_0127__en-us_topic_0103345065_p58350097161541">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_table1391425172812" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_row239272520282"><th align="left" class="cellrowborder" valign="top" width="13.850000000000001%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_p73934250283">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.55%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0127__p191861152613">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.690000000000001%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_p93931525182819">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="63.91%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_p339412542814">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0127__en-us_topic_0103345065_row30137760152012"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0127__en-us_topic_0103345065_p49479537152012">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.55%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0127__p111861216263">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.690000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0127__en-us_topic_0103345065_p48419590152012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0127__p11719954112512"><strong id="dli_02_0127__b12178787341045">Definition</strong></p>
|
|
<p id="dli_02_0127__en-us_topic_0103345065_p63477238162016">ID of a batch processing job, which is in the universal unique identifier (UUID) format.</p>
|
|
<p id="dli_02_0127__p13719135492513"><strong id="dli_02_0127__b63417896141022">Range</strong></p>
|
|
<p id="dli_02_0127__p11719135472511">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0127__en-us_topic_0103345065_row40631342152012"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0127__en-us_topic_0103345065_p22373378152012">state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.55%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0127__p7186171142614">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.690000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0127__en-us_topic_0103345065_p304348152012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="63.91%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0127__p1992718562252"><strong id="dli_02_0127__b149658022641045">Definition</strong></p>
|
|
<p id="dli_02_0127__en-us_topic_0103345065_p24652218152012">Status of a batch processing job</p>
|
|
<p id="dli_02_0127__p7927175611253"><strong id="dli_02_0127__b18268626341022">Range</strong></p>
|
|
<ul id="dli_02_0127__ul13424183714610"><li id="dli_02_0127__li542419373461"><strong id="dli_02_0127__b116871718132746">starting</strong>: A job is being started.</li><li id="dli_02_0127__li542483711469"><strong id="dli_02_0127__b87684586632747">running</strong>: A job is being executed.</li><li id="dli_02_0127__li442415372469"><strong id="dli_02_0127__b136485210232750">dead</strong>: A session has exited.</li><li id="dli_02_0127__li144241137124613"><strong id="dli_02_0127__b7700041432754">success</strong>: A session is successfully stopped.</li><li id="dli_02_0127__li242513377464"><strong id="dli_02_0127__b5170999633281">recovering</strong>: A job is being restored.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0127__p6101181617111">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__en-us_topic_0103345065_en-us_topic_0102902523_section17446171164041"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0127__en-us_topic_0103345065_screen61630058162057">{"id":"0a324461-d9d9-45da-a52a-3b3c7a3d809e","state":"Success"}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0127__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0127__tb12870f1c5f24b27abd55ca24264af36">Table 3</a> describes status codes.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0127__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0127__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status codes</caption><thead align="left"><tr id="dli_02_0127__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0127__ab49d21f312644072a331f43e92baf853">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0127__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0127__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0127__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0127__p104431642124811">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0127__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0127__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0127__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0127__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0127__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0127__p953813124249">Internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0127__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0127__p420584425712">If an error occurs when this API is called, the system does not return the result similar to the preceding example, but returns an error code and error message. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0109.html">Spark Job-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|