forked from docs/doc-exports
Yang, Tong
bd2b57f749
Reviewed-by: gtema <artem.goncharov@gmail.com> Co-authored-by: Yang, Tong <yangtong2@huawei.com> Co-committed-by: Yang, Tong <yangtong2@huawei.com>
185 lines
12 KiB
HTML
185 lines
12 KiB
HTML
<a name="mrs_02_0045"></a><a name="mrs_02_0045"></a>
|
|
|
|
<h1 class="topictitle1">Querying Job Object Details</h1>
|
|
<div id="body1484210107928"><div class="section" id="mrs_02_0045__section40666287163540"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0045__p39994334163542">This API is used to query detailed information about a job object. This API is compatible with Sahara.</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0045__section25682805163556"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0045__ul2095591163640"><li id="mrs_02_0045__li10997729163640">Format<p id="mrs_02_0045__p53372870163653"><a name="mrs_02_0045__li10997729163640"></a><a name="li10997729163640"></a>GET /v1.1/{project_id}/jobs/{job_id}</p>
|
|
</li><li id="mrs_02_0045__li17220269163646">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0045__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0045__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_0045__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_0045__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_0045__p11454278194812">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0045__row12931900144556"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0045__p40851019144556">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_0045__p20598275144556">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_0045__p57847563144556">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_0045__row5348473617029"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0045__p3729636117029">job_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_0045__p110643517029">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_0045__p2251243817029">Job object ID</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0045__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0045__p1842961591514"><strong id="mrs_02_0045__b139822112354">Request parameters</strong></p>
|
|
<p id="mrs_02_0045__p106160258151">None</p>
|
|
</div>
|
|
<div class="section" id="mrs_02_0045__section38599577193858"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0045__table5154210817547" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameter description</caption><thead align="left"><tr id="mrs_02_0045__row5182537317547"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.2.2.4.1.1"><p id="mrs_02_0045__p3710571317547">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_0045__p4673655817547">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_0045__p2756483917547">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0045__row2282909519515"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p511042419522">tenant_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p4216874019522">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__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_0045__row4628798119532"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p4662995419539">created_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p5692937519539">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p4787664819539">Job object creation time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row3275478619555"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p277685231966">id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p558238521966">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p254381651966">Job object ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row394775811961"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p223764941966">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p450946541966">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p287883401966">Job object name</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row539121719625"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p3343201519749">updated_at</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p3568595119749">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p488090119749">Job object update time</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row134024519637"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p6560074719645">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p3735645219645">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p597380019645">Job object description</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row2196179617822"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p342696619659">interface</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p285542119659">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p2996254519659">User-defined interface set</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row2742286517547"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p10630271977">libs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p623086031977">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p138320451977">Dependency package set of a job object</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row3736230917853"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p293931571964">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p77970001964">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p397013291964">Job object type</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row1786102519722"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p787637119758">mains</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p305111719758">Array</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p4581390619758">Executable program set of a job object</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="mrs_02_0045__row1938744719726"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.1 "><p id="mrs_02_0045__p4919799719740">is_protected</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.2.2.4.1.2 "><p id="mrs_02_0045__p6153381419740">Bool</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.2.4.1.3 "><p id="mrs_02_0045__p1818301319740">Whether a job object is protected</p>
|
|
<ul id="mrs_02_0045__ul27945944162458"><li id="mrs_02_0045__li50186912162458">true</li><li id="mrs_02_0045__li49029031162458">false</li></ul>
|
|
<p id="mrs_02_0045__p38608103162458">The current version does not support this function.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="mrs_02_0045__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0045__ul1958913536182"><li id="mrs_02_0045__li1558945321814">Example request<p id="mrs_02_0045__p8671133419191"><a name="mrs_02_0045__li1558945321814"></a><a name="li1558945321814"></a>None</p>
|
|
</li><li id="mrs_02_0045__li543710159193">Example response<pre class="screen" id="mrs_02_0045__screen5126886519434">{
|
|
"job": {
|
|
"name": "my-mapreduce-job",
|
|
"type": "MapReduce",
|
|
"description": "This is the Map Reduce job template",
|
|
"mains": [],
|
|
"libs": [
|
|
{
|
|
"name": "my-job-binary-666",
|
|
"url": "/simple/mapreduce/program",
|
|
"description": "this is the job binary template",
|
|
"id": "2628d0e4-6109-4a09-a338-c4ee1b0963ed",
|
|
"tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
|
|
"is_public": false,
|
|
"is_protected": false,
|
|
"extra": null
|
|
}
|
|
],
|
|
"created_at": "2017-06-22T09:39:13",
|
|
"updated_at": "2017-06-22T09:39:13",
|
|
"id": "38a04cba-c113-4868-b11f-f50e8b1bf252",
|
|
"tenant_id": "5a3314075bfa49b9ae360f4ecd333695",
|
|
"is_public": false,
|
|
"is_protected": false,
|
|
"interface": []
|
|
}
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="mrs_02_0045__section7365446163631"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0045__p5547365016031"><a href="#mrs_02_0045__table1584477916050">Table 3</a> describes the status code of this API.</p>
|
|
|
|
<div class="tablenoborder"><a name="mrs_02_0045__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0045__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Status code</caption><thead align="left"><tr id="mrs_02_0045__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0045__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_0045__p1158961516050">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="mrs_02_0045__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0045__p6022194016050">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0045__p4613894216050">The job object details are queried successfully.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="mrs_02_0045__p1794132425219">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_0039.html">Job Object APIs (V1, Not Recommended)</a></div>
|
|
</div>
|
|
</div>
|
|
|