查询所有表(推荐)
功能介绍
该API用于查询指定数据库下符合过滤条件的或所有的表信息。
URI
- URI格式:
- 参数说明
表1 URI 参数 参数名称
是否必选
参数类型
说明
project_id
是
String
项目编号,用于资源隔离。获取方式请参考获取项目ID。
database_name
是
String
查看表所在的数据库名称。
表2 query参数 参数名称
是否必选
参数类型
说明
keyword
否
String
过滤表名称的关键词。
with-detail
否
Boolean
是否获取表的详细信息(所有者,size等)。默认值为“false”。
page-size
否
Integer
分页大小,最小为1,最大为100。
current-page
否
Integer
当前页码,最小为1。
with-priv
否
Boolean
是否返回权限信息。
table-type
否
String
数据库表类型。包含以下类型:
- DLI表: MANAGED_TABLE
- OBS表 : EXTERNAL_TABLE
- 视图:VIRTUAL_VIEW
datasource-type
否
String
数据源类型。包括如下类型:
- CloudTable
- CSS
- DLI
- DWS
- Geomesa
- HBase
- JDBC
- Mongo
- OBS
- ODPS
- OpenTSDB
- Redis
- RDS
without-tablemeta
否
Boolean
是否获取表的元数据。默认值为“false”。该参数为“true”时,可以大大提高响应速度。
带入query参数的URL示例如下:
GET /v1.0/{project_id}/databases/{database_name}/tables?keyword=tb&with-detail=true
请求消息
无请求参数。
响应消息
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
is_success |
是 |
Boolean |
执行请求是否成功。“true”表示请求执行成功。 |
message |
是 |
String |
系统提示信息,执行成功时,信息可能为空。 |
table_count |
是 |
Integer |
表的总个数。 |
tables |
是 |
Array of Objects |
表的信息。具体参数请参见表4。 |
参数名称 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
create_time |
是 |
Long |
表创建时间。是单位为“毫秒”的时间戳。 |
data_type |
否 |
String |
所列OBS表数据的类型,目前支持:parquet、ORC、CSV、JSON、Avro格式。
说明:
只有OBS表有该参数。 |
data_location |
是 |
String |
数据存储位置,分为DLI和OBS。 |
last_access_time |
是 |
Long |
最近更新时间。是单位为“毫秒”的时间戳。 |
location |
否 |
String |
OBS表的存储路径。
说明:
只有OBS表有该参数。 |
owner |
是 |
String |
表创建者。 |
table_name |
是 |
String |
表名称。 |
table_size |
是 |
Long |
DLI表的大小。非DLI表该参数值为0。单位为“Byte”。 |
table_type |
是 |
String |
表类型。
|
partition_columns |
否 |
String |
分区字段。只有OBS分区表有该参数,其他表没有该参数。 |
page-size |
否 |
Integer |
分页大小,最小为1,最大为100。 |
current-page |
否 |
Integer |
当前页码,最小为1。 |
若URI中的过滤条件“with-detail=false”,则tables相关参数中只返回“data_location”,“table_name”,“table_type”三个参数。
请求示例
无
响应示例
{ "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" } ] }
错误码
调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码。