forked from docs/doc-exports
Yang, Tong
9d3e5175d0
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
340 lines
30 KiB
HTML
340 lines
30 KiB
HTML
<a name="mrs_02_0087"></a><a name="mrs_02_0087"></a>
|
|
|
|
<h1 class="topictitle1">Querying a List of Jobs</h1>
|
|
<div id="body1561793573950"><div class="section" id="mrs_02_0087__section4408504619327"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0087__p5843728119329">This API is used to query the job list in an MRS cluster.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0087__section10186656193217"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0087__ul2809877319471"><li id="mrs_02_0087__li5177607319471">Format<p id="mrs_02_0087__p13487154112211"><a name="mrs_02_0087__li5177607319471"></a><a name="li5177607319471"></a>GET /v2/{project_id}/clusters/{cluster_id}/job-executions</p>
|
|
</li><li id="mrs_02_0087__li2957566119471">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0087__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="mrs_02_0087__en-us_topic_0176713997_row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0087__en-us_topic_0176713997_p16571835194812">Name</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0087__en-us_topic_0176713997_p141410194812">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0087__en-us_topic_0176713997_p11454278194812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0087__en-us_topic_0176713997_row39786771142917"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176713997_p1503055142917">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176713997_p54638598142917">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176713997_p63650338142917">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176713997_row3457216201210"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176713997_p194589160122">cluster_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176713997_p045813165125">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176713997_p1845891641218">Cluster ID. For details on how to obtain the cluster ID, see <a href="mrs_02_0091.html#mrs_02_0091__section177891315153619">Obtaining a Cluster ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0087__section673761354213"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0087__table46210785193317" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameter description</caption><thead align="left"><tr id="mrs_02_0087__row34262165193317"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.3.2.2.5.1.1"><p id="mrs_02_0087__p12621391193317">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.2"><p id="mrs_02_0087__p15699711193317">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.3.2.2.5.1.3"><p id="mrs_02_0087__p562413019313">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="45%" id="mcps1.3.3.2.2.5.1.4"><p id="mrs_02_0087__p63717051193317">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0087__row123786413298"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p62016791102743">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p57304145102743">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p277864793547">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p29070416105535">Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row36582554193317"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p10396884193317">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p36841295193317">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p346461129313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p32476122205057">Type of a job.</p>
|
|
<ul id="mrs_02_0087__ul5947149515590"><li id="mrs_02_0087__en-us_topic_0176713997_li6488797415590">MapReduce</li><li id="mrs_02_0087__en-us_topic_0176713997_li5869295015590">SparkSubmit</li><li id="mrs_02_0087__en-us_topic_0176713997_li1378917415590">HiveScript</li><li id="mrs_02_0087__en-us_topic_0176713997_li802328715590">HiveSql</li><li id="mrs_02_0087__en-us_topic_0176713997_li33888041111020">DistCp, importing and exporting data</li><li id="mrs_02_0087__en-us_topic_0176713997_li48044655111024">SparkScript</li><li id="mrs_02_0087__en-us_topic_0176713997_li7152765111027">SparkSql</li><li id="mrs_02_0087__en-us_topic_0176713997_li356874719148">Flink</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row57932449102743"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p651819462374">job_state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p62009911389">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p55181346153710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p19518746103716">Execution status of a job.</p>
|
|
<ul id="mrs_02_0087__ul78901461383"><li id="mrs_02_0087__li15604174916382"><strong id="mrs_02_0087__b595914457375">FAILED</strong>: indicates that the job fails to be executed.</li><li id="mrs_02_0087__li1248675273819"><strong id="mrs_02_0087__b16527105443719">KILLED</strong>: indicates that the job is terminated.</li><li id="mrs_02_0087__li107931014396"><strong id="mrs_02_0087__b164941157183711">New</strong>: indicates that the job is created.</li><li id="mrs_02_0087__li9837050393"><strong id="mrs_02_0087__b9727551382">NEW_SAVING</strong>: indicates that the job has been created and is being saved.</li><li id="mrs_02_0087__li6282913398"><strong id="mrs_02_0087__b12002317395">SUBMITTED</strong>: indicates that the job is submitted.</li><li id="mrs_02_0087__li4972101003915"><strong id="mrs_02_0087__b171161926113914">ACCEPTED</strong>: indicates that the job is accepted.</li><li id="mrs_02_0087__li8221111516393"><strong id="mrs_02_0087__b132630124316">RUNNING</strong>: indicates that the job is running.</li><li id="mrs_02_0087__li1879811547380"><strong id="mrs_02_0087__b510618694011">FINISHED</strong>: indicates that the job is completed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row029134321010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p129174314106">job_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p1829116436102">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p1829117436101">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p611416781112">Execution result of a job.</p>
|
|
<ul id="mrs_02_0087__ul375917235111"><li id="mrs_02_0087__li4570026101110"><strong id="mrs_02_0087__b5962144484014">FAILED</strong>: indicates that the job fails to be executed.</li><li id="mrs_02_0087__li5918102912116"><strong id="mrs_02_0087__b220555515416">KILLED</strong>: indicates that the job is manually terminated during execution.</li><li id="mrs_02_0087__li13168123601111"><strong id="mrs_02_0087__b15303108425">UNDEFINED</strong>: indicates that the job is being executed.</li><li id="mrs_02_0087__li1759162381115"><strong id="mrs_02_0087__b5686110134310">SUCCEEDED</strong>: indicates that the job has been successfully executed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row430511374254"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p9518946143713">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p1655671116384">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p351964633713">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p18408134471714">Number of records displayed on each page in the returned result. The default value is <strong id="mrs_02_0087__b1297328164313">10</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row1688911377259"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p651934617378">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p299715158386">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p14519144612377">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p11238166414">Offset.</p>
|
|
<p id="mrs_02_0087__p463219421175">The default offset from which the job list starts to be queried is <strong id="mrs_02_0087__b26642615332">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row4788257010284"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p17519144620374">sort_by</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p538231823816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p16519124612374">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p175272884110">Ranking mode of returned results. The default value is <strong id="mrs_02_0087__b10131195717437">desc</strong>.</p>
|
|
<ul id="mrs_02_0087__ul74481310134119"><li id="mrs_02_0087__li18581151444114"><strong id="mrs_02_0087__b27942384416">asc</strong>: indicates that the returned results are ranked in ascending order.</li><li id="mrs_02_0087__li24481010114118"><strong id="mrs_02_0087__b3258634104416">desc</strong>: indicates that the returned results are ranked in descending order.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row57271515193014"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p86221430133318">submitted_time_begin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p19601820113812">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p651914467376">TimeStamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p051994616375">UTC timestamp after which a job is submitted, in milliseconds. For example, 1562032041362.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row22945661205631"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.3.2.2.5.1.1 "><p id="mrs_02_0087__p8622830113313">submitted_time_end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.2 "><p id="mrs_02_0087__p3207122223815">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.3.2.2.5.1.3 "><p id="mrs_02_0087__p151954693715">TimeStamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="45%" headers="mcps1.3.3.2.2.5.1.4 "><p id="mrs_02_0087__p5519346193718">UTC timestamp before which a job is submitted, in milliseconds. For example, 1562032041362.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0087__section775516131425"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0087__table12040613193927" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0087__row8843854193927"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0087__p45263556193927">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.2"><p id="mrs_02_0087__p1907984993927">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.2.4.1.3"><p id="mrs_02_0087__p17473879193927">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0087__row8387056194027"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0087__p14121183010424">total_record</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0087__p1812143074216">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0087__p112123064210">Total number of jobs</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__row19100834201113"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0087__p1612153074218">job_list</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0087__p121445122811">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0087__p14121203094215">Job list. For details about the parameter, see <a href="#mrs_02_0087__table9145123857">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0087__table9145123857"></a><a name="table9145123857"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0087__table9145123857" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Job parameter description</caption><thead align="left"><tr id="mrs_02_0087__en-us_topic_0176790808_row8843854193927"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="mrs_02_0087__en-us_topic_0176790808_p45263556193927">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="mrs_02_0087__en-us_topic_0176790808_p1907984993927">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="mrs_02_0087__en-us_topic_0176790808_p17473879193927">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0087__en-us_topic_0176790808_row8387056194027"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p52943541117">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p12125168101212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p6329191671215">Job ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row19100834201113"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p1029418549112">user</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p512508201214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p183294166123">Name of the user who submits a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row1850318495114"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p12294125416119">job_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p191251789127">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p153291516111218">Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row1910618551609"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p1341817597018">job_result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p12418185915018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p741885912014">Final result of a job.</p>
|
|
<ul id="mrs_02_0087__en-us_topic_0176790808_ul141131420762"><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li4570026101110"><strong id="mrs_02_0087__b1773516743">FAILED</strong>: indicates that the job fails to be executed.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li5918102912116"><strong id="mrs_02_0087__b920231660">KILLED</strong>: indicates that the job is manually terminated during execution.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li13168123601111"><strong id="mrs_02_0087__b1933887155">UNDEFINED</strong>: indicates that the job is being executed.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li1759162381115"><strong id="mrs_02_0087__b1657596635">SUCCEEDED</strong>: indicates that the job has been successfully executed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row128711949131111"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p16294105413112">job_state</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p11261885121">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p232941614125">Execution status of a job.</p>
|
|
<ul id="mrs_02_0087__en-us_topic_0176790808_ul83814473515"><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li15604174916382"><strong id="mrs_02_0087__b29685136">FAILED</strong>: indicates that the job fails to be executed.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li1248675273819"><strong id="mrs_02_0087__b566564214">KILLED</strong>: indicates that the job is terminated.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li107931014396"><strong id="mrs_02_0087__b1330933442">New</strong>: indicates that the job is created.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li9837050393"><strong id="mrs_02_0087__b1261077567">NEW_SAVING</strong>: indicates that the job has been created and is being saved.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li6282913398"><strong id="mrs_02_0087__b407401415">SUBMITTED</strong>: indicates that the job is submitted.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li4972101003915"><strong id="mrs_02_0087__b1441824946">ACCEPTED</strong>: indicates that the job is accepted.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li8221111516393"><strong id="mrs_02_0087__b68408284">RUNNING</strong>: indicates that the job is running.</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0177065249_li1879811547380"><strong id="mrs_02_0087__b597791895">FINISHED</strong>: indicates that the job is completed.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row11227205011116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p16294105418112">job_progress</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p612614821210">Float</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p832915169122">Job execution progress.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row11400175061120"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p729415401114">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p13126198181216">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p532941620128">Type of a job.</p>
|
|
<ul id="mrs_02_0087__en-us_topic_0176790808_ul58695132184"><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li6488797415590">MapReduce</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li5869295015590">SparkSubmit</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li1378917415590">HiveScript</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li802328715590">HiveSql</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li33888041111020">DistCp, importing and exporting data</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li48044655111024">SparkScript</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li7152765111027">SparkSql</li><li id="mrs_02_0087__en-us_topic_0176790808_en-us_topic_0176713997_li356874719148">Flink</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row12272193451118"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p1629585451114">started_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p1612698121215">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p1433061611218">Start time to run a job. Unit: milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row139751543313"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p169751343516">submitted_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p1497516434114">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p169754431714">Time when a job is submitted. Unit: milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row24471734181115"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p13295554131120">finished_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p1012618817121">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p1333011651212">End time to run a job. Unit: milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row186142034131118"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p8295135413112">elapsed_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p1612617841214">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p733061610128">Running duration of a job. Unit: milliseconds</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row6780123481117"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p62951654141119">arguments</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p51269812128">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p93301716191220">Run parameters. The parameter contains a maximum of 4,096 characters, excluding special characters such as ;|&>'<$, and can be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row4950134131116"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p18295154101116">properties</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p181261986126">Object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p1133020163121">Configuration parameter, which is used to configure <strong id="mrs_02_0087__b1681974783115018">-d</strong> parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as ><|'`&!\, and can be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row34573461227"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p103136481121">launcher_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p139311522020">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p20244195418212">Launcher job ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0087__en-us_topic_0176790808_row1687919461120"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0087__en-us_topic_0176790808_p031334815212">app_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0087__en-us_topic_0176790808_p149310528220">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0087__en-us_topic_0176790808_p1624412541822">Actual job ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0087__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0087__ul1958913536182"><li id="mrs_02_0087__li1558945321814">Example request<p id="mrs_02_0087__p83171441151516"><a name="mrs_02_0087__li1558945321814"></a><a name="li1558945321814"></a>None.</p>
|
|
</li><li id="mrs_02_0087__li543710159193">Example response<ul id="mrs_02_0087__ul1696652114255"><li id="mrs_02_0087__li2082414191252">Example of a successful response<pre class="screen" id="mrs_02_0087__screen582420196256">{
|
|
"total_record": 2,
|
|
"job_list": [{
|
|
"job_id": "981374c1-85da-44ee-be32-edfb4fba776c",
|
|
"user": "xxxx",
|
|
"job_name": "SparkSubmitTset",
|
|
"job_result": "UNDEFINED",
|
|
"job_state": "ACCEPTED",
|
|
"job_progress": 0,
|
|
"job_type": "SparkSubmit",
|
|
"started_time": 0,
|
|
"submitted_time": 1564714763119,
|
|
"finished_time": 0,
|
|
"elapsed_time": 0,
|
|
"queue": "default",
|
|
"arguments": "[--class, --driver-memory, --executor-cores, --master, yarn-cluster, obs://obs-test/hadoop-mapreduce-examples-3.1.1.jar, dddd]",
|
|
"launcher_id": "application_1564622673393_0613",
|
|
"properties": "{}"
|
|
},
|
|
{
|
|
"job_id": "c54c8aa0-c277-4f83-8acc-521d85cfa32b",
|
|
"user": "xxxx",
|
|
"job_name": "SparkSubmitTset2",
|
|
"job_result": "UNDEFINED",
|
|
"job_state": "ACCEPTED",
|
|
"job_progress": 0,
|
|
"job_type": "SparkSubmit",
|
|
"started_time": 0,
|
|
"submitted_time": 1564714020099,
|
|
"finished_time": 0,
|
|
"elapsed_time": 0,
|
|
"queue": "default",
|
|
"arguments": "[--conf, yujjsjhe, --driver-memory, yueujdjjd, --master, yarn-cluster, obs://obs-test/hadoop-mapreduce-examples-3.1.1.jar]",
|
|
"launcher_id": "application_1564622673393_0611",
|
|
"properties": "{}"
|
|
}
|
|
]
|
|
}</pre>
|
|
</li><li id="mrs_02_0087__li1480742111816">Example of a failed response<pre class="screen" id="mrs_02_0087__screen9377651201811">{
|
|
"error_msg": "Failed to query the job list."
|
|
"error_code":"0166"
|
|
}</pre>
|
|
</li></ul>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0087__section4391766619434"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0087__p1693116917524">For details about status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
|
|
<div class="note" id="mrs_02_0087__note21494311288"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="mrs_02_0087__p39461794572">Generally, if status code 200 is returned, an API is successfully called. However, due to compatibility problems in earlier versions, the status code for a successful call of this API is 202. You can use status code 202 to check whether the response to this API is normal.</p>
|
|
</div></div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0084.html">Job Object APIs (V2)</a></div>
|
|
</div>
|
|
</div>
|
|
|