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>
507 lines
40 KiB
HTML
507 lines
40 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 parameters</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__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0025__table39011047174812" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="dli_02_0025__b151417265479">query</strong> 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__p7905184711488">Maximum number of jobs displayed on each page. The value range is as follows: [1, 100]. The default value is <strong id="dli_02_0025__b1580538220">50</strong>.</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__p16905184715480">Current page number. The default value is <strong id="dli_02_0025__b84235270615646">1</strong>.</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__p4906847194815">Queries the jobs executed later than the time specified by this parameter. The time is a UNIX timestamp in milliseconds.</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__p13906194734812">Queries the jobs executed earlier than the time specified by this parameter. The time is a UNIX timestamp in milliseconds.</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__p16906114711482">Type of a job to be queried. Job types include <strong id="dli_02_0025__b111331958104719">DDL</strong>, <strong id="dli_02_0025__b513955817473">DCL</strong>, <strong id="dli_02_0025__b10139658194719">IMPORT</strong>, <strong id="dli_02_0025__b1114005874711">EXPORT</strong>, <strong id="dli_02_0025__b141401858114716">QUERY</strong>, <strong id="dli_02_0025__b214035818477">INSERT</strong>, <strong id="dli_02_0025__b151419586472">DATA_MIGRATION</strong>, <strong id="dli_02_0025__b3141958154713">UPDATE</strong>, <strong id="dli_02_0025__b31426583478">DELETE</strong>, <strong id="dli_02_0025__b16142115854714">RESTART_QUEUE</strong>, and <strong id="dli_02_0025__b15143175816471">SCALE_QUEUE</strong>. To query all types of jobs, enter <strong id="dli_02_0025__b4143175820471">ALL</strong>.</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__p41040447209">Status of the job to be queried.</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__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>
|
|
</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__p8907154711487">Specifies <strong id="dli_02_0025__b244941043920">queue_name</strong> as the filter to query jobs running on the specified queue.</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__p19907134713484">Specifies the SQL segment as the filter. It is case insensitive.</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__p1890864713486">Specifies the job sorting mode. The default value is <strong id="dli_02_0025__b22911233204419">start_time_desc</strong> (job submission time in descending order). Four sorting modes are supported: <strong id="dli_02_0025__b7762548154411">duration_desc</strong> (job running duration in descending order), <strong id="dli_02_0025__b13559195618442">duration_asc</strong> (job running duration in ascending order), <strong id="dli_02_0025__b1958918116458">start_time_desc</strong> (job submission time in descending order), and <strong id="dli_02_0025__b26942516457">start_time_asc</strong> (job submission time in ascending order).</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__p1321216453482">Engine type.</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__p1909141761818">User who submits a job.</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>
|
|
<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__p3534134782810">Currently, only fuzzy query is supported. Exact query is not supported.</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</h4><p id="dli_02_0025__p999986015912">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0025__s3b4557935f6b44308f7efe657ec9e2ee"><h4 class="sectiontitle">Response</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="8.990099009900991%" 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="19.03960396039604%" 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="59.4059405940594%" 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="8.990099009900991%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p12780446145018">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03960396039604%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p17801546145013">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.4059405940594%" 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="8.990099009900991%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p10781154675015">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03960396039604%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p20781174635017">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.4059405940594%" 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="8.990099009900991%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p6781134645017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03960396039604%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0025__p11782646205017">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.4059405940594%" 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="8.990099009900991%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0025__p17782144615506">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.03960396039604%" 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="59.4059405940594%" 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="19.94059405940594%" 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="9.594059405940595%" 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="10.950495049504951%" 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="59.51485148514851%" 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="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p923516182237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p923551818236">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p3235618162318">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row18235131817239"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p723541862319">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p02351918102319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p22351187234">Type of a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row162353182230"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p18235818132312">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p162351318122316">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p132351318152311">Queue to which a job is submitted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row2236518172310"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p42361218112315">owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p42369185233">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p2236121812232">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p192362018142313">User who submits a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1523681852317"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p12236191812311">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p923691852314">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p10236191862311">Time when a job is started. The timestamp is expressed in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row142361218142312"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p32369184237">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p323681852313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p12236918162310">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p923731815236">Job running duration (unit: millisecond).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row0237218152310"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p112375182234">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p18237181812235">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p12237181814231">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p10237141862310">Status of a job, including <strong id="dli_02_0025__b842352706152411">LAUNCHING</strong>, <strong id="dli_02_0025__b842352706152415">RUNNING</strong>, <strong id="dli_02_0025__b842352706152419">FINISHED</strong>, <strong id="dli_02_0025__b842352706152421">FAILED</strong>, and <strong id="dli_02_0025__b842352706152425">CANCELLED</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row132376187236"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p923701815239">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1238151818233">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p7238171852316">Number of records scanned during the Insert job execution.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1123801820239"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p10238111814237">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p22381418132313">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1223891822314">Number of error records scanned during the Insert job execution.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row4238201892319"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p14239101818231">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p9239151892312">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1823951882316">Size of scanned files during job execution.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row1123931818235"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p92390187236">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p15239131822312">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><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>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row023961892316"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p2024091812231">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1724017181237">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><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>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row224013188231"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p182405181235">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p182409185239">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><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>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row18241151812317"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p0241151862316">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p82411818142314">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p192411518192318">Import jobs, which record whether the imported data contains column names.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row924291812313"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p112423189233">detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p824213185234">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p024261817231">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p8242318162314">JSON string of related columns queried using SQL statements.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row9242141852316"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p324219181230">statement</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p3242171811237">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1924351832310">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p162431318102319">SQL statements of a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row8735171173719"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p673581173711">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p573513120370">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p1373561203717">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p1735191133715">System prompt</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row16555175915364"><td class="cellrowborder" valign="top" width="19.94059405940594%" 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="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p1562219413372">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0025__p86224414378">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p155535943612">Job end time. The timestamp is in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0025__row732232174112"><td class="cellrowborder" valign="top" width="19.94059405940594%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0025__p13224210419">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.594059405940595%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0025__p20323152114117">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.950495049504951%" 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="59.51485148514851%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0025__p15323229418">Job tags. For details, see <a href="#dli_02_0025__table9391124139">Table 5</a>.</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__p5401021139">Tag key</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__p16411125137">Tag value</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>
|
|
|