forked from docs/doc-exports
Su, Xiaomeng
04ae6632a7
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>
400 lines
34 KiB
HTML
400 lines
34 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 descriptions
|
|
<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__p12841111193519"><strong id="dli_02_0021__b144702225441040">Definition</strong></p>
|
|
<p id="dli_02_0021__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_0021__p476513559276">Example: <strong id="dli_02_0021__b63888227942751">48cc2c48765f481480c7db940d6409d1</strong></p>
|
|
<p id="dli_02_0021__p1779921913513"><strong id="dli_02_0021__b194265028941054">Constraints</strong></p>
|
|
<p id="dli_02_0021__p16166233143510">None</p>
|
|
<p id="dli_02_0021__p19789423113517"><strong id="dli_02_0021__b886471994057">Range</strong></p>
|
|
<p id="dli_02_0021__p20527112713361">The value can contain 1 to 64 characters. Only letters and digits are allowed.</p>
|
|
<p id="dli_02_0021__p1049772653519"><strong id="dli_02_0021__b5475340214741">Default Value</strong></p>
|
|
<p id="dli_02_0021__p6928441113513">None</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__p64031311284"><strong id="dli_02_0021__b165210150241040">Definition</strong></p>
|
|
<p id="dli_02_0021__p5401713172816">Job ID. For details about how to obtain a job ID, see <a href="dli_02_0022.html">Querying Job Details</a>.</p>
|
|
<p id="dli_02_0021__p1340131317288">Example: <strong id="dli_02_0021__b76741357101512">6d2146a0-c2d5-41bd-8ca0-ca9694ada992</strong></p>
|
|
<p id="dli_02_0021__p12405138284"><strong id="dli_02_0021__b17561615841054">Constraints</strong></p>
|
|
<p id="dli_02_0021__p18401513142811">None</p>
|
|
<p id="dli_02_0021__p154071314283"><strong id="dli_02_0021__b3376906334057">Range</strong></p>
|
|
<p id="dli_02_0021__p1040191314282">The value can contain 1 to 64 characters. Only letters and digits are allowed.</p>
|
|
<p id="dli_02_0021__p340141352814"><strong id="dli_02_0021__b5650044644741">Default Value</strong></p>
|
|
<p id="dli_02_0021__p740513162819">None</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__section747724121"><h4 class="sectiontitle">Request Parameters</h4><p id="dli_02_0021__p23245053165614">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0021__s1bb1f6041ed74a2f95c4381892f77c43"><h4 class="sectiontitle">Response Parameters</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="22.39%" id="mcps1.3.4.2.2.4.1.1"><p id="dli_02_0021__en-us_topic_0069077810_p632755735911">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="18.67%" id="mcps1.3.4.2.2.4.1.2"><p id="dli_02_0021__en-us_topic_0069077810_p632795716598">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.940000000000005%" id="mcps1.3.4.2.2.4.1.3"><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="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p16080284">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p7615279">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1311013183019"><strong id="dli_02_0021__b179387415341040">Definition</strong></p>
|
|
<p id="dli_02_0021__p1936416103301">Whether the request is successfully executed</p>
|
|
<p id="dli_02_0021__p1911017313013"><strong id="dli_02_0021__b21469366884057">Range</strong></p>
|
|
<p id="dli_02_0021__p1811011313014"><strong id="dli_02_0021__b289518913163">true</strong> indicates that the request is successfully executed.</p>
|
|
<p id="dli_02_0021__p536962413017"><strong id="dli_02_0021__b133171631610">false</strong> indicates that the request fails to be executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row48612091"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p45265273">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p28733478">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p12387132793117"><strong id="dli_02_0021__b130911060341040">Definition</strong></p>
|
|
<p id="dli_02_0021__p1338713275319">System prompt. If the execution succeeds, this parameter is left blank.</p>
|
|
<p id="dli_02_0021__p1421817693318"><strong id="dli_02_0021__b1593877284057">Range</strong></p>
|
|
<p id="dli_02_0021__p6218166173316">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row8740180"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p36865955">job_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p17187167">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p13993152983115"><strong id="dli_02_0021__b184692272341040">Definition</strong></p>
|
|
<p id="dli_02_0021__p1599382923114">Job ID</p>
|
|
<p id="dli_02_0021__p395377123316"><strong id="dli_02_0021__b8956700804057">Range</strong></p>
|
|
<p id="dli_02_0021__p18953107143315">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row47196154"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p64792116">job_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p33533331">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1361911328313"><strong id="dli_02_0021__b109569937841040">Definition</strong></p>
|
|
<p id="dli_02_0021__p061953213114">Job type</p>
|
|
<p id="dli_02_0021__p26191032103117"><strong id="dli_02_0021__b20893778264057">Range</strong></p>
|
|
<p id="dli_02_0021__p1619632153114">Options: <strong id="dli_02_0021__b1211715551714">DDL</strong>, <strong id="dli_02_0021__b1811775181712">DCL</strong>, <strong id="dli_02_0021__b7117125201714">IMPORT</strong>, <strong id="dli_02_0021__b7117959178">EXPORT</strong>, <strong id="dli_02_0021__b1811785181712">QUERY</strong>, <strong id="dli_02_0021__b011715512179">INSERT</strong>, <strong id="dli_02_0021__b6117655173">DATA_MIGRATION</strong>, <strong id="dli_02_0021__b41173541718">UPDATE</strong>, <strong id="dli_02_0021__b1911714516175">DELETE</strong>, <strong id="dli_02_0021__b111177591719">RESTART_QUEUE</strong>, and <strong id="dli_02_0021__b611775101714">SCALE_QUEUE</strong>.</p>
|
|
<ul id="dli_02_0021__ul741772872214"><li id="dli_02_0021__li1041882862219"><strong id="dli_02_0021__b74887361952324">DDL</strong>: jobs that create, modify, and delete metadata files</li><li id="dli_02_0021__li1141852813224"><strong id="dli_02_0021__b166277634852340">DCL</strong>: jobs that grant and revoke permissions</li><li id="dli_02_0021__li154182028132213"><strong id="dli_02_0021__b2959772035242">IMPORT</strong>: jobs that import external data into the database</li><li id="dli_02_0021__li11418142812219"><strong id="dli_02_0021__b28478064352429">EXPORT</strong>: jobs that export data to an external database</li><li id="dli_02_0021__li6418028112217"><strong id="dli_02_0021__b81396024752443">QUERY</strong>: jobs that run query statements</li><li id="dli_02_0021__li1541842852212"><strong id="dli_02_0021__b37016524752454">INSERT</strong>: jobs that add new data to tables</li><li id="dli_02_0021__li164183283223"><strong id="dli_02_0021__b1936911358173">DATA_MIGRATION</strong>: jobs that migrate data across sources</li><li id="dli_02_0021__li341892842215"><strong id="dli_02_0021__b1731710132563">UPDATE</strong>: jobs that update table data</li><li id="dli_02_0021__li11418202817228"><strong id="dli_02_0021__b48151816195610">DELETE</strong>: jobs that delete data from specified tables</li><li id="dli_02_0021__li12418162812210"><strong id="dli_02_0021__b41527103725552">RESTART_QUEUE</strong>: jobs that restart specified queues</li><li id="dli_02_0021__li10418142822220"><strong id="dli_02_0021__b189381833115619">SCALE_QUEUE</strong>: jobs that scale in or out specified queues</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row1848743343014"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p94886334306">job_mode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p5488533113013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p7702193519314"><strong id="dli_02_0021__b105585687341040">Definition</strong></p>
|
|
<p id="dli_02_0021__p6702173543118">Job execution mode</p>
|
|
<p id="dli_02_0021__p17702193519312"><strong id="dli_02_0021__b20784416704057">Range</strong></p>
|
|
<ul id="dli_02_0021__ul174620142920"><li id="dli_02_0021__li16442124112518"><strong id="dli_02_0021__b102141865418">async</strong>: asynchronous</li><li id="dli_02_0021__li6467052916"><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="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p62632782">queue_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p26110083">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p19183038143118"><strong id="dli_02_0021__b24183184041040">Definition</strong></p>
|
|
<p id="dli_02_0021__p181453162299">Name of the queue where the job is submitted</p>
|
|
<p id="dli_02_0021__p05399311338"><strong id="dli_02_0021__b1484348944057">Range</strong></p>
|
|
<p id="dli_02_0021__p145396393310">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row42442041"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p15253336">owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p17827128">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__en-us_topic_0069077810_p128555228506"><strong id="dli_02_0021__b11443581141040">Definition</strong></p>
|
|
<p id="dli_02_0021__p4607540133117">User who submits a job</p>
|
|
<p id="dli_02_0021__p9261427334"><strong id="dli_02_0021__b13766545824057">Range</strong></p>
|
|
<p id="dli_02_0021__p5261253313">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row43965709"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p4452677">start_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p21662275">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p143286435311"><strong id="dli_02_0021__b120431514141040">Definition</strong></p>
|
|
<p id="dli_02_0021__en-us_topic_0069077810_p9813849">Time when a job is started. The timestamp is in milliseconds.</p>
|
|
<p id="dli_02_0021__p444415110331"><strong id="dli_02_0021__b2835633894057">Range</strong></p>
|
|
<p id="dli_02_0021__p14441117335">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row51786216"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p33934001">duration</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p40882376">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p17760194523111"><strong id="dli_02_0021__b189133260241040">Definition</strong></p>
|
|
<p id="dli_02_0021__p5924978308">Job running duration, in milliseconds.</p>
|
|
<p id="dli_02_0021__p20748609336"><strong id="dli_02_0021__b6998754224057">Range</strong></p>
|
|
<p id="dli_02_0021__p5748700339">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row6916762"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p23386874">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p30421836">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1216494893112"><strong id="dli_02_0021__b4347866441040">Definition</strong></p>
|
|
<p id="dli_02_0021__p71641648183116">Job status</p>
|
|
<p id="dli_02_0021__p1416584812316"><strong id="dli_02_0021__b13033569614057">Range</strong></p>
|
|
<ul id="dli_02_0021__ul088094419304"><li id="dli_02_0021__li17880114410301"><strong id="dli_02_0021__b153837391653858">RUNNING</strong>: The job is running.</li><li id="dli_02_0021__li388014441301"><strong id="dli_02_0021__b13411513102010">SCALING</strong>: The job is modifying specifications.</li><li id="dli_02_0021__li10880174418304"><strong id="dli_02_0021__b184985651154037">LAUNCHING</strong>: The job is being submitted.</li><li id="dli_02_0021__li1588024412303"><strong id="dli_02_0021__b1779520591608">FINISHED</strong>: The job has been completed.</li><li id="dli_02_0021__li888012447301"><strong id="dli_02_0021__b5867201325413">FAILED</strong>: The job has failed.</li><li id="dli_02_0021__li148802044123013"><strong id="dli_02_0021__b12205578385418">CANCELLED</strong>: The job has been canceled.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row11848732145518"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p158492320554">input_row_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p08493320558">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1333965018318"><strong id="dli_02_0021__b48931798341040">Definition</strong></p>
|
|
<p id="dli_02_0021__p433945003117">Number of records scanned during the Insert job execution</p>
|
|
<p id="dli_02_0021__p16445912321"><strong id="dli_02_0021__b973917564057">Range</strong></p>
|
|
<p id="dli_02_0021__p465759193210">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row156471176381"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p2647121712382">bad_row_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p106495177381">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1288115243118"><strong id="dli_02_0021__b176781796941040">Definition</strong></p>
|
|
<p id="dli_02_0021__p1288175253111">Number of error records scanned during the Insert job execution</p>
|
|
<p id="dli_02_0021__p24838563322"><strong id="dli_02_0021__b514811404057">Range</strong></p>
|
|
<p id="dli_02_0021__p9483856143216">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row31593336"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p8923449">input_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p27825849">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p7483105593118"><strong id="dli_02_0021__b47121907841040">Definition</strong></p>
|
|
<p id="dli_02_0021__p194841555103113">Size of files scanned during job execution, in bytes</p>
|
|
<p id="dli_02_0021__p1793075503217"><strong id="dli_02_0021__b7408621544057">Range</strong></p>
|
|
<p id="dli_02_0021__p7930155503219">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row18167563"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p62286536">result_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p36092170">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1973755814312"><strong id="dli_02_0021__b102515244041040">Definition</strong></p>
|
|
<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>
|
|
<p id="dli_02_0021__p945265413323"><strong id="dli_02_0021__b5090585244057">Range</strong></p>
|
|
<p id="dli_02_0021__p645225493215">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row4517733"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p30392070">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p21942079">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1615021123216"><strong id="dli_02_0021__b160384023041040">Definition</strong></p>
|
|
<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>
|
|
<p id="dli_02_0021__p36594714324"><strong id="dli_02_0021__b10053552014057">Range</strong></p>
|
|
<p id="dli_02_0021__p18228124813216">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row23866461"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p54135198">table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p40929185">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p58287316328"><strong id="dli_02_0021__b124613186841040">Definition</strong></p>
|
|
<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>
|
|
<p id="dli_02_0021__p882873163214"><strong id="dli_02_0021__b131907134057">Range</strong></p>
|
|
<p id="dli_02_0021__p282810333212">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row192841922151818"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p82841122111811">detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p628492211816">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1132666326"><strong id="dli_02_0021__b198150819441040">Definition</strong></p>
|
|
<p id="dli_02_0021__p0328612325">JSON string for information about related columns</p>
|
|
<p id="dli_02_0021__p17324617329"><strong id="dli_02_0021__b251697834741">Default Value</strong></p>
|
|
<p id="dli_02_0021__p10323643212">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__en-us_topic_0069077810_row41040854"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__en-us_topic_0069077810_p35974848">statement</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__en-us_topic_0069077810_p9104898">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1721085329"><strong id="dli_02_0021__b163793240941040">Definition</strong></p>
|
|
<p id="dli_02_0021__p521689327">SQL statements of a job</p>
|
|
<p id="dli_02_0021__p47821954163515"><strong id="dli_02_0021__b4203308884057">Range</strong></p>
|
|
<p id="dli_02_0021__p127822054163513">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row18751145274619"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p49794914011">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p451066135816">Array of objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1628251073213"><strong id="dli_02_0021__b202212447341040">Definition</strong></p>
|
|
<p id="dli_02_0021__p1282181093216">Job tags. For details, see <a href="#dli_02_0021__table9391124139">Table 3</a>.</p>
|
|
<p id="dli_02_0021__p128515544354"><strong id="dli_02_0021__b3067735324057">Range</strong></p>
|
|
<p id="dli_02_0021__p13851754203518">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row18890264589"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p38909263583">user_conf</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p3890172619585">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p855631293211"><strong id="dli_02_0021__b117933768541040">Definition</strong></p>
|
|
<p id="dli_02_0021__p13721159131310">Spark parameters configured when a user submits a SQL job.</p>
|
|
<p id="dli_02_0021__p137171152163520"><strong id="dli_02_0021__b14389716014057">Range</strong></p>
|
|
<p id="dli_02_0021__p147171452133512">You can set the parameter in key-value pairs. For details about the supported configuration items, see <a href="dli_02_0102.html#dli_02_0102__table334825142314">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row20305104332811"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p7374830997">result_format</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p1737523019914">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p20673101433214"><strong id="dli_02_0021__b8075427741040">Definition</strong></p>
|
|
<p id="dli_02_0021__p867318144325">Storage format of job results</p>
|
|
<p id="dli_02_0021__p940814514357"><strong id="dli_02_0021__b9919133754057">Range</strong></p>
|
|
<p id="dli_02_0021__p5408751173511">Currently, only CSV is supported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row1472711461282"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p43755304917">result_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p3375930097">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p1463913162326"><strong id="dli_02_0021__b29901155541040">Definition</strong></p>
|
|
<p id="dli_02_0021__p14639171616321">OBS path of job results</p>
|
|
<p id="dli_02_0021__p1445719501354"><strong id="dli_02_0021__b17708320844057">Range</strong></p>
|
|
<p id="dli_02_0021__p16457950193511">None</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0021__row2512656114918"><td class="cellrowborder" valign="top" width="22.39%" headers="mcps1.3.4.2.2.4.1.1 "><p id="dli_02_0021__p4512115616499">execution_details_path</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="18.67%" headers="mcps1.3.4.2.2.4.1.2 "><p id="dli_02_0021__p4512556204913">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.940000000000005%" headers="mcps1.3.4.2.2.4.1.3 "><p id="dli_02_0021__p10925151853214"><strong id="dli_02_0021__b61830684741040">Definition</strong></p>
|
|
<p id="dli_02_0021__p15125568493">OBS path of the job query execution plan.</p>
|
|
<p id="dli_02_0021__p20746249143512"><strong id="dli_02_0021__b16866955114057">Range</strong></p>
|
|
<p id="dli_02_0021__p18746194918359">None</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__p9207636173613"><strong id="dli_02_0021__b78916587441040">Definition</strong></p>
|
|
<p id="dli_02_0021__p6591241113617">Tag key</p>
|
|
<p id="dli_02_0021__p16208636163611"><strong id="dli_02_0021__b6359919044057">Range</strong></p>
|
|
<p id="dli_02_0021__p7208113616360">None</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__p11118113863619"><strong id="dli_02_0021__b205992280941040">Definition</strong></p>
|
|
<p id="dli_02_0021__p568334533610">Tag value</p>
|
|
<p id="dli_02_0021__p1111863833618"><strong id="dli_02_0021__b11653953824057">Range</strong></p>
|
|
<p id="dli_02_0021__p6118183812361">None</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 status codes.</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 server 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 called, the system does not return the result similar to the preceding example, but returns an error code and error message. 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>
|
|
|