forked from docs/doc-exports
Xiong, Chen Xiao
f2733178cc
Reviewed-by: Kacur, Michal <michal.kacur@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
266 lines
26 KiB
HTML
266 lines
26 KiB
HTML
<a name="dataartsstudio_02_0086"></a><a name="dataartsstudio_02_0086"></a>
|
|
|
|
<h1 class="topictitle1">Viewing a Job List</h1>
|
|
<div id="body0000001104494738"><div class="section" id="dataartsstudio_02_0086__en-us_topic_0181281338_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1912913467404">This API is used to query a list of batch or real-time jobs. A maximum of 1000 jobs can be returned for each query.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0086__en-us_topic_0181281338_section7934966101819"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul145591424184717"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li356152404715">URI format<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p076674419427"><a name="dataartsstudio_02_0086__en-us_topic_0181281338_li356152404715"></a><a name="en-us_topic_0181281338_li356152404715"></a>GET /v1/{project_id}/jobs?jobType={jobType}&offset={offset}&limit={limit}&jobName={jobName}</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul44785462213"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li447155416223">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><thead align="left"><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="20.05%" id="mcps1.3.2.3.1.1.1.5.1.1"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.91%" id="mcps1.3.2.3.1.1.1.5.1.2"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.740000000000002%" id="mcps1.3.2.3.1.1.1.5.1.3"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.300000000000004%" id="mcps1.3.2.3.1.1.1.5.1.4"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.91%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="dataartsstudio_02_0314.html">Project ID and Account ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row1692125192313"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p199210512316">jobType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.91%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p149295172316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p129245172319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p23913424185">Job type.</p>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul146772016151911"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li146771716181917"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b6906162518219">REAL_TIME</strong>: real-time processing</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li141672184195"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b115821128112120">BATCH</strong>: batch processing</li></ul>
|
|
<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p84523311379">Default value: <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b1171310313212">BATCH</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row108133683113"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p790713571784">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.91%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p39074571815">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p17907957589">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="dataartsstudio_02_0086__p10817133716219">Start page of the paging list.</p>
|
|
<p id="dataartsstudio_02_0086__p1939133916211">Default value: <strong id="dataartsstudio_02_0086__b8393398218">0</strong></p>
|
|
<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1611914378613">The value must be greater than or equal to <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b19432201184813">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row129110043418"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1590718571784">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.91%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p2907175712810">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p390716571813">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="dataartsstudio_02_0086__p946383220196">The maximum number of records on each page.</p>
|
|
<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p13217857560">Value range: 1 to 100</p>
|
|
<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p190711571810">Default value: <strong id="dataartsstudio_02_0086__b880342519186">10</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row1533184185412"><td class="cellrowborder" valign="top" width="20.05%" headers="mcps1.3.2.3.1.1.1.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p143484185414">jobName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.91%" headers="mcps1.3.2.3.1.1.1.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p234104155416">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.740000000000002%" headers="mcps1.3.2.3.1.1.1.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p18342465411">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.300000000000004%" headers="mcps1.3.2.3.1.1.1.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p03410445417">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0086__en-us_topic_0181281338_section5571134133610"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0086__en-us_topic_0181281338_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_row3746915131710"><th align="left" class="cellrowborder" valign="top" width="15.010000000000002%" id="mcps1.3.3.2.2.5.1.1"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p131491731112013">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.93%" id="mcps1.3.3.2.2.5.1.2"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p3149113112204">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.73%" id="mcps1.3.3.2.2.5.1.3"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p13149173119204">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.33%" id="mcps1.3.3.2.2.5.1.4"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_row174620159179"><td class="cellrowborder" valign="top" width="15.010000000000002%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p1150183116205">workspace</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.93%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p4150531152016">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.73%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p181505317209">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.33%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0086__b663518794518">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_en-us_topic_0181281363_li788605918251">To query data in other workspaces, this header must be carried.</li></ul>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0086__en-us_topic_0181281338_section17656611145018"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0086__en-us_topic_0181281338_table19656151112506" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row1965718115501"><th align="left" class="cellrowborder" valign="top" width="21.51%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p17659111205011">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.33%" id="mcps1.3.4.2.2.5.1.2"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p565991111500">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.190000000000001%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p565913119501">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.96999999999999%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p865911125012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row18287105520520"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p628745514521">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p928710559523">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.190000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1228755515211">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p15288125555214">Number of jobs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row892530194114"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1292516018415">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p2925180114118">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.190000000000001%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p7925190164111">List<Job></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.96999999999999%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p6925170134118">Job list. For details, see <a href="#dataartsstudio_02_0086__en-us_topic_0181281338_table7546519115018">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0086__en-us_topic_0181281338_table7546519115018"></a><a name="en-us_topic_0181281338_table7546519115018"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0086__en-us_topic_0181281338_table7546519115018" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Job data structure description</caption><thead align="left"><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row14548819165015"><th align="left" class="cellrowborder" valign="top" width="21.51%" id="mcps1.3.4.3.2.5.1.1"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p25481119155014">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.45%" id="mcps1.3.4.3.2.5.1.2"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p115491919165016">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.43%" id="mcps1.3.4.3.2.5.1.3"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p255041925014">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.61%" id="mcps1.3.4.3.2.5.1.4"><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p255011916509">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row18550101910502"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p755151945010">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p115520194507">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p17553131935012">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p15553161913501">Job name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row273531513436"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1073591584317">jobType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p2735171594316">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1473511151434">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p13890935134315">Job type.</p>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul1889033517436"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li13890183554314"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b618911152210">REAL_TIME</strong>: real-time processing</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li198901935114310"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b9997101210225">BATCH</strong>: batch processing</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row16834131433820"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p283412149389">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p15834214143819">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p14834141416382">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p48344144385">Job status.</p>
|
|
<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p658753013916">When <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b12327115234914">jobType</strong> is set to <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b106081554134918">REAL_TIME</strong>, the status is as follows:</p>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul6772143154419"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li1977354364414">STARTING</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li0773164374411">NORMAL</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li5773124315447">EXCEPTION</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li277384354416">STOPPING</li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li131181154134517">STOPPED</li></ul>
|
|
<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p6703138144613">When <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b26865344500">jobType</strong> is set to <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b16872034195012">BATCH</strong>, the status is as follows:</p>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul1460816153177"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li360931514177"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b17882326122217">SCHEDULING</strong></li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li16609151517176"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b46601129162218">STOPPED</strong></li><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li166091715171717"><strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b187641931162215">PAUSED</strong></li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row1023031917315"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p20231121915318">createUser</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p2023161918318">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p123113191436">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p14231171913311">Job creator.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row47301740733"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p873004012310">createTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p37301040530">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p07301640938">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1173034012310">Time when the job is created.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row88045531632"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p158049534315">startTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p280416539313">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p9804165311313">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p88048531534">Time when the job starts to run.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row46931705420"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p8694405415">endTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p769419019420">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p126941506412">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1486973317513">Time when the job stops to run.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row36621681648"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p46621883414">lastInstanceStatus</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p66629814410">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p17662181146">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p571615811194">Most recent running status of the job instance. This parameter is available only when <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b881472620296">jobType</strong> is set to <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b3815162672914">BATCH</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0086__en-us_topic_0181281338_row1629831612413"><td class="cellrowborder" valign="top" width="21.51%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p929814162048">lastInstanceEndTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p12135164010141">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.43%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1113594041411">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p13299216240">Time when the most recent job instance stops to run. This parameter is available only when <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b5874819165310">jobType</strong> is set to <strong id="dataartsstudio_02_0086__en-us_topic_0181281338_b1187521916537">BATCH</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0086__en-us_topic_0181281338_section44081020185315"><h4 class="sectiontitle">Example</h4><p id="dataartsstudio_02_0086__en-us_topic_0181281338_p1177364617201">View a batch or real-time job list.</p>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul1317144213230"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li618142192311">Request</li></ul>
|
|
<pre class="screen" id="dataartsstudio_02_0086__en-us_topic_0181281338_screen2034652711234">GET /v1/ff6b627b9d7b45b48f773be511c1a2b8/jobs</pre>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul11462144932311"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li5462649132316">Response<pre class="screen" id="dataartsstudio_02_0086__zh-cn_topic_0181281338_screen140111441890">{
|
|
"jobs": [
|
|
{
|
|
"createTime": 1680783636000,
|
|
"createUser": "test_user",
|
|
"jobType": "BATCH",
|
|
"lastInstanceEndTime": 1682519407000,
|
|
"lastInstanceStatus": "success",
|
|
"name": "myJob",
|
|
"startTime": 1680783598000,
|
|
"status": "SCHEDULING"
|
|
}
|
|
],
|
|
"total": 1
|
|
}</pre>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0086__en-us_topic_0181281338_ul3725916596"><li id="dataartsstudio_02_0086__en-us_topic_0181281338_li313082312504">Failure response<p id="dataartsstudio_02_0086__en-us_topic_0181281338_p17868101111567"><a name="dataartsstudio_02_0086__en-us_topic_0181281338_li313082312504"></a><a name="en-us_topic_0181281338_li313082312504"></a>HTTP status code 400</p>
|
|
<pre class="screen" id="dataartsstudio_02_0086__en-us_topic_0181281338_screen2818105917308">{
|
|
"error_code":"DLF.3051",
|
|
"error_msg":"The request parameter is invalid."
|
|
}</pre>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0083.html">APIs to Be Taken Offline</a></div>
|
|
</div>
|
|
</div>
|
|
|