forked from docs/doc-exports
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>
734 lines
67 KiB
HTML
734 lines
67 KiB
HTML
<a name="dli_02_0025"></a><a name="dli_02_0025"></a>
|
|
|
|
<h1 class="topictitle1">Querying All Jobs</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0025__s9e059ec7a7fe484b961762c602c3c5f0"><h4 class="sectiontitle">Function</h4><p id="dli_02_0025__en-us_topic_0069077895_p53745025">This API is used to query information about all jobs in the current project.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__sf6ace39cf7744286a2ece48713eb78b1"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0025__en-us_topic_0069077895_ul58379802"><li id="dli_02_0025__en-us_topic_0069077895_li55656175">URI format<p id="dli_02_0025__en-us_topic_0069077895_p31143527"><a name="dli_02_0025__en-us_topic_0069077895_li55656175"></a><a name="en-us_topic_0069077895_li55656175"></a>GET /v1.0/{project_id}/jobs</p>
|
|
</li><li id="dli_02_0025__li792118535215">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__en-us_topic_0069077895_table11856293" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0025__en-us_topic_0069077895_row19051593"><th align="left" class="cellrowborder" valign="top" width="17.21%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0025__en-us_topic_0069077895_p133213431056">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.63%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0025__en-us_topic_0069077895_p33217431457">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.85%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0025__p1451284019477">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.309999999999995%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0025__en-us_topic_0069077895_p13328437515">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0025__row168166924115"><td class="cellrowborder" valign="top" width="17.21%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0025__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.63%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0025__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.85%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0025__p1551264013477">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.309999999999995%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0025__p12841111193519"><strong id="dli_02_0025__b101022648941012">Definition</strong></p>
|
|
<p id="dli_02_0025__p18513202722714">Project ID, which is used for resource isolation. For how to obtain a project ID, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
<p id="dli_02_0025__p476513559276">Example: <strong id="dli_02_0025__b208119121542749">48cc2c48765f481480c7db940d6409d1</strong></p>
|
|
<p id="dli_02_0025__p1779921913513"><strong id="dli_02_0025__b136738788941051">Constraints</strong></p>
|
|
<p id="dli_02_0025__p16166233143510">None</p>
|
|
<p id="dli_02_0025__p19789423113517"><strong id="dli_02_0025__b3516498334054">Range</strong></p>
|
|
<p id="dli_02_0025__p20527112713361">The value can contain up to 64 characters. Only letters and digits are allowed.</p>
|
|
<p id="dli_02_0025__p1049772653519"><strong id="dli_02_0025__b7900429744738">Default Value</strong></p>
|
|
<p id="dli_02_0025__p6928441113513">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__table39011047174812" frame="border" border="1" rules="all"><caption><b>Table 2 </b>query parameter description</caption><thead align="left"><tr id="dli_02_0025__row149011647104816"><th align="left" class="cellrowborder" valign="top" width="15.03%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0025__p17902347134815">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.64%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0025__p12902144744817">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.88%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0025__p4902134714814">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="61.45%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0025__p790310473481">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0025__row18904194715480"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p1690413471489">page-size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p8904154717482">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p109042470482">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p175192419380"><strong id="dli_02_0025__b8353508215320">Definition</strong></p>
|
|
<p id="dli_02_0025__p3867172723818">Maximum number of jobs displayed on each page, for example, 5</p>
|
|
<p id="dli_02_0025__p45313435387"><strong id="dli_02_0025__b6506153815341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p1237332912382">None</p>
|
|
<p id="dli_02_0025__p1118418466385"><strong id="dli_02_0025__b7209399465356">Range</strong></p>
|
|
<p id="dli_02_0025__p422533193817"><strong id="dli_02_0025__b13875536123816"></strong>[1, 100]</p>
|
|
<p id="dli_02_0025__p880224733815"><strong id="dli_02_0025__b406851295351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p7905184711488">50</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1790517471489"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p79051047104812">current-page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p4905164704816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p390584716489">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p1524565612392"><strong id="dli_02_0025__b7471793895320">Definition</strong></p>
|
|
<p id="dli_02_0025__p13530817405">Current page number. The default value is <strong id="dli_02_0025__b197513379261">1</strong>.</p>
|
|
<p id="dli_02_0025__p17245115673910"><strong id="dli_02_0025__b11568720935341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p132457565399">None</p>
|
|
<p id="dli_02_0025__p9245145693911"><strong id="dli_02_0025__b19188944475356">Range</strong></p>
|
|
<p id="dli_02_0025__p172458560397"><strong id="dli_02_0025__b1124513563392"></strong>[1, 100]</p>
|
|
<p id="dli_02_0025__p7245155623914"><strong id="dli_02_0025__b20362687625351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p7245556133912">1</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row590524744816"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p1790574715487">start</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p17906184719484">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p119061347114820">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p5309210416"><strong id="dli_02_0025__b2787867755320">Definition</strong></p>
|
|
<p id="dli_02_0025__p2309161184116">Queries jobs with a start time later than the time specified by this parameter.</p>
|
|
<p id="dli_02_0025__p1930917116411"><strong id="dli_02_0025__b170216545341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p16309413417">The value is a UNIX timestamp, in milliseconds.</p>
|
|
<p id="dli_02_0025__p93091912410"><strong id="dli_02_0025__b10238200765356">Range</strong></p>
|
|
<p id="dli_02_0025__p330913134116">None</p>
|
|
<p id="dli_02_0025__p8309151154119"><strong id="dli_02_0025__b15961162285351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p123091816416">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row18906194717481"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p1590610479485">end</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p17906547154818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p29061547114816">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p1638316315418"><strong id="dli_02_0025__b7986797105320">Definition</strong></p>
|
|
<p id="dli_02_0025__p93831431415">Queries jobs with a start time earlier than the time specified by this parameter.</p>
|
|
<p id="dli_02_0025__p203837324111"><strong id="dli_02_0025__b700397345341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p1338343154114">The value is a UNIX timestamp, in milliseconds.</p>
|
|
<p id="dli_02_0025__p18383193134118"><strong id="dli_02_0025__b19276100785356">Range</strong></p>
|
|
<p id="dli_02_0025__p83831037412">None</p>
|
|
<p id="dli_02_0025__p203831638413"><strong id="dli_02_0025__b18558874225351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p13837334113">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row8906144719484"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p39061647154812">job-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p7906134712483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p9906134744819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p78897534119"><strong id="dli_02_0025__b12711192725320">Definition</strong></p>
|
|
<p id="dli_02_0025__p88904594113">Type of jobs to be queried. The options are <strong id="dli_02_0025__b17864151611301">DDL</strong>, <strong id="dli_02_0025__b13521318123014">DCL</strong>, <strong id="dli_02_0025__b188991917308">IMPORT</strong>, <strong id="dli_02_0025__b12144820173020">EXPORT</strong>, <strong id="dli_02_0025__b3286621103019">QUERY</strong>, <strong id="dli_02_0025__b1432323015">INSERT</strong>, <strong id="dli_02_0025__b179128244309">DATA_MIGRATION</strong>, <strong id="dli_02_0025__b14153132620301">UPDATE</strong>, <strong id="dli_02_0025__b2043692714308">DELETE</strong>, <strong id="dli_02_0025__b1484102803019">RESTART_QUEUE</strong>, and <strong id="dli_02_0025__b8267143010309">SCALE_QUEUE</strong>. To query all types of jobs, enter <strong id="dli_02_0025__b12987548318">ALL</strong>.</p>
|
|
<p id="dli_02_0025__p92528452561"><strong id="dli_02_0025__b1353720128179">job-type</strong> is used to query a single type of jobs, or set to <strong id="dli_02_0025__b26512266175">ALL</strong> to query all types of jobs.</p>
|
|
<p id="dli_02_0025__p11121244175819">If <strong id="dli_02_0025__b146011637112111">job-type</strong> and <strong id="dli_02_0025__b275318391218">job_types</strong> are both set, the value of <strong id="dli_02_0025__b681881516285">job-type</strong> takes the intersection of the two.</p>
|
|
<p id="dli_02_0025__p108906518415"><strong id="dli_02_0025__b20529625865341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p128905544118">None</p>
|
|
<p id="dli_02_0025__p9890155144118"><strong id="dli_02_0025__b11738862155356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul72501212135711"><li id="dli_02_0025__li92501012195710"><strong id="dli_02_0025__b593015533416">DDL</strong>: data definition jobs (such as <strong id="dli_02_0025__b22291779354">CREATE</strong>, <strong id="dli_02_0025__b63302833510">ALTER</strong>, and <strong id="dli_02_0025__b164831392354">DROP</strong>)</li><li id="dli_02_0025__li625014127579"><strong id="dli_02_0025__b735315163351">DCL</strong>: data control jobs (such as <strong id="dli_02_0025__b9635122323513">GRANT</strong> and <strong id="dli_02_0025__b17337125153510">REVOKE</strong>)</li><li id="dli_02_0025__li7250312135711"><strong id="dli_02_0025__b643311292353">IMPORT</strong>: data import jobs (loading data from external sources)</li><li id="dli_02_0025__li02504129571"><strong id="dli_02_0025__b1956917361353">EXPORT</strong>: data export jobs (outputting data to external systems)</li><li id="dli_02_0025__li19250131275715"><strong id="dli_02_0025__b18151134512359">QUERY</strong>: query jobs (such as <strong id="dli_02_0025__b145871348143516">SELECT</strong> statements)</li><li id="dli_02_0025__li125091245719"><strong id="dli_02_0025__b1227312525357">INSERT</strong>: data insertion jobs (such as <strong id="dli_02_0025__b1743435683518">INSERT</strong> statements)</li><li id="dli_02_0025__li6250181235718"><strong id="dli_02_0025__b146571559163519">DATA_MIGRATION</strong>: data migration jobs (cross-database/cross-cluster data migration)</li><li id="dli_02_0025__li7250812165714"><strong id="dli_02_0025__b187141172369">UPDATE</strong>: data update jobs (such as <strong id="dli_02_0025__b1346191211364">UPDATE</strong> statements)</li><li id="dli_02_0025__li12250812165712"><strong id="dli_02_0025__b17392171593612">DELETE</strong>: data deletion jobs (such as <strong id="dli_02_0025__b19516219133616">DELETE</strong> statements)</li><li id="dli_02_0025__li11251112125714"><strong id="dli_02_0025__b1341122313363">RESTART_QUEUE</strong>: queue restart jobs (resuming suspended or failed queue jobs)</li><li id="dli_02_0025__li525191295718"><strong id="dli_02_0025__b20434111516374">SCALE_QUEUE</strong>: queue scaling jobs (dynamically adjusting queue resources)</li></ul>
|
|
<p id="dli_02_0025__p589010584113"><strong id="dli_02_0025__b439945395351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p128901534112">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1428771771010"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p6125238103216">job_types</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p912593863220">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p812513386324">Array[string]</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p193900014416"><strong id="dli_02_0025__b12357367455320">Definition</strong></p>
|
|
<p id="dli_02_0025__p612515387325">List of job types to be queried. The options are <strong id="dli_02_0025__b7569499295">DDL</strong>, <strong id="dli_02_0025__b1918325082913">DCL</strong>, <strong id="dli_02_0025__b234385112910">IMPORT</strong>, <strong id="dli_02_0025__b1780612536296">EXPORT</strong>, <strong id="dli_02_0025__b1543825572914">QUERY</strong>, <strong id="dli_02_0025__b948645782919">INSERT</strong>, <strong id="dli_02_0025__b145719595293">UPDATE</strong>, and <strong id="dli_02_0025__b1422411043012">DELETE</strong>.</p>
|
|
<p id="dli_02_0025__p206420210575"><strong id="dli_02_0025__b20640104012204">job_types</strong> is used to query multiple types of jobs. If <strong id="dli_02_0025__b598575442810">job_types</strong> and <strong id="dli_02_0025__b598514546280">job-type</strong> are both set, the value of <strong id="dli_02_0025__b189858541281">job_types</strong> takes the intersection of the two.</p>
|
|
<p id="dli_02_0025__p33901709442"><strong id="dli_02_0025__b7179701785341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p3390100104414">None</p>
|
|
<p id="dli_02_0025__p33901903444"><strong id="dli_02_0025__b14250561315356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul6473735185120"><li id="dli_02_0025__li34733355511"><strong id="dli_02_0025__b12517826103718">DDL</strong>: data definition jobs (such as <strong id="dli_02_0025__b18517172618377">CREATE</strong>, <strong id="dli_02_0025__b75171526183717">ALTER</strong>, and <strong id="dli_02_0025__b155171266372">DROP</strong>)</li><li id="dli_02_0025__li6473193575113"><strong id="dli_02_0025__b1295226113510">DCL</strong>: data control jobs (such as <strong id="dli_02_0025__b189513266353">GRANT</strong> and <strong id="dli_02_0025__b13953268358">REVOKE</strong>)</li><li id="dli_02_0025__li1147313352513"><strong id="dli_02_0025__b646043711373">IMPORT</strong>: data import jobs (for example, importing data from files or external sources)</li><li id="dli_02_0025__li447393515115"><strong id="dli_02_0025__b12819124518375">EXPORT</strong>: data export jobs (exporting data to files or external systems)</li><li id="dli_02_0025__li16473143595118"><strong id="dli_02_0025__b826817494353">QUERY</strong>: query jobs (such as <strong id="dli_02_0025__b2268849143520">SELECT</strong> statements)</li><li id="dli_02_0025__li74736351512"><strong id="dli_02_0025__b20227165733518">INSERT</strong>: data insertion jobs (such as <strong id="dli_02_0025__b15227357133518">INSERT</strong> statements)</li><li id="dli_02_0025__li2047318358513"><strong id="dli_02_0025__b19755191215366">UPDATE</strong>: data update jobs (such as <strong id="dli_02_0025__b1075561283612">UPDATE</strong> statements)</li><li id="dli_02_0025__li1647383585120"><strong id="dli_02_0025__b5248120113614">DELETE</strong>: data deletion jobs (such as <strong id="dli_02_0025__b024882073611">DELETE</strong> statements)</li></ul>
|
|
<p id="dli_02_0025__p339010124418"><strong id="dli_02_0025__b13488486815351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p2039016064415">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row18103104414202"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p278101022210">job-status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p197812105227">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p1278191042210">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p0323685410"><strong id="dli_02_0025__b14958452125320">Definition</strong></p>
|
|
<p id="dli_02_0025__p193247811413">Status of jobs to be queried</p>
|
|
<p id="dli_02_0025__p103246811415"><strong id="dli_02_0025__b11564153755341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p93241819416">None</p>
|
|
<p id="dli_02_0025__p932417813413"><strong id="dli_02_0025__b13975812705356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul088094419304"><li id="dli_02_0025__li17880114410301"><strong id="dli_02_0025__b69931535163818">RUNNING</strong>: The job is running.</li><li id="dli_02_0025__li388014441301"><strong id="dli_02_0025__b489175620385">SCALING</strong>: The job is modifying specifications.</li><li id="dli_02_0025__li10880174418304"><strong id="dli_02_0025__b159547917397">LAUNCHING</strong>: The job is being submitted.</li><li id="dli_02_0025__li1588024412303"><strong id="dli_02_0025__b1333133514015">FINISHED</strong>: The job is completed.</li><li id="dli_02_0025__li888012447301"><strong id="dli_02_0025__b16862544104015">FAILED</strong>: The job has failed.</li><li id="dli_02_0025__li148802044123013"><strong id="dli_02_0025__b14696134104113">CANCELLED</strong>: The job has been canceled.</li></ul>
|
|
<p id="dli_02_0025__p1332416810418"><strong id="dli_02_0025__b21156615945351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p11324188144113">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1989151303313"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p7990201323315">job-id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p159901113143318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p13990121312339">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p6553114011431"><strong id="dli_02_0025__b15060761745320">Definition</strong></p>
|
|
<p id="dli_02_0025__p399017137337">ID of the job to be queried. You can get the value by calling <a href="dli_02_0102.html">Submitting a SQL Job (Recommended)</a>.</p>
|
|
<p id="dli_02_0025__p10553104024318"><strong id="dli_02_0025__b15294758855341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p555318400437">None</p>
|
|
<p id="dli_02_0025__p18553104017432"><strong id="dli_02_0025__b1645666265356">Range</strong></p>
|
|
<p id="dli_02_0025__p145536403431">The value can contain up to 64 characters. Only letters and digits are allowed.</p>
|
|
<p id="dli_02_0025__p755313402430"><strong id="dli_02_0025__b18674081795351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p2553640134319">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row17906144716484"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p15907747104814">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p5907134712484">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p7907247154815">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p7497104314431"><strong id="dli_02_0025__b14338017355320">Definition</strong></p>
|
|
<p id="dli_02_0025__p20497043124310">Name of the queue where desired jobs are running</p>
|
|
<p id="dli_02_0025__p19497104374316"><strong id="dli_02_0025__b11057746815341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p204971643124315">None</p>
|
|
<p id="dli_02_0025__p04976434431"><strong id="dli_02_0025__b3614865695356">Range</strong></p>
|
|
<p id="dli_02_0025__p19497184364310">None</p>
|
|
<p id="dli_02_0025__p17497134324310"><strong id="dli_02_0025__b1282683115351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p164974434433">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row89071147144814"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p14907164744814">sql_pattern</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p190716474483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p199071147114814">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p1510817464437"><strong id="dli_02_0025__b6832843135320">Definition</strong></p>
|
|
<p id="dli_02_0025__p19907134713484">Specifies the SQL segment as the filter. It is case insensitive.</p>
|
|
<p id="dli_02_0025__p15108194624319"><strong id="dli_02_0025__b4085370605341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p1210819467435">None</p>
|
|
<p id="dli_02_0025__p2108164619438"><strong id="dli_02_0025__b15106068485356">Range</strong></p>
|
|
<p id="dli_02_0025__p7108246194315">None</p>
|
|
<p id="dli_02_0025__p4108134616432"><strong id="dli_02_0025__b10312237265351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p131081646154319">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row209071478484"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p4907144794812">order</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p17907144794820">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p490764784812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p870554824310"><strong id="dli_02_0025__b11243247015320">Definition</strong></p>
|
|
<p id="dli_02_0025__p20705348174311">Job sorting mode</p>
|
|
<p id="dli_02_0025__p97058481439"><strong id="dli_02_0025__b155493845341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p1970584812435">None</p>
|
|
<p id="dli_02_0025__p1870544854312"><strong id="dli_02_0025__b13816240805356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul1144195812455"><li id="dli_02_0025__li31449585456"><strong id="dli_02_0025__b143941685010">duration_desc</strong>: Jobs are sorted by running duration in descending order.</li><li id="dli_02_0025__li1814495894511"><strong id="dli_02_0025__b57154365115">duration_asc</strong>: Jobs are sorted by running duration in ascending order.</li><li id="dli_02_0025__li1614414583451"><strong id="dli_02_0025__b19651213135116">start_time_desc</strong>: Jobs are sorted by submission time in descending order.</li><li id="dli_02_0025__li171441358204518"><strong id="dli_02_0025__b692452118510">start_time_asc</strong>: Jobs are sorted by submission time in ascending order.</li></ul>
|
|
<p id="dli_02_0025__p4705104815437"><strong id="dli_02_0025__b19816845285351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p1070544813431">The default value is <strong id="dli_02_0025__b108421398513">start_time_desc</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1120424514818"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p13210545154812">engine_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p102117454485">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p17211745194811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p185181151114318"><strong id="dli_02_0025__b14815120065320">Definition</strong></p>
|
|
<p id="dli_02_0025__p133518316190">Engine type</p>
|
|
<p id="dli_02_0025__p1551895144314"><strong id="dli_02_0025__b16710956365341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p1151818511436">None</p>
|
|
<p id="dli_02_0025__p851810514435"><strong id="dli_02_0025__b9986988345356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul19862321174814"><li id="dli_02_0025__li198622219489"><strong id="dli_02_0025__b74275653644327">spark</strong>: Spark engine</li></ul>
|
|
<p id="dli_02_0025__p751817511439"><strong id="dli_02_0025__b5014336395351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p851875174318">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row14907317171818"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p18909131791812">owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p19091117141815">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p129091317131819">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p2021445404317"><strong id="dli_02_0025__b11299995615320">Definition</strong></p>
|
|
<p id="dli_02_0025__p92141254144316">User who submits a job</p>
|
|
<p id="dli_02_0025__p19214154104313"><strong id="dli_02_0025__b15984074365341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p17214135444310">None</p>
|
|
<p id="dli_02_0025__p152141754104317"><strong id="dli_02_0025__b1111716155356">Range</strong></p>
|
|
<p id="dli_02_0025__p3214195410433">None</p>
|
|
<p id="dli_02_0025__p17214105417434"><strong id="dli_02_0025__b11075504975351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p9214195415434">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1926442310812"><td class="cellrowborder" valign="top" width="15.03%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0025__p19265142313819">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0025__p192650231984">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.88%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0025__p2265152311817">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="61.45%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0025__p124551321104017">Queue tags for the search. You can specify multiple tags in <strong id="dli_02_0025__b19114205305">key=value</strong> format.</p>
|
|
<p id="dli_02_0025__p11676125718430"><strong id="dli_02_0025__b16983677805320">Definition</strong></p>
|
|
<p id="dli_02_0025__p267695744317">Job tags for filtering. You can specify multiple tags in <strong id="dli_02_0025__b136961817195212">key=value</strong> format.</p>
|
|
<p id="dli_02_0025__p156761257164315"><strong id="dli_02_0025__b13224839065341">Constraints</strong></p>
|
|
<p id="dli_02_0025__p3418112834911">Currently, only fuzzy query across all tags is supported. Exact query is not supported.</p>
|
|
<p id="dli_02_0025__p18676135794319"><strong id="dli_02_0025__b7048931725356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul9729142964018"><li id="dli_02_0025__li4729152954016">Request with one specified tag</li></ul>
|
|
<p id="dli_02_0025__p1926552311818">For example, GET /v1.0/{project_id}/jobs? tags=k1%3Dv1</p>
|
|
<p id="dli_02_0025__p1425710477251">In this example, <strong id="dli_02_0025__b1648725412295">=</strong> needs to be escaped to <strong id="dli_02_0025__b1649385413296">%3D</strong>, <strong id="dli_02_0025__b54941154162915">k1</strong> indicates the tag key, and <strong id="dli_02_0025__b34941954182912">v1</strong> indicates the tag value.</p>
|
|
<ul id="dli_02_0025__ul9920743164017"><li id="dli_02_0025__li289505714406">Request with more than one tag</li></ul>
|
|
<p id="dli_02_0025__p16710145914403">Separate tags with commas (,) and convert the commas (,) to <strong id="dli_02_0025__b7162184514306">%2C</strong>, for example, GET /v1.0/{project_id}/jobs?. tags=k1%3Dv1%2Ck2%3Dv2.</p>
|
|
<p id="dli_02_0025__p1534717187415">The equal sign (=) is escaped to <strong id="dli_02_0025__b6121749193011">%3D</strong>. <strong id="dli_02_0025__b1112264914309">k1</strong> indicates a tag key, and <strong id="dli_02_0025__b14122174963016">v1</strong> indicates the tag value. <strong id="dli_02_0025__b121239492308">k2</strong> indicates another tag key, and <strong id="dli_02_0025__b1812364913301">v2</strong> indicates the tag value.</p>
|
|
<p id="dli_02_0025__p848121524913"><strong id="dli_02_0025__b5092122955351">Default Value</strong></p>
|
|
<p id="dli_02_0025__p1967614576437">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="dli_02_0025__note890482335520"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0025__p1590592365519">The following is an example of the URL containing the <strong id="dli_02_0025__b732610207483">query</strong> parameter:</p>
|
|
<p id="dli_02_0025__p154702130567">GET /v1.0/{project_id}/jobs?page-size=<i><span class="varname" id="dli_02_0025__varname20947159566">{size}</span></i>&current-page=<i><span class="varname" id="dli_02_0025__varname14941515175619">{page_number}</span></i>&start=<i><span class="varname" id="dli_02_0025__varname179491519567">{start_time}</span></i>&end=<i><span class="varname" id="dli_02_0025__varname4941715185616">{end_time}</span></i>&job-type=<i><span class="varname" id="dli_02_0025__varname19950155568">{QUERY}</span></i>&queue_name=<i><span class="varname" id="dli_02_0025__varname10955153566">{test}</span></i>&order=<i><span class="varname" id="dli_02_0025__varname12959159561">{duration_desc}</span></i></p>
|
|
</div></div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__s66b3695f9e2442ebae170acebb8c9656"><h4 class="sectiontitle">Request Parameters</h4><p id="dli_02_0025__p999986015912">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__s3b4557935f6b44308f7efe657ec9e2ee"><h4 class="sectiontitle">Response Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__table4779174665013" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0025__row207791346115016"><th align="left" class="cellrowborder" valign="top" width="12.564356435643564%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0025__p137804465501">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.188118811881187%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0025__p47807464508">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20.96039603960396%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0025__p778016463506">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="51.28712871287129%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0025__p87805463501">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0025__row2780104612503"><td class="cellrowborder" valign="top" width="12.564356435643564%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0025__p16780124655019">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.188118811881187%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p12780446145018">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.96039603960396%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p17801546145013">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0025__p27819467502">Indicates whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0025__parmvalue2472985116738"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1378118462501"><td class="cellrowborder" valign="top" width="12.564356435643564%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0025__p378154612507">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.188118811881187%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p10781154675015">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.96039603960396%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p20781174635017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0025__p177815463502">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1178111469506"><td class="cellrowborder" valign="top" width="12.564356435643564%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0025__p10781746115016">job_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.188118811881187%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p6781134645017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.96039603960396%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p11782646205017">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0025__p1378234615015">Indicates the total number of jobs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1178284614502"><td class="cellrowborder" valign="top" width="12.564356435643564%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0025__p1878284620509">jobs</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.188118811881187%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p17782144615506">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20.96039603960396%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p14782194615018">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="51.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0025__p5782104655017">Indicates the information about a job. For details, see <a href="#dli_02_0025__table6231618192312">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0025__table6231618192312"></a><a name="table6231618192312"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__table6231618192312" frame="border" border="1" rules="all"><caption><b>Table 4 </b><strong id="dli_02_0025__b8990114611255">jobs</strong> parameters</caption><thead align="left"><tr id="dli_02_0025__row15232218142312"><th align="left" class="cellrowborder" valign="top" width="21.73267326732673%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0025__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_0025__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_0025__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_0025__p13233131819235">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0025__row723451815239"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p1123421832313">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p923516182237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p923551818236">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1239982919116"><strong id="dli_02_0025__b8145932725320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1339982918111">Job ID. For details about how to obtain a job ID, see <a href="dli_02_0102.html">Submitting a SQL Job (Recommended)</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row18235131817239"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p623561819233">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p723541862319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p02351918102319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p196740461015"><strong id="dli_02_0025__b5682611745320">Definition</strong></p>
|
|
<p id="dli_02_0025__p9674204613111">Type of jobs to be queried</p>
|
|
<p id="dli_02_0025__p36740461316"><strong id="dli_02_0025__b1711753715356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul067415463118"><li id="dli_02_0025__li136741546619"><strong id="dli_02_0025__b953461303517">DDL</strong>: data definition jobs (such as <strong id="dli_02_0025__b1753451323518">CREATE</strong>, <strong id="dli_02_0025__b17534201314357">ALTER</strong>, and <strong id="dli_02_0025__b1753431333513">DROP</strong>)</li><li id="dli_02_0025__li46747464113"><strong id="dli_02_0025__b39682614359">DCL</strong>: data control jobs (such as <strong id="dli_02_0025__b17961726143518">GRANT</strong> and <strong id="dli_02_0025__b20961126183515">REVOKE</strong>)</li><li id="dli_02_0025__li196741446516"><strong id="dli_02_0025__b778163412356">IMPORT</strong>: data import jobs (loading data from external sources)</li><li id="dli_02_0025__li3674164619119"><strong id="dli_02_0025__b2102164213516">EXPORT</strong>: data export jobs (outputting data to external systems)</li><li id="dli_02_0025__li19674184617111"><strong id="dli_02_0025__b1269849123518">QUERY</strong>: query jobs (such as <strong id="dli_02_0025__b192691949173519">SELECT</strong> statements)</li><li id="dli_02_0025__li1967404619114"><strong id="dli_02_0025__b132291457193518">INSERT</strong>: data insertion jobs (such as <strong id="dli_02_0025__b15229757163512">INSERT</strong> statements)</li><li id="dli_02_0025__li7674104612116"><strong id="dli_02_0025__b89172413365">DATA_MIGRATION</strong>: data migration jobs (cross-database/cross-cluster data migration)</li><li id="dli_02_0025__li367410462015"><strong id="dli_02_0025__b1175621283612">UPDATE</strong>: data update jobs (such as <strong id="dli_02_0025__b1875651223616">UPDATE</strong> statements)</li><li id="dli_02_0025__li967510461116"><strong id="dli_02_0025__b72491920123616">DELETE</strong>: data deletion jobs (such as <strong id="dli_02_0025__b182491420113620">DELETE</strong> statements)</li><li id="dli_02_0025__li1367519461912"><strong id="dli_02_0025__b385411253716">RESTART_QUEUE</strong>: queue restart jobs (resuming suspended or failed queue jobs)</li><li id="dli_02_0025__li1675204611117"><strong id="dli_02_0025__b47012211374">SCALE_QUEUE</strong>: queue scaling jobs (dynamically adjusting queue resources)</li><li id="dli_02_0025__li1185742551810"><strong id="dli_02_0025__b1686152814813">ALL</strong>: All types of jobs are queried.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row162353182230"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p7235201882314">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p18235818132312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p162351318122316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p179131822729"><strong id="dli_02_0025__b9621256005320">Definition</strong></p>
|
|
<p id="dli_02_0025__p169139221928">Queue to which a job is submitted</p>
|
|
<p id="dli_02_0025__p159131722623"><strong id="dli_02_0025__b6895366345356">Range</strong></p>
|
|
<p id="dli_02_0025__p091318221210">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row2236518172310"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p42361218112315">owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p42369185233">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p2236121812232">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p161791215536"><strong id="dli_02_0025__b13408241675320">Definition</strong></p>
|
|
<p id="dli_02_0025__p16179191519318">User who submits a job</p>
|
|
<p id="dli_02_0025__p121799151234"><strong id="dli_02_0025__b16521850485356">Range</strong></p>
|
|
<p id="dli_02_0025__p121797151313">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1523681852317"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p172361418102315">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p12236191812311">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p923691852314">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p11241433232"><strong id="dli_02_0025__b17067037735320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1891215422310">Job start time. The value is a timestamp in milliseconds.</p>
|
|
<p id="dli_02_0025__p12426339310"><strong id="dli_02_0025__b1800821955356">Range</strong></p>
|
|
<p id="dli_02_0025__p1024253318311">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row142361218142312"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__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_0025__p323681852313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__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_0025__p741894619313"><strong id="dli_02_0025__b15766212425320">Definition</strong></p>
|
|
<p id="dli_02_0025__p923731815236">Job running duration (unit: millisecond).</p>
|
|
<p id="dli_02_0025__p9418134614319"><strong id="dli_02_0025__b12305044415356">Range</strong></p>
|
|
<p id="dli_02_0025__p124180461138">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row0237218152310"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p112375182234">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p18237181812235">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p12237181814231">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p2965114710311"><strong id="dli_02_0025__b12564793865320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1196517475311">Status of a job</p>
|
|
<p id="dli_02_0025__p129655476319"><strong id="dli_02_0025__b12254856075356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul173779351574"><li id="dli_02_0025__li173776351677"><strong id="dli_02_0025__b1059465510384">RUNNING</strong>: The job is running.</li><li id="dli_02_0025__li1377193519715"><strong id="dli_02_0025__b788412530920">SCALING</strong>: The job is modifying specifications.</li><li id="dli_02_0025__li123771935372"><strong id="dli_02_0025__b640633404013">LAUNCHING</strong>: The job is being submitted.</li><li id="dli_02_0025__li737723512710"><strong id="dli_02_0025__b124091744174010">FINISHED</strong>: The job is completed.</li><li id="dli_02_0025__li153771935571"><strong id="dli_02_0025__b168298034110">FAILED</strong>: The job has failed.</li><li id="dli_02_0025__li03776350718"><strong id="dli_02_0025__b71214614115">CANCELLED</strong>: The job has been canceled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row132376187236"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p15237141822310">input_row_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p923701815239">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1238151818233">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p64007491837"><strong id="dli_02_0025__b10282615365320">Definition</strong></p>
|
|
<p id="dli_02_0025__p184002491311">Number of records scanned during the Insert job execution</p>
|
|
<p id="dli_02_0025__p17400749638"><strong id="dli_02_0025__b13327597285356">Range</strong></p>
|
|
<p id="dli_02_0025__p194001449339">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1123801820239"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p5238191811233">bad_row_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p10238111814237">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p22381418132313">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p09131150835"><strong id="dli_02_0025__b4207254715320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1223891822314">Number of error records scanned during the Insert job execution.</p>
|
|
<p id="dli_02_0025__p13913145014314"><strong id="dli_02_0025__b4066386475356">Range</strong></p>
|
|
<p id="dli_02_0025__p69138501832">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row4238201892319"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p023851815233">input_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p14239101818231">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p9239151892312">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p15431852337"><strong id="dli_02_0025__b15508605305320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1823951882316">Size of scanned files during job execution.</p>
|
|
<p id="dli_02_0025__p114317521133"><strong id="dli_02_0025__b16203699005356">Range</strong></p>
|
|
<p id="dli_02_0025__p1643175212310">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1123931818235"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p12239151842313">result_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p92390187236">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p15239131822312">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1036465316316"><strong id="dli_02_0025__b12471647235320">Definition</strong></p>
|
|
<p id="dli_02_0025__p5239151892319">Total number of records returned by the current job or total number of records inserted by the Insert job.</p>
|
|
<p id="dli_02_0025__p1736445316310"><strong id="dli_02_0025__b9470393785356">Range</strong></p>
|
|
<p id="dli_02_0025__p33646531438">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row023961892316"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p624011183235">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p2024091812231">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1724017181237">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p31331255936"><strong id="dli_02_0025__b10181319975320">Definition</strong></p>
|
|
<p id="dli_02_0025__p20240518122315">Name of the database where the target table resides. <span class="parmname" id="dli_02_0025__parmname324623672152523"><b>database_name</b></span> is valid only for jobs of the <strong id="dli_02_0025__b603563922111253">Import</strong> and <strong id="dli_02_0025__b452977947111253">Export</strong> types.</p>
|
|
<p id="dli_02_0025__p101331455138"><strong id="dli_02_0025__b2766372525356">Range</strong></p>
|
|
<p id="dli_02_0025__p1513316552034">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row224013188231"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p1324031818233">table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p182405181235">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p182409185239">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p929318565317"><strong id="dli_02_0025__b20247474215320">Definition</strong></p>
|
|
<p id="dli_02_0025__p12411181234">Name of the target table. <span class="parmname" id="dli_02_0025__parmname308310552152538"><b>table_name</b></span> is valid only for jobs of the <strong id="dli_02_0025__b149393021811131">Import</strong> and <strong id="dli_02_0025__b33964668711131">Export</strong> types.</p>
|
|
<p id="dli_02_0025__p729316561633"><strong id="dli_02_0025__b9239502975356">Range</strong></p>
|
|
<p id="dli_02_0025__p429335617317">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row18241151812317"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p1924161815234">with_column_header</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p0241151862316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p82411818142314">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1196614571636"><strong id="dli_02_0025__b10620754335320">Definition</strong></p>
|
|
<p id="dli_02_0025__p192411518192318">Import jobs, which record whether the imported data contains column names.</p>
|
|
<p id="dli_02_0025__p119661357531"><strong id="dli_02_0025__b4806935375356">Range</strong></p>
|
|
<p id="dli_02_0025__p1596610576315">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row924291812313"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p112423189233">detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p824213185234">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p024261817231">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p6621115915313"><strong id="dli_02_0025__b13918923175320">Definition</strong></p>
|
|
<p id="dli_02_0025__p8242318162314">JSON string of related columns queried using SQL statements.</p>
|
|
<p id="dli_02_0025__p1962214598310"><strong id="dli_02_0025__b14149451555356">Range</strong></p>
|
|
<p id="dli_02_0025__p136225598315">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row193011505515"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p2619313517">engine_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p16191013514">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p15619211252">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p12281911149"><strong id="dli_02_0025__b18050985085320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1461971758">Engine type</p>
|
|
<p id="dli_02_0025__p82811611045"><strong id="dli_02_0025__b5305528025356">Range</strong></p>
|
|
<ul id="dli_02_0025__ul137867285134"><li id="dli_02_0025__li187861428141316"><strong id="dli_02_0025__b6114318744327">spark</strong>: Spark engine</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row9242141852316"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p324219181230">statement</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p3242171811237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1924351832310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p108169216419"><strong id="dli_02_0025__b17096690125320">Definition</strong></p>
|
|
<p id="dli_02_0025__p7816521249">SQL statements of a job</p>
|
|
<p id="dli_02_0025__p158169214416"><strong id="dli_02_0025__b15903079535356">Range</strong></p>
|
|
<p id="dli_02_0025__p128167214418">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row8735171173719"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p673581173711">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p573513120370">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1373561203717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p196069517416"><strong id="dli_02_0025__b16508321755320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1735191133715">System prompt.</p>
|
|
<p id="dli_02_0025__p186061752042"><strong id="dli_02_0025__b4551314085356">Range</strong></p>
|
|
<p id="dli_02_0025__p196061454414">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row16555175915364"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p18622184163715">end_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p1562219413372">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p86224414378">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p18746341048"><strong id="dli_02_0025__b5873734625320">Definition</strong></p>
|
|
<p id="dli_02_0025__p155535943612">Job end time. The timestamp is in milliseconds.</p>
|
|
<p id="dli_02_0025__p8746649411"><strong id="dli_02_0025__b251801265356">Range</strong></p>
|
|
<p id="dli_02_0025__p197461541242">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row732232174112"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p13224210419">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p20323152114117">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1323152174114">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p16434271448"><strong id="dli_02_0025__b10939047835320">Definition</strong></p>
|
|
<p id="dli_02_0025__p15323229418">Job tags. For details, see <a href="#dli_02_0025__table9391124139">Table 5</a>.</p>
|
|
<p id="dli_02_0025__p134343716418"><strong id="dli_02_0025__b5182803485356">Range</strong></p>
|
|
<p id="dli_02_0025__p14341071244">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1672737122711"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p43061243162810">result_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p644221914298">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1030674315286">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1966711135410"><strong id="dli_02_0025__b8114650805320">Definition</strong></p>
|
|
<p id="dli_02_0025__p126671213447">Storage format of job results. Currently, only CSV is supported.</p>
|
|
<p id="dli_02_0025__p5667113947"><strong id="dli_02_0025__b19092971715356">Range</strong></p>
|
|
<p id="dli_02_0025__p1866715131846">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row2958396276"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p672711464289">result_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p1244214191292">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p2727114682812">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p295913141343"><strong id="dli_02_0025__b19546536195320">Definition</strong></p>
|
|
<p id="dli_02_0025__p1272794611289">OBS path of job results</p>
|
|
<p id="dli_02_0025__p19591014249"><strong id="dli_02_0025__b7724289185356">Range</strong></p>
|
|
<p id="dli_02_0025__p1959191416418">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row12633482504"><td class="cellrowborder" valign="top" width="21.73267326732673%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p19634188125020">execution_details_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.16831683168317%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p1163414885020">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.693069306930692%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p863420818502">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.4059405940594%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p96251116542"><strong id="dli_02_0025__b19019505555320">Definition</strong></p>
|
|
<p id="dli_02_0025__p263420885011">Path used to store the job execution plan.</p>
|
|
<p id="dli_02_0025__p720953585013">Example: <strong id="dli_02_0025__b167073313217">obs://bucketName/jobs/execution_details/xxx/2023/11/10/xxx</strong></p>
|
|
<p id="dli_02_0025__p1662517167417"><strong id="dli_02_0025__b15405078875356">Range</strong></p>
|
|
<p id="dli_02_0025__p1562511614416">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0025__table9391124139"></a><a name="table9391124139"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__table9391124139" frame="border" border="1" rules="all"><caption><b>Table 5 </b>tags parameters</caption><thead align="left"><tr id="dli_02_0025__row1440020130"><th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.4.4.2.5.1.1"><p id="dli_02_0025__p194012219139">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.83%" id="mcps1.3.4.4.2.5.1.2"><p id="dli_02_0025__p540724136">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.4.2.5.1.3"><p id="dli_02_0025__p840162161315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.8%" id="mcps1.3.4.4.2.5.1.4"><p id="dli_02_0025__p16401271318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0025__row194013231317"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0025__p13401329138">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.83%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0025__p940102141313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0025__p64019231317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0025__p9207636173613"><strong id="dli_02_0025__b68103887541012">Definition</strong></p>
|
|
<p id="dli_02_0025__p6591241113617">Tag key</p>
|
|
<p id="dli_02_0025__p16208636163611"><strong id="dli_02_0025__b12385948714054">Range</strong></p>
|
|
<p id="dli_02_0025__p7208113616360">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1141142181320"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.4.4.2.5.1.1 "><p id="dli_02_0025__p164118215134">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.83%" headers="mcps1.3.4.4.2.5.1.2 "><p id="dli_02_0025__p1141112181317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.4.2.5.1.3 "><p id="dli_02_0025__p174114281318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.4.4.2.5.1.4 "><p id="dli_02_0025__p11118113863619"><strong id="dli_02_0025__b50291653741012">Definition</strong></p>
|
|
<p id="dli_02_0025__p568334533610">Tag value</p>
|
|
<p id="dli_02_0025__p1111863833618"><strong id="dli_02_0025__b6572840124054">Range</strong></p>
|
|
<p id="dli_02_0025__p6118183812361">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__section1267554313159"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0025__p16826101012164">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__section2098270615627"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0025__screen17107315725">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"job_count": 1,
|
|
"jobs": [
|
|
{
|
|
|
|
"detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}},{\"name\":\"age\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}}]}",
|
|
"duration": 17731,
|
|
|
|
"end_time": 1502349821460,
|
|
"input_size": 0,
|
|
"job_id": "37286cc7-0508-4ffd-b636-951c8a5c75de",
|
|
"job_type": "QUERY",
|
|
"message": "",
|
|
"owner": "tenant1",
|
|
"queue_name": "queue1",
|
|
"result_count": 3,
|
|
"start_time": 1502349803729,
|
|
"statement": "select * from t_json_002",
|
|
"status": "FINISHED",
|
|
"with_column_header": false
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0025__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0025__tb12870f1c5f24b27abd55ca24264af36">Table 6</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0025__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Status codes</caption><thead align="left"><tr id="dli_02_0025__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0025__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_0025__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0025__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0025__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0025__p104431642124811">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0025__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0025__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0025__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0025__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0025__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 Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0158.html">SQL Job-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|