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>
371 lines
31 KiB
HTML
371 lines
31 KiB
HTML
<a name="dli_02_0105"></a><a name="dli_02_0105"></a>
|
|
|
|
<h1 class="topictitle1">Querying All Tables (Recommended)</h1>
|
|
<div id="body1516173559148"><div class="section" id="dli_02_0105__s7f2609ef76ce4357a84b159e44d00781"><h4 class="sectiontitle">Function</h4><p id="dli_02_0105__en-us_topic_0069077902_p4850717">This API is used to query information about tables that meet the filtering criteria or all the tables in the specified database.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__se10f64ce4de2477d9996287115b600b1"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0105__en-us_topic_0069077902_ul57363802"><li id="dli_02_0105__en-us_topic_0069077902_li46512176">URI format<p id="dli_02_0105__en-us_topic_0069077902_p15956404"><a name="dli_02_0105__en-us_topic_0069077902_li46512176"></a><a name="en-us_topic_0069077902_li46512176"></a>GET /v1.0/{project_id}/databases/{database_name}/tables</p>
|
|
</li><li id="dli_02_0105__li11331914192316">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0105__en-us_topic_0069077902_table9389911" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameters</caption><thead align="left"><tr id="dli_02_0105__en-us_topic_0069077902_row54504408"><th align="left" class="cellrowborder" valign="top" width="17.44825517448255%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0105__a8458749b29894d3fb004a6140c9eed06">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.4987501249875%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0105__ab6639d8fdb38425c8734ebe8fd002745">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.858614138586143%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0105__p115250642115">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="56.19438056194382%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0105__en-us_topic_0069077902_p172651633147">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0105__row137651841194120"><td class="cellrowborder" valign="top" width="17.44825517448255%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0105__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.4987501249875%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0105__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.858614138586143%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0105__p1352620622115">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.19438056194382%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0105__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_0105__en-us_topic_0069077902_row48387156"><td class="cellrowborder" valign="top" width="17.44825517448255%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0105__en-us_topic_0069077902_p27045553">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.4987501249875%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0105__en-us_topic_0069077902_p43206166">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.858614138586143%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0105__p45267617212">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="56.19438056194382%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0105__p3742145010314">Name of the database where the table resides.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0105__table15424134513201" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="dli_02_0105__b175602421420">query</strong> parameter description</caption><thead align="left"><tr id="dli_02_0105__row64241545102020"><th align="left" class="cellrowborder" valign="top" width="17.818218178182182%" id="mcps1.3.2.2.2.2.2.5.1.1"><p id="dli_02_0105__p184247453200">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.128787121287871%" id="mcps1.3.2.2.2.2.2.5.1.2"><p id="dli_02_0105__p104241452205">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.0985901409859%" id="mcps1.3.2.2.2.2.2.5.1.3"><p id="dli_02_0105__p323016457215">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="55.954404559544045%" id="mcps1.3.2.2.2.2.2.5.1.4"><p id="dli_02_0105__p144241345162012">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0105__row64251451207"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p13425124518208">keyword</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p2425545142018">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p19230104522117">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p1342514451200">Keywords used to filter table names.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row1425245142014"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p6425174572019">with-detail</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p11425124516204">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p523004520218">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p134259453208">Whether to obtain detailed information about tables (such as owner and size). The default value is <strong id="dli_02_0105__b11269102111417">false</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row94907549363"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p173531822134415">page-size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p1135352213442">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p235312234419">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p15353152217446">Paging size. The minimum value is <strong id="dli_02_0105__b144415103153">1</strong> and the maximum value is <strong id="dli_02_0105__b4237714111511">100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row131016110377"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p1135422254418">current-page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p835462244419">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p153541522114417">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p14354102213441">Current page number. The minimum value is <strong id="dli_02_0105__b1487719596146">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row912918279236"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p813011277231">with-priv</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p191301627112312">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p5130182718232">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p8130102782317">Whether to return permission information.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row4130182742314"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p31312272237">table-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p71311627142315">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p19132152772313">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p20132627152316">Database table type. The options are as follows:</p>
|
|
<ul id="dli_02_0105__ul127636814410"><li id="dli_02_0105__li1830425719412"><strong id="dli_02_0105__b6479165120275">MANAGED_TABLE</strong>: DLI table</li><li id="dli_02_0105__li1833912143514"><strong id="dli_02_0105__b16617162391819">EXTERNAL_TABLE</strong>: OBS table</li><li id="dli_02_0105__li1176316810415"><strong id="dli_02_0105__b3822142382811">VIRTUAL_VIEW</strong>: view</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row54061711146"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p104101112416">datasource-type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p1941101113410">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p104117111048">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p164117111649">Data source type. The options are as follows:</p>
|
|
<ul id="dli_02_0105__ul73061162511"><li id="dli_02_0105__li199091371866">CloudTable</li><li id="dli_02_0105__li1851664214515">CSS</li><li id="dli_02_0105__li143061564512">DLI</li><li id="dli_02_0105__li8489192415612">DWS</li><li id="dli_02_0105__li1154414206518">Geomesa</li><li id="dli_02_0105__li1786564218716">HBase</li><li id="dli_02_0105__li229233157">JDBC</li><li id="dli_02_0105__li9321131185">Mongo</li><li id="dli_02_0105__li1581914221973">OBS</li><li id="dli_02_0105__li782171613818">ODPS</li><li id="dli_02_0105__li18642182612718">OpenTSDB</li><li id="dli_02_0105__li650612521677">Redis</li><li id="dli_02_0105__li149361133763">RDS</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row15652579486"><td class="cellrowborder" valign="top" width="17.818218178182182%" headers="mcps1.3.2.2.2.2.2.5.1.1 "><p id="dli_02_0105__p1661857134810">without-tablemeta</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.128787121287871%" headers="mcps1.3.2.2.2.2.2.5.1.2 "><p id="dli_02_0105__p56665724817">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.0985901409859%" headers="mcps1.3.2.2.2.2.2.5.1.3 "><p id="dli_02_0105__p2661757144817">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="55.954404559544045%" headers="mcps1.3.2.2.2.2.2.5.1.4 "><p id="dli_02_0105__p266165713481">Whether to obtain the metadata of a table. The default value is <strong id="dli_02_0105__b165271619151020">false</strong>. If this parameter is set to <strong id="dli_02_0105__b19308183112108">true</strong>, the response speed can be greatly improved.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="dli_02_0105__note1625111204618"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0105__p4262119462">The following is an example of the URL containing the <strong id="dli_02_0105__b1938113399155">query</strong> parameter:</p>
|
|
<p id="dli_02_0105__p384214764816">GET /v1.0/{project_id}/databases/{database_name}/tables<i><span class="varname" id="dli_02_0105__varname88422711480">?keyword=tb&with-detail=true</span></i></p>
|
|
</div></div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__s8cae0d99468d48bf87e3d8d1c203d620"><h4 class="sectiontitle">Request</h4><p id="dli_02_0105__p38067926152157">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__s7cabf81dadd44774acfb66ac5fa1380b"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0105__en-us_topic_0069077902_table35569146" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0105__en-us_topic_0069077902_row23983098"><th align="left" class="cellrowborder" valign="top" width="17.633663366336634%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0105__a0184bd526dfb42038b3db4f12de3d6d8">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.485148514851485%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0105__a27a9819d4d8141ad98b8893312a3b03f">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="19.59405940594059%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0105__a77f706449efc4f24b778ed2b7b860c69">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="52.28712871287129%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0105__a4f8cac6b5814498ab46cae6c1db07e8d">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0105__en-us_topic_0069077902_row6962642"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0105__en-us_topic_0069077902_p27103168">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0105__en-us_topic_0069077902_p47873010">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59405940594059%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0105__en-us_topic_0069077902_p52508625">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0105__p3346192311417">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0105__parmvalue150180616947"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__en-us_topic_0069077902_row26735465"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0105__en-us_topic_0069077902_p18089046">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0105__en-us_topic_0069077902_p55926603">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59405940594059%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0105__en-us_topic_0069077902_p33761009">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0105__p4346723111420">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__en-us_topic_0069077902_row49931759"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0105__en-us_topic_0069077902_p17940710">table_count</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0105__en-us_topic_0069077902_p43911368">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59405940594059%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0105__en-us_topic_0069077902_p51071">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0105__en-us_topic_0069077902_p4136819">Total number of tables.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row6296920173020"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0105__p829618203306">tables</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0105__p9296320193015">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="19.59405940594059%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0105__p14296122019308">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="52.28712871287129%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0105__p42966203309">Table information. For details, see <a href="#dli_02_0105__table6846515164814">Table 4</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0105__table6846515164814"></a><a name="table6846515164814"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0105__table6846515164814" frame="border" border="1" rules="all"><caption><b>Table 4 </b>tables parameters</caption><thead align="left"><tr id="dli_02_0105__row4847515144816"><th align="left" class="cellrowborder" valign="top" width="17.633663366336634%" id="mcps1.3.4.3.2.5.1.1"><p id="dli_02_0105__p88475154489">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.485148514851485%" id="mcps1.3.4.3.2.5.1.2"><p id="dli_02_0105__p18847161519482">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.643564356435643%" id="mcps1.3.4.3.2.5.1.3"><p id="dli_02_0105__p1384721513484">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60.237623762376245%" id="mcps1.3.4.3.2.5.1.4"><p id="dli_02_0105__p11847121554818">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0105__row9851191520480"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p68516156486">create_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p1585210155484">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p10852181517488">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p68523158486">Time when a table is created. The timestamp is expressed in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row1485213150487"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p17852715134820">data_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p58521315124818">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p1885212158488">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p1618124103812">Type of the data to be added to the OBS table. The options are as follows: Parquet, ORC, CSV, JSON, and Avro.</p>
|
|
<div class="note" id="dli_02_0105__note1399788114415"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0105__p701593441">This parameter is available only for OBS tables.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row485281544818"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p17852191515482">data_location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p98530152482">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p15853101534811">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p78530153486">Data storage location, which can be DLI or OBS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row2853121554819"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p12853181584814">last_access_time</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p168538154484">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p1985317159484">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p10853101519481">Time when the table was last updated. The timestamp is expressed in milliseconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row585481564814"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p58541615144814">location</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p19854151516483">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p12854101516483">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p75818883812">Storage path on the OBS table.</p>
|
|
<div class="note" id="dli_02_0105__note636772814443"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0105__p73671928174414">This parameter is available only for OBS tables.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row38541915114814"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p20854131513489">owner</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p485417150489">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p685481564813">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p5855121554819">Table owner.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row885551584812"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p08553152482">table_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p128551015184811">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p1885514158484">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p485531516485">Name of a table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row585571584819"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p58551915174817">table_size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p14855171520485">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p13855815104815">Long</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p10856101554812">Size of a DLI table. Set parameter to <strong id="dli_02_0105__b19888124915585">0</strong> for non-DLI tables. The unit is byte.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row98561315124815"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p1685661517486">table_type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p7856141524810">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p1285617156482">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p5856171514811">Type of a table.</p>
|
|
<ul id="dli_02_0105__ul2856515104816"><li id="dli_02_0105__li18568158488"><strong id="dli_02_0105__b842352706154840">EXTERNAL</strong>: Indicates an OBS table.</li><li id="dli_02_0105__li13856515164816"><strong id="dli_02_0105__b842352706154853">MANAGED</strong>: Indicates a DLI table.</li><li id="dli_02_0105__li1785691594810"><strong id="dli_02_0105__b84235270615496">VIEW</strong>: Indicates a view.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row4856201504810"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p10857201554814">partition_columns</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p14857715114810">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p10857191520487">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p8857315124815">Partition field. This parameter is valid only for OBS partition tables.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row20857115204820"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p1985741554811">page-size</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p485713156489">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p10857715194810">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p7857015104810">Paging size. The minimum value is <strong id="dli_02_0105__b1596273648">1</strong> and the maximum value is <strong id="dli_02_0105__b1385158617">100</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row1857151511484"><td class="cellrowborder" valign="top" width="17.633663366336634%" headers="mcps1.3.4.3.2.5.1.1 "><p id="dli_02_0105__p178571157486">current-page</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.485148514851485%" headers="mcps1.3.4.3.2.5.1.2 "><p id="dli_02_0105__p3857715184816">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.643564356435643%" headers="mcps1.3.4.3.2.5.1.3 "><p id="dli_02_0105__p118571315174819">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60.237623762376245%" headers="mcps1.3.4.3.2.5.1.4 "><p id="dli_02_0105__p28581915194814">Current page number. The minimum value is <strong id="dli_02_0105__b1457163116152">1</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div class="note" id="dli_02_0105__note62647935152125"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dli_02_0105__p2790304911242">If <strong id="dli_02_0105__b842352706144312">with-detail</strong> is set to <strong id="dli_02_0105__b842352706144318">false</strong> in the URI, only values of tables-related parameters <span class="parmname" id="dli_02_0105__parmname9860147152242"><b>data_location</b></span>, <span class="parmname" id="dli_02_0105__parmname20084717152251"><b>table_name</b></span>, and <span class="parmname" id="dli_02_0105__parmname21010420152257"><b>table_type</b></span> are returned.</p>
|
|
</div></div>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__section1835742415112"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0105__p810253431112">None</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__section6600445715217"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0105__screen28478225152127">{
|
|
"is_success": true,
|
|
"message": "",
|
|
"table_count": 1,
|
|
"tables": [
|
|
{ "create_time":1517364268000,
|
|
"data_location":"OBS",
|
|
"data_type":"csv",
|
|
"last_access_time":1517364268000,
|
|
"location":"obs://DLI/sqldata/data.txt",
|
|
"owner":"test",
|
|
"partition_columns": ["a0"],
|
|
"table_name":"obs_t",
|
|
"table_size":0,
|
|
"table_type":"EXTERNAL"
|
|
}
|
|
]
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0105__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0105__tb12870f1c5f24b27abd55ca24264af36">Table 5</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0105__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0105__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0105__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0105__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_0105__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0105__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0105__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0105__p104431642124811">The query is successful.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0105__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0105__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0105__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0105__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0105__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0105__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0105__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_0031.html">Table-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|