forked from docs/doc-exports
Xiong, Chen Xiao
14a6d65e8c
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com> Co-committed-by: Xiong, Chen Xiao <chenxiaoxiong@huawei.com>
360 lines
34 KiB
HTML
360 lines
34 KiB
HTML
<a name="dataartsstudio_02_0094"></a><a name="dataartsstudio_02_0094"></a>
|
|
|
|
<h1 class="topictitle1">Viewing a Job Instance List</h1>
|
|
<div id="body0000001104494740"><div class="section" id="dataartsstudio_02_0094__en-us_topic_0181281341_section1738101810182"><h4 class="sectiontitle">Function</h4><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p19320514457">This API is used to view a job instance list.</p>
|
|
<p id="dataartsstudio_02_0094__en-us_topic_0181281341_p015141164519">A job instance is generated each time you run a batch job for which periodic scheduling or event-based scheduling is configured. If a real-time job contains a node for which periodic scheduling or event-based scheduling is configured, you can call this API to view the instance list of the subjobs associated with the node. The format of the <strong id="dataartsstudio_02_0094__en-us_topic_0181281341_b11127203712414">jobName</strong> parameter is <em id="dataartsstudio_02_0094__en-us_topic_0181281341_i1629091955">real-time job name</em>_<em id="dataartsstudio_02_0094__en-us_topic_0181281341_i017115571347">node name</em>.</p>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0094__en-us_topic_0181281341_section102234449285"><h4 class="sectiontitle">URI</h4><ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul145591424184717"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li356152404715">URI format<p id="dataartsstudio_02_0094__en-us_topic_0181281341_p076674419427"><a name="dataartsstudio_02_0094__en-us_topic_0181281341_li356152404715"></a><a name="en-us_topic_0181281341_li356152404715"></a>GET /v1/{project_id}/jobs/instances/detail?jobName={jobName}&minPlanTime={minPlanTime}&maxPlanTime={maxPlanTime}&limit={limit}&offset={offset}&status={status}&instanceType={instanceType}&preciseQuery={preciseQuery}</p>
|
|
</li></ul>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul1370917277482"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li170972720484">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_table46023801181358" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_row26974916181358"><th align="left" class="cellrowborder" valign="top" width="19.8%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p37484572181358">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.04%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p16351468181358">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.12%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p49400541181358">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="53.04%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p42020886181358">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_row48248640181358"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p15825795181358">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p6820998181358">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0093082049_p15629937181358">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p8672138175612">Project ID. For details about how to obtain a project ID, see <a href="projectid_accountid.html">Project ID and Account ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row1998712117162"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p102187318161">jobName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p162181632161">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1621814313163">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p7538112212453">Job name.</p>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul16861630194512"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li108616301451">If you want to query the instance list of a specific batch job, jobName is the batch job name.</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li1058863234513">If you want to query sub-jobs associated with a node in a real-time job, the jobName format is <em id="dataartsstudio_02_0094__en-us_topic_0181281341_i72171947165316">real-time job name</em> _ <em id="dataartsstudio_02_0094__en-us_topic_0181281341_i2929743165312">node name</em>.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row10581131313164"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p2285119151618">minPlanTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p172856198164">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p6273092181">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p328551914166">Minimum planned job execution time in milliseconds. Job instances whose start time is greater than this time are returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row14251217171618"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p22854191164">maxPlanTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p328551919165">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p928551991617">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p5244231142412">Minimum planned job execution time in milliseconds. Job instances whose start time is less than this time are returned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row16810104255318"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p31081798172">limit</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p14108169151713">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p11108497173">int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p010910915170">The maximum number of records on each page.</p>
|
|
<p id="dataartsstudio_02_0094__en-us_topic_0181281341_p13217857560">The parameter value ranges from 1 to 1000.</p>
|
|
<p id="dataartsstudio_02_0094__en-us_topic_0181281341_p163642582342">Default value: <strong id="dataartsstudio_02_0094__b144691681563">10</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row166164291719"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p151085911174">offset</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p51086916179">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p810879131716">int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1611914378613">Start page of the paging list. The default value is <strong id="dataartsstudio_02_0094__en-us_topic_0181281341_b645217227488">0</strong>. The value must be greater than or equal to <strong id="dataartsstudio_02_0094__en-us_topic_0181281341_b12294192115487">0</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row1079625141717"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p110911931717">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1109159121714">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1110918941710">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p14109149161710">Job instance status.</p>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul15109794171"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li1810949161717">waiting</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li51091961716">running</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li1110999151718">success</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li11109179171716">fail</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li610989121711">running-exception</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li1910929141718">pause</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li9109189141713">manual-stop</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row7350154724117"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p12350114754111">instanceType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p335144713414">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p143511247154117">int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1635114477418">Job scheduling modes.</p>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul978451412421"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li10784191464216">0: General scheduling</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li9821233421">2: Manual scheduling</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li179118275420">5: PatchData</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li188156300422">6: Subjob scheduling</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li44623614423">7: Schedule once</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row8971143894112"><td class="cellrowborder" valign="top" width="19.8%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dataartsstudio_02_0094__p89718383410">preciseQuery</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.04%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dataartsstudio_02_0094__p2097183811417">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.12%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dataartsstudio_02_0094__p139711938174113">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="53.04%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dataartsstudio_02_0094__p79721387411">Whether exact search of jobs by name is supported</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0094__en-us_topic_0181281341_section10789431145710"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0094__en-us_topic_0181281341_table25071810112414" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameter</caption><thead align="left"><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_en-us_topic_0181281363_p11149331122017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_en-us_topic_0181281363_p169341251122511">Workspace ID.</p>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0181281363_ul776685742514"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_en-us_topic_0181281363_li076655782516">If this parameter is not set, data in the <strong id="dataartsstudio_02_0094__b194690754717">default</strong> workspace is queried by default.</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_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_0094__en-us_topic_0181281341_section17656611145018"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0094__en-us_topic_0181281341_table411392785710" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row91151927115710"><th align="left" class="cellrowborder" valign="top" width="21.75%" id="mcps1.3.4.2.2.5.1.1"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1111772717571">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_0094__en-us_topic_0181281341_p13117627145716">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.310000000000002%" id="mcps1.3.4.2.2.5.1.3"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p181192279574">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.61%" id="mcps1.3.4.2.2.5.1.4"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p712010276572">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row4120162795712"><td class="cellrowborder" valign="top" width="21.75%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p912012765717">total</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p17123172712575">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p10123142712570">int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p141241279572">Total number of records.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row8124627165711"><td class="cellrowborder" valign="top" width="21.75%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p9126202735714">instances</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.33%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p71261127125716">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.310000000000002%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p10126112715719">List<Instance></p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.61%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p10128527165714">Job instance status. For details, see <a href="#dataartsstudio_02_0094__en-us_topic_0181281341_table4361191610322">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dataartsstudio_02_0094__en-us_topic_0181281341_table4361191610322"></a><a name="en-us_topic_0181281341_table4361191610322"></a><table cellpadding="4" cellspacing="0" summary="" id="dataartsstudio_02_0094__en-us_topic_0181281341_table4361191610322" frame="border" border="1" rules="all"><caption><b>Table 4 </b>instances parameters</caption><thead align="left"><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row153631916203216"><th align="left" class="cellrowborder" valign="top" width="21.63%" id="mcps1.3.4.3.2.5.1.1"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p43654167326">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_0094__en-us_topic_0181281341_p14365111613325">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.55%" id="mcps1.3.4.3.2.5.1.3"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p18367121613212">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.370000000000005%" id="mcps1.3.4.3.2.5.1.4"><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p9367141623218">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row76031813145816"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p8954181425819">jobName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1956141425811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p39576141583">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p119591714165813">Job name. When you view the instance list of a specified batch job, <strong id="dataartsstudio_02_0094__en-us_topic_0181281341_b19853858133018">jobName</strong> is the name of the batch job. When you view the subjobs associated with a node in a real-time job, <strong id="dataartsstudio_02_0094__en-us_topic_0181281341_b485435873012">jobName</strong> is in format of <em id="dataartsstudio_02_0094__en-us_topic_0181281341_i108554582307">real-time job name</em>_<em id="dataartsstudio_02_0094__en-us_topic_0181281341_i885745820302">node name</em>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row176661755114615"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__p2066655510463">jobId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__p196663559468">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__p86666559465">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__p1066615557467">Job ID</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row824412304557"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__p10245123005510">jobInstanceName</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__p024543045519">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__p6245163014550">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__p5245193019559">Name of a job instance recorded by the log, rather than the name defined during job creation</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row133672016183214"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p83681116203218">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p2036919165322">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p13371161612323">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p92439516577">Job instance status.</p>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul1324355115574"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li1124475155716">waiting</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li202451251185712">running</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li16246135145713">success</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li14248351165711">fail</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li1124918513573">running-exception</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li122512518572">pause</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li15253165117575">manual-stop</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row537117161327"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p237213161325">planTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p183731316173212">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p10374716123215">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p137515169320">Planned execution time of the job instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row15560125010580"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p4560135018586">startTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p11560165013586">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p298220262">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p165602505589">Actual execution start time of the job instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row19943658185814"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1494375812588">endTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p89431858165817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1117442417264">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p973683785919">Actual execution end time of the job instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row133610115596"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p4336017591">executeTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p10336319594">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p3336816595">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p13362155919">Execution duration in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row161656155811"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p261185635815">instanceId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p261756125819">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p13273173015">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p66175610589">Job instance ID, which is used to query job instance details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row1444111292012"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p244142911010">submitTime</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p114411299017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p19990193022619">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1944120291309">Time when a job is submitted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__en-us_topic_0181281341_row2942204433"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p29428017439">instanceType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p1994280194318">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p194380134313">int</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281341_p12888135534516">Job scheduling modes.</p>
|
|
<ul id="dataartsstudio_02_0094__en-us_topic_0181281341_ul9888555154515"><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li988812558453">0: General scheduling</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li12889135574518">2: Manual scheduling</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li588945564511">5: PatchData</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li2889955164510">6: Subjob scheduling</li><li id="dataartsstudio_02_0094__en-us_topic_0181281341_li168892055194515">7: Schedule once</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row1492914155466"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__p20929151514469">forceSuccess</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__p631544418474">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__p1922141151519">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__en-us_topic_0181281356_p11826184016116">Whether the job instance status is forcibly successful</p>
|
|
<p id="dataartsstudio_02_0094__p1389820529271">Default value: <strong id="dataartsstudio_02_0094__b18603141019274">false</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row87952176465"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__p1279551715469">ignoreSuccess</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__p19821124418471">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__p1047516226154">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__p940335614917">Whether the job instance status is failure ignored</p>
|
|
<p id="dataartsstudio_02_0094__p1247502219155">Default value: <strong id="dataartsstudio_02_0094__b8584171210272">false</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dataartsstudio_02_0094__row23181953144414"><td class="cellrowborder" valign="top" width="21.63%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dataartsstudio_02_0094__p1231895304416">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.45%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dataartsstudio_02_0094__p7318185354414">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.55%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dataartsstudio_02_0094__p331855318443">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.370000000000005%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dataartsstudio_02_0094__p1831819534443">Job instance version</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0094__en-us_topic_0181281341_section358155716277"><h4 class="sectiontitle">Example Request</h4><div class="p" id="dataartsstudio_02_0094__en-us_topic_0181281341_p540292315256">View the instance list of batch job <strong id="dataartsstudio_02_0094__en-us_topic_0181281341_b9528545331">job_batch</strong>.<pre class="screen" id="dataartsstudio_02_0094__en-us_topic_0181281341_screen1329221441818">GET /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/instances/detail?jobName=job_batch</pre>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dataartsstudio_02_0094__section1984110252460"><h4 class="sectiontitle">Example Response</h4><div class="p" id="dataartsstudio_02_0094__p6619133819467">Success response<pre class="screen" id="dataartsstudio_02_0094__screen17841725114614">{
|
|
"total": 2,
|
|
"instances": [{
|
|
"endTime": 1551671598000,
|
|
"executeTime": 0.3,
|
|
"forceSuccess": false,
|
|
"ignoreSuccess": false,
|
|
"instanceId": 34765,
|
|
"instanceType": 2,
|
|
"jobId": 608627,
|
|
"jobName": "job_batch",
|
|
"jobInstanceName": "job_batch",
|
|
"planTime": 1551671580000,
|
|
"startTime": 1551671580000,
|
|
"status": "success",
|
|
"submitTime": 1550910278706,
|
|
"version": 1
|
|
},
|
|
{
|
|
"endTime": 1551671538000,
|
|
"executeTime": 0.3,
|
|
"forceSuccess": false,
|
|
"ignoreSuccess": false,
|
|
"instanceId": 34764,
|
|
"instanceType": 5,
|
|
"jobId": 608627,
|
|
"jobName": "job_batch",
|
|
"jobInstanceName": "job_batch",
|
|
"planTime": 1551671520000,
|
|
"startTime": 1551671521000,
|
|
"status": "success",
|
|
"submitTime": 1550910278706,
|
|
"version": 1
|
|
}]
|
|
}</pre>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dataartsstudio_02_0062.html">Job Development APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|