doc-exports/docs/mrs/api-ref/mrs_02_0051.html
Yang, Tong bd2b57f749 MRS API 2.0.38.SP20 version
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
2022-11-16 15:06:08 +00:00

265 lines
18 KiB
HTML

<a name="mrs_02_0051"></a><a name="mrs_02_0051"></a>
<h1 class="topictitle1">Querying Job Execution Object Details</h1>
<div id="body1484191679550"><div class="section" id="mrs_02_0051__section5957478711297"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0051__p49124064112911">This API is used to query detailed information about a job execution object. This API is compatible with Sahara.</p>
</div>
<div class="section" id="mrs_02_0051__section9153250112933"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0051__ul3299804811311"><li id="mrs_02_0051__li3701617811311">Format<p id="mrs_02_0051__p12501438113122"><a name="mrs_02_0051__li3701617811311"></a><a name="li3701617811311"></a>GET /v1.1/{project_id}/job-executions/{job_execution_id}</p>
</li><li id="mrs_02_0051__li25932619113111">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0051__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0051__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_0051__p16571835194812">Parameter</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_0051__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_0051__p11454278194812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0051__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0051__p3492262515356">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_0051__p1016041415356">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_0051__p1768719515356">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_0051__row20659256153330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0051__p14068949143358">job_execution_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_0051__p36449896143358">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_0051__p59095518143358">Job execution object ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_0051__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0051__p1842961591514"><strong id="mrs_02_0051__b139822112354">Request parameters</strong></p>
<p id="mrs_02_0051__p106160258151">None.</p>
</div>
<div class="section" id="mrs_02_0051__section38599577193858"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0051__table51257841151049" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0051__row8480851151049"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0051__p15860319151049">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_0051__p40813771151049">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_0051__p17581180151049">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0051__row6726034151222"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p13817546144526">info</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p30606123144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p60102458144812">Key-value pair set, containing job running information returned by Oozie</p>
</td>
</tr>
<tr id="mrs_02_0051__row1794513155918"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p6661651144526">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p31721435144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p59713193144812">Cluster ID</p>
</td>
</tr>
<tr id="mrs_02_0051__row23363161601"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p24505987144526">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p39477276144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p44374042144812">Job ID</p>
</td>
</tr>
<tr id="mrs_02_0051__row3699425711725"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p2908760411735">engine_job_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p5327575811735">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p2036912311735">Workflow ID of Oozie</p>
</td>
</tr>
<tr id="mrs_02_0051__row52664138135611"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p13907076144526">oozie_job_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p56340641144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p2204786144812">Workflow ID returned by Oozie</p>
</td>
</tr>
<tr id="mrs_02_0051__row15896716111552"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p4820169144526">tenant_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p1702693144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p1499019144114">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_0051__row14374745135652"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p24242445144526">created_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p33303851144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p60295112144812">Job execution object creation time</p>
</td>
</tr>
<tr id="mrs_02_0051__row26626414135718"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p23111379144526">updated_at</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p52207806144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p65939764144812">Job execution object update time</p>
</td>
</tr>
<tr id="mrs_02_0051__row12439792135751"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p3870758144526">start_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p8765234144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p20141538144812">Job start time</p>
</td>
</tr>
<tr id="mrs_02_0051__row62845631135831"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p3210842144526">end_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p14513632144557">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p53449181144812">Job end time</p>
</td>
</tr>
<tr id="mrs_02_0051__row8652083151249"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p35508397144628">return_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p4796924214477">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p41312377144812">Response code after job execution</p>
</td>
</tr>
<tr id="mrs_02_0051__row12228393151256"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p48708808144628">input_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p2298335114477">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p51951887144812">Input data source ID of a job execution object</p>
</td>
</tr>
<tr id="mrs_02_0051__row4987054814430"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p8132410144628">output_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p4217960116818">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p23526852144812">Output data source ID of a job execution object</p>
</td>
</tr>
<tr id="mrs_02_0051__row2224933814447"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p22947053144628">is_protected</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p11644244144713">Bool</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p38315074144812">Whether a job execution object is protected</p>
<ul id="mrs_02_0051__ul3872134516111"><li id="mrs_02_0051__li1294778516111">true</li><li id="mrs_02_0051__li4942120716111">false</li></ul>
<p id="mrs_02_0051__p4213768316111">The current version does not support this function.</p>
</td>
</tr>
<tr id="mrs_02_0051__row16657075144831"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p5285514144839">is_public</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p36146066144831">Bool</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p4609155144939">Whether a job execution object is public</p>
<ul id="mrs_02_0051__ul46123066163139"><li id="mrs_02_0051__li12454415163139">true</li><li id="mrs_02_0051__li44980875163139">false</li></ul>
<p id="mrs_02_0051__p2174695163139">The current version does not support this function.</p>
</td>
</tr>
<tr id="mrs_02_0051__row21026887144831"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p27934653144839">job_configs</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p35577089144831">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p18799330153318">Key-value pair set for saving job running configurations</p>
<p id="mrs_02_0051__p4630887144939">For details, see <a href="#mrs_02_0051__table2159451151623">Table 3</a>.</p>
</td>
</tr>
<tr id="mrs_02_0051__row65803519144414"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p30376291144839">data_source_urls</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p52405738144713">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p20473823144939">Data source URL of a job execution object</p>
</td>
</tr>
<tr id="mrs_02_0051__row42012596144424"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0051__p65500602144839">Id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0051__p32531313144713">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0051__p27249228144939">Job execution object ID</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="mrs_02_0051__table2159451151623"></a><a name="table2159451151623"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0051__table2159451151623" frame="border" border="1" rules="all"><caption><b>Table 3 </b><strong id="mrs_02_0051__b1042734323313">job_configs</strong> parameter description</caption><thead align="left"><tr id="mrs_02_0051__row39264552151623"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="mrs_02_0051__p26312167151623">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_0051__p30132362151623">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_0051__p24802238151623">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0051__row62824255151623"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0051__p6619242151712">configs</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0051__p54007068151623">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0051__p60121498151741">Key-value pair set configured for a job</p>
</td>
</tr>
<tr id="mrs_02_0051__row45358292151623"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0051__p60698656151712">args</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0051__p20654414151623">Array</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0051__p6484022151741">List of arguments</p>
</td>
</tr>
<tr id="mrs_02_0051__row24682943151623"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="mrs_02_0051__p24579100151712">params</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="mrs_02_0051__p26950389151623">Object</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="mrs_02_0051__p29231764151741">Key-value pair set for running a job</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="mrs_02_0051__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0051__ul1958913536182"><li id="mrs_02_0051__li1558945321814">Example request<p id="mrs_02_0051__p8671133419191"><a name="mrs_02_0051__li1558945321814"></a><a name="li1558945321814"></a>None.</p>
</li><li id="mrs_02_0051__li543710159193">Example response<pre class="screen" id="mrs_02_0051__screen33783054143637">{
"job_execution": {
"created_at": "2017-06-22T06:23:51",
"updated_at": "2017-06-22T06:23:51",
"id": "852042ea-a32c-424b-aacf-df2e6d6642b5",
"tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
"job_id": "",
"start_time": "2017-06-22T06:23:51",
"end_time": null,
"cluster_id": "33dff020-7f96-4270-9c3a-88b99627f6e2",
"oozie_job_id": null,
"return_code": null,
"input_id": null,
"output_id": null,
"is_protected": false,
"is_public": null,
"engine_job_id": null,
"job_configs": null,
"data_source_urls": null,
"info": null
}
}</pre>
</li></ul>
</div>
<div class="section" id="mrs_02_0051__section25088328113020"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0051__p5547365016031"><a href="#mrs_02_0051__table1584477916050">Table 4</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="mrs_02_0051__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0051__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status code</caption><thead align="left"><tr id="mrs_02_0051__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0051__p3411176516050">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0051__p1158961516050">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0051__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0051__p6022194016050">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0051__p4613894216050">The job execution object details are queried successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="mrs_02_0051__p1981155645211">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0049.html">Job Execution Object APIs (V1, Not Recommended)</a></div>
</div>
</div>