forked from docs/doc-exports
Su, Xiaomeng
2374069890
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>
320 lines
26 KiB
HTML
320 lines
26 KiB
HTML
<a name="dli_02_0021"></a><a name="dli_02_0021"></a>
|
|
|
|
<h1 class="topictitle1">Querying Job Status</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0021__s496342c202f14ee79328ef1d402370a2"><h4 class="sectiontitle">Function</h4><p id="dli_02_0021__a9e89764c58f24d5cae153304d1bec3f2">This API is used to query the status of a submitted job.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__s7b7722e9846948a786d2c664268e3089"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0021__ul36961315135814"><li id="dli_02_0021__li3696181535820">URI format<p id="dli_02_0021__en-us_topic_0069077810_p47440974"><a name="dli_02_0021__li3696181535820"></a><a name="li3696181535820"></a>GET /v1.0/{project_id}/jobs/{job_id}/status</p>
|
|
</li></ul>
|
|
<ul id="dli_02_0021__ul2082442515584"><li id="dli_02_0021__li17824182510581">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0021__en-us_topic_0069077810_table24315590" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0021__en-us_topic_0069077810_row46073164"><th align="left" class="cellrowborder" valign="top" width="11.521152115211521%" id="mcps1.3.2.3.1.1.2.5.1.1"><p id="dli_02_0021__a8d97f8ce4ef844a98f45f8ad3d9785ad">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.65106510651065%" id="mcps1.3.2.3.1.1.2.5.1.2"><p id="dli_02_0021__a1e25efb113014e3ab7d852b5785f1243">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.111211121112111%" id="mcps1.3.2.3.1.1.2.5.1.3"><p id="dli_02_0021__p57416282401">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="65.71657165716572%" id="mcps1.3.2.3.1.1.2.5.1.4"><p id="dli_02_0021__ad2abe90beeaa4b18a1a527322bfec29b">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0021__row105081938174012"><td class="cellrowborder" valign="top" width="11.521152115211521%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.65106510651065%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.111211121112111%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dli_02_0021__p97582894016">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.71657165716572%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dli_02_0021__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>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row23325002"><td class="cellrowborder" valign="top" width="11.521152115211521%" headers="mcps1.3.2.3.1.1.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p10277022">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.65106510651065%" headers="mcps1.3.2.3.1.1.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p27132417">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.111211121112111%" headers="mcps1.3.2.3.1.1.2.5.1.3 "><p id="dli_02_0021__p117522824019">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="65.71657165716572%" headers="mcps1.3.2.3.1.1.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p50242206">Job ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__section747724121"><h4 class="sectiontitle">Request</h4><p id="dli_02_0021__p23245053165614">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__s1bb1f6041ed74a2f95c4381892f77c43"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0021__en-us_topic_0069077810_table54649100" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0021__en-us_topic_0069077810_row12270800"><th align="left" class="cellrowborder" valign="top" width="18.990000000000002%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0021__en-us_topic_0069077810_p632755735911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.2%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0021__en-us_topic_0069077810_p132745725917">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="15.85%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0021__en-us_topic_0069077810_p632795716598">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="49.96%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0021__aa7dfa3e390954ecc98c289dd0d13b610">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0021__en-us_topic_0069077810_row34167206"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p16080284">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p27434664">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p7615279">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p12857883">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0021__parmvalue6365117116526"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row48612091"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p45265273">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p42608463">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p28733478">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, this parameter is left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row8740180"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p36865955">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p33352367">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p17187167">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p49983259">Job ID. 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_0021__en-us_topic_0069077810_row47196154"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p64792116">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p13670063">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p33533331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__a2b151253b7da4442994ace501caef7ea">Type of a job, Includes <strong id="dli_02_0021__b197015179458">DDL</strong>, <strong id="dli_02_0021__b20174112084518">DCL</strong>, <strong id="dli_02_0021__b15742152614459">IMPORT</strong>, <strong id="dli_02_0021__b29611301458">EXPORT</strong>, <strong id="dli_02_0021__b191448337459">QUERY</strong>, <strong id="dli_02_0021__b1332837154511">INSERT</strong>, <strong id="dli_02_0021__b81552415454">DATA_MIGRATION</strong>, <strong id="dli_02_0021__b11529154414513">UPDATE</strong>, <strong id="dli_02_0021__b178795489452">DELETE</strong>, <strong id="dli_02_0021__b556735244511">RESTART_QUEUE</strong> and <strong id="dli_02_0021__b29995714519">SCALE_QUEUE</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row1848743343014"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__p94886334306">job_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__p44881533123013">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__p5488533113013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p4229105292420">Job execution mode. The options are as follows:</p>
|
|
<ul id="dli_02_0021__ul194411241202517"><li id="dli_02_0021__li16442124112518"><strong id="dli_02_0021__b102141865418">async</strong>: asynchronous</li><li id="dli_02_0021__li2441252182510"><strong id="dli_02_0021__b14208796545">sync</strong>: synchronous</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row18171838"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p62632782">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p40090562">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p26110083">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p34541944">Name of the queue where the job is submitted.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row42442041"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p15253336">owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p27560736">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p17827128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p128555228506">User who submits a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row43965709"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p4452677">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p25122570">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p21662275">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p9813849">Time when a job is started. The timestamp is in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row51786216"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p33934001">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p64299566">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p40882376">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p23138150">Job running duration (unit: millisecond).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row6916762"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p23386874">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p15288659">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p30421836">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p48249613">Status of a job, including <strong id="dli_02_0021__b1994219559466">RUNNING</strong>, <strong id="dli_02_0021__b112591559144615">SCALING</strong>, <strong id="dli_02_0021__b1290616211472">LAUNCHING</strong>, <strong id="dli_02_0021__b117269471">FINISHED</strong>, <strong id="dli_02_0021__b16712189194717">FAILED</strong>, and <strong id="dli_02_0021__b13763131224719">CANCELLED</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row11848732145518"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__p158492320554">input_row_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__p1784983215513">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__p08493320558">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p148493324559">Number of records scanned during the Insert job execution.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row156471176381"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__p2647121712382">bad_row_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__p5649417173811">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__p106495177381">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p064971733814">Number of error records scanned during the Insert job execution.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row31593336"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p8923449">input_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p51710807">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p27825849">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p39301320">Size of scanned files during job execution (unit: byte).</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row18167563"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p62286536">result_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p12044645">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p36092170">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p37784672">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_0021__en-us_topic_0069077810_row4517733"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p30392070">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p45838637">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p21942079">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p32508492111553">Name of the database where the target table resides. <span class="parmname" id="dli_02_0021__parmname525455711164"><b>database_name</b></span> is valid only for jobs of the <strong id="dli_02_0021__b842352706153533">IMPORT</strong> <strong id="dli_02_0021__b842352706153537">EXPORT</strong>, and <strong id="dli_02_0021__b1351414810507">QUERY</strong> types.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row23866461"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p54135198">table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p22874919">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p40929185">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p14938010111616">Name of the target table. <span class="parmname" id="dli_02_0021__parmname655420064153549"><b>table_name</b></span> is valid only for jobs of the <strong id="dli_02_0021__b9319162675816">IMPORT</strong> <strong id="dli_02_0021__b1531962615583">EXPORT</strong>, and <strong id="dli_02_0021__b113191026195811">QUERY</strong> types.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row192841922151818"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__p82841122111811">detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__p82840223185">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__p628492211816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p1928412216186">JSON character string for information about related columns.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row41040854"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p35974848">statement</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p28281558">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p9104898">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__en-us_topic_0069077810_p66408105">SQL statements of a job.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row18751145274619"><td class="cellrowborder" valign="top" width="18.990000000000002%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0021__p49794914011">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.2%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0021__p597149114018">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="15.85%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0021__p451066135816">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="49.96%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0021__p55101469587">Job tags. For details, see <a href="#dli_02_0021__table9391124139">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0021__table9391124139"></a><a name="table9391124139"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0021__table9391124139" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags parameters</caption><thead align="left"><tr id="dli_02_0021__row1440020130"><th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0021__p194012219139">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.83%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0021__p540724136">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0021__p840162161315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.8%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0021__p16401271318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0021__row194013231317"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0021__p13401329138">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.83%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0021__p940102141313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0021__p64019231317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0021__p5401021139">Tag key</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row1141142181320"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0021__p164118215134">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.83%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0021__p1141112181317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0021__p174114281318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0021__p16411125137">Tag value</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__section1267554313159"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0021__p16826101012164">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__section54022231174439"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0021__screen58317288174531">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"job_id": "208b08d4-0dc2-4dd7-8879-ddd4c020d7aa",
|
|
"job_type": "QUERY",
|
|
"job_mode":"async",
|
|
"queue_name": "default",
|
|
"owner": "test",
|
|
"start_time": 1509335108918,
|
|
"duration": 2523,
|
|
"status": "FINISHED",
|
|
"input_size": 22,
|
|
"result_count": 4,
|
|
"database_name":"dbtest",
|
|
"table_name":"tbtest",
|
|
"detail": "{\"type\":\"struct\",\"fields\":[{\"name\":\"id\",\"type\":\"integer\",\"nullable\":true,\"metadata\":{}},{\"name\":\"name\",\"type\":\"string\",\"nullable\":true,\"metadata\":{}}]}",
|
|
"statement": "select * from t1"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0021__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0021__tb12870f1c5f24b27abd55ca24264af36">Table 4</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0021__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0021__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Status codes</caption><thead align="left"><tr id="dli_02_0021__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0021__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_0021__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0021__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0021__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0021__p104431642124811">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0021__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0021__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0021__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0021__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0021__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Code</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0017.html">Job-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|