vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dli/api-ref/dli_02_0125.html
Su, Xiaomeng 2374069890 DLI API 20230215 version 
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>
2023-03-22 08:50:34 +00:00

379 lines
30 KiB
HTML
Raw Blame History

<a name="dli_02_0125"></a><a name="dli_02_0125"></a>
<h1 class="topictitle1">Obtaining the List of Batch Processing Jobs</h1>
<div id="body8662426"><div class="section" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_s1f0e4fd3d502405199f36f78e68721aa"><h4 class="sectiontitle">Function</h4><p id="dli_02_0125__en-us_topic_0103345063_p2263046315446">This API is used to obtain the list of batch processing jobs in a queue of a project.</p>
</div>
<div class="section" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_s9e1b8ec5b57c422a942b19835da7d66e"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077927_ul10082125"><li id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077927_li23630265">URI format<p id="dli_02_0125__en-us_topic_0103345063_p64364633155729"><a name="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077927_li23630265"></a><a name="en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077927_li23630265"></a>GET /v2.0/{project_id}/batches</p>
</li><li id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_li1725612218454">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="14.7985201479852%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_a420a62a594f9410eaea229ffc8037a61">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12.47875212478752%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077803_p873025824211">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.538646135386461%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0125__p136091952124513">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59.18408159184082%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_a692d3cd97b464aed90ba6d841900a4a5">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="14.7985201479852%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077803_p43412436">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="12.47875212478752%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_en-us_topic_0069077803_p26746391">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="13.538646135386461%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0125__p156091752164512">String</p>
</td>
<td class="cellrowborder" valign="top" width="59.18408159184082%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0125__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_table1944164663513" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="dli_02_0125__b1073712261276">query</strong> parameter description</caption><thead align="left"><tr id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_row29441446113518"><th align="left" class="cellrowborder" valign="top" width="16.669999999999998%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p1935161415364">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.85%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p1036131419366">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.57%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p17381114123617">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.910000000000004%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p1340121413614">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0125__row179361811164518"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p2061213862214">job_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p19612188192215">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p7612188202214">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p26123842210">Name of a batch processing job.</p>
</td>
</tr>
<tr id="dli_02_0125__row415334511453"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p1889619114563">job_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p118961165610">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p48964112568">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p12391641125611">This API is used to query a batch job based on the job ID.</p>
</td>
</tr>
<tr id="dli_02_0125__en-us_topic_0103345063_row9513420155831"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__en-us_topic_0103345063_p17740634155831">cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__en-us_topic_0103345063_p27705220155831">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__en-us_topic_0103345063_p29530330155831">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__en-us_topic_0103345063_p43146566155831">DLI queue name. If this parameter is left blank, the names of all batch processing jobs in the current project are obtained. You are advised to specify this parameter, instead of leaving it blank.</p>
</td>
</tr>
<tr id="dli_02_0125__row163915645314"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p1764018568534">queue_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p66401756205319">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p1164019565536">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p74815514545">DLI queue name. You can query batch jobs based on the queue name. This method is recommended.</p>
</td>
</tr>
<tr id="dli_02_0125__row77461391386"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p474714396816">from</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p14153172916109">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p81531029171015">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p215342991010">Index number of the start batch processing job. By default, the index number starts from 0.</p>
</td>
</tr>
<tr id="dli_02_0125__row5747173912814"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p1374773914814">size</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p715313291105">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p4153192961010">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p415382961019">Number of batch processing jobs to be queried</p>
</td>
</tr>
<tr id="dli_02_0125__row2326121214587"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p9327191216582">state</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p18327612155817">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p17327171212588">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p53107491584">Query batch jobs by job status.</p>
</td>
</tr>
<tr id="dli_02_0125__row37401910182112"><td class="cellrowborder" valign="top" width="16.669999999999998%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0125__p42361218112315">owner</p>
</td>
<td class="cellrowborder" valign="top" width="11.85%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0125__p42369185233">No</p>
</td>
<td class="cellrowborder" valign="top" width="14.57%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0125__p2236121812232">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.910000000000004%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0125__p192362018142313">User who submits a job.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_section20458182103"><h4 class="sectiontitle">Request</h4><p id="dli_02_0125__p1930682375318">None</p>
</div>
<div class="section" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_sd1ecb66580054b2ea403be8b2272a2c7"><h4 class="sectiontitle">Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_table1391425172812" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameter description</caption><thead align="left"><tr id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_row239272520282"><th align="left" class="cellrowborder" valign="top" width="12.920000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p73934250283">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10.11%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0125__p187894952017">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15.620000000000001%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p93931525182819">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61.35%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_p339412542814">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0125__en-us_topic_0103345063_row41459613155918"><td class="cellrowborder" valign="top" width="12.920000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0125__en-us_topic_0103345063_p26665914155918">from</p>
</td>
<td class="cellrowborder" valign="top" width="10.11%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0125__p77814952014">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0125__en-us_topic_0103345063_p12455421155918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0125__en-us_topic_0103345063_p2256189155918">Index number of the start batch processing job.</p>
</td>
</tr>
<tr id="dli_02_0125__en-us_topic_0103345063_row56802406155918"><td class="cellrowborder" valign="top" width="12.920000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0125__en-us_topic_0103345063_p34149228155918">total</p>
</td>
<td class="cellrowborder" valign="top" width="10.11%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0125__p978114911200">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0125__en-us_topic_0103345063_p14624098155918">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0125__en-us_topic_0103345063_p43701296155918">Total number of batch processing jobs.</p>
</td>
</tr>
<tr id="dli_02_0125__en-us_topic_0103345063_row6311378155918"><td class="cellrowborder" valign="top" width="12.920000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0125__en-us_topic_0103345063_p48643967155918">sessions</p>
</td>
<td class="cellrowborder" valign="top" width="10.11%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0125__p779114914208">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0125__en-us_topic_0103345063_p47847217155918">Array of objects</p>
</td>
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0125__en-us_topic_0103345063_p50419384155918">Batch job information. For details, see <a href="dli_02_0124.html#dli_02_0124__en-us_topic_0103343302_en-us_topic_0102902523_table1391425172812">Table 6</a> in <a href="dli_02_0124.html">Creating a Batch Processing Job</a>.</p>
</td>
</tr>
<tr id="dli_02_0125__row13528162612711"><td class="cellrowborder" valign="top" width="12.920000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0125__p18924133202712">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="10.11%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0125__p127944916208">No</p>
</td>
<td class="cellrowborder" valign="top" width="15.620000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0125__p149301132152711">Long</p>
</td>
<td class="cellrowborder" valign="top" width="61.35%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0125__p14934143222717">Time when a batch processing job is created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0125__table6231618192312" frame="border" border="1" rules="all"><caption><b>Table 4 </b>sessions parameters</caption><thead align="left"><tr id="dli_02_0125__row15232218142312"><th align="left" class="cellrowborder" valign="top" width="21.73267326732673%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0125__p52321918132315">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.16831683168317%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0125__p1023221816231">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.693069306930692%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0125__p523251842315">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.4059405940594%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0125__p13233131819235">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0125__row142361218142312"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p32369184237">duration</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p323681852313">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p12236918162310">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p923731815236">Job running duration (unit: millisecond)</p>
</td>
</tr>
<tr id="dli_02_0125__row520661353912"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p11901023203911">id</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p16190923133914">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p12190122318398">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p10191223163914">ID of a batch processing job.</p>
</td>
</tr>
<tr id="dli_02_0125__row1820661317393"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p188501428113916">state</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p3850102811399">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p12850142819398">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p168501928163918">Status of a batch processing job</p>
</td>
</tr>
<tr id="dli_02_0125__row536019163392"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p167719329398">appId</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p27711532153916">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p1777112322394">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p1377143223912">Back-end application ID of a batch processing job</p>
</td>
</tr>
<tr id="dli_02_0125__row20763744153915"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p1855874833919">log</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p12558114820396">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p14558184823911">Array of Strings</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p155894814391">Last 10 records of the current batch processing job</p>
</td>
</tr>
<tr id="dli_02_0125__row1763174419398"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p1729195443913">sc_type</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p2729195453917">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p57291548398">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p573095413395">Type of a computing resource. If the computing resource type is customized, value <strong id="dli_02_0125__b1185533145320">CUSTOMIZED</strong> is returned.</p>
</td>
</tr>
<tr id="dli_02_0125__row77639448399"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p202241043409">cluster_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p1722416416408">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p172241543407">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p172241746402">Queue where a batch processing job is located.</p>
</td>
</tr>
<tr id="dli_02_0125__row11360151612395"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p33881483402">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p1838818144014">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p143883814018">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p838888114013">Time when a batch processing job is created. The timestamp is in milliseconds.</p>
</td>
</tr>
<tr id="dli_02_0125__row4369182624016"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p20193122714015">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p1919352724013">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p1719352764013">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p7193202715407">Name of a batch processing job.</p>
</td>
</tr>
<tr id="dli_02_0125__row2106174319407"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p8522115234019">owner</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p15522252184017">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p9522195215401">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p95227524402">Owner of a batch processing job.</p>
</td>
</tr>
<tr id="dli_02_0125__row15107643184017"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__en-us_topic_0103343292_en-us_topic_0102902454_p85671734141718">proxyUser</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p071791122914">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__en-us_topic_0103343292_en-us_topic_0102902454_p13567183431711">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__en-us_topic_0103343292_en-us_topic_0102902454_p6567133420178">Proxy user (resource tenant) to which a batch processing job belongs.</p>
</td>
</tr>
<tr id="dli_02_0125__row191071643174019"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p1678212216416">kind</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p18782427417">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p978222194110">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p47823274114">Type of a batch processing job. Only Spark parameters are supported.</p>
</td>
</tr>
<tr id="dli_02_0125__row81451614413"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p87331612114110">queue</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p07332127413">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p2073316128415">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p2733151217411">Queue where a batch processing job is located.</p>
</td>
</tr>
<tr id="dli_02_0125__row1298011248415"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p117141830194114">image</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p16714930104120">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p1771453019414">String</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p4714130184116">Custom image. The format is <strong id="dli_02_0125__b678046195720">Organization name/Image name:Image version</strong>.</p>
<p id="dli_02_0125__p8714123012411">This parameter is valid only when <span class="parmname" id="dli_02_0125__parmname1752165614577"><b>feature</b></span> is set to <span class="parmvalue" id="dli_02_0125__parmvalue6752056165716"><b>custom</b></span>. You can use this parameter with the <span class="parmname" id="dli_02_0125__parmname136584597574"><b>feature</b></span> parameter to specify a user-defined Spark image for job running.</p>
</td>
</tr>
<tr id="dli_02_0125__row1498082434113"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0125__p17530154214416">update_time</p>
</td>
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0125__p1253064294110">No</p>
</td>
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0125__p95301642184118">Long</p>
</td>
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0125__p20530154284119">Time when a batch processing job is updated. The timestamp is in milliseconds.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0125__section1217010661112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0125__p6101181617111">None</p>
</div>
<div class="section" id="dli_02_0125__en-us_topic_0103345063_en-us_topic_0102902523_section17446171164041"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0125__en-us_topic_0103345063_screen43378887161228">{
"from": 0,
"total": 1,
"sessions": [
{
"id": "178fa687-2e8a-41ed-a439-b00de60bb176",
"state": "dead",
"appId": null,
"log": [
"stdout: ",
"stderr: ",
"YARN Diagnostics: "
],
"sc_type": "A",
"cluster_name": "test",
"create_time": 1531906043036
}
]
}</pre>
</div>
<div class="section" id="dli_02_0125__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0125__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0125__tb12870f1c5f24b27abd55ca24264af36">Table 5</a> describes the status code.</p>
<div class="tablenoborder"><a name="dli_02_0125__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0125__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0125__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0125__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_0125__aea1d3bd107bb4c499da79a88832d256c">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dli_02_0125__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0125__a3153e07b3a9749adba92599fe6628fbf">200</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0125__p104431642124811">The query is successful.</p>
</td>
</tr>
<tr id="dli_02_0125__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0125__p184941532219">400</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0125__p2049413539219">Request error.</p>
</td>
</tr>
<tr id="dli_02_0125__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0125__p5537171216249">500</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0125__p953813124249">Internal service error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="dli_02_0125__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0125__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0162.html">Batch Processing-related APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink