文档首页/ 数据湖探索 DLI/ API参考/ 历史API/ 表相关API（废弃）/ 查询所有表（废弃）
更新时间：2024-03-15 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询所有表（废弃）

功能介绍

该API用于查询指定数据库下符合过滤条件的或所有的表信息。

当前接口已废弃，不推荐使用。

URI

  • URI格式：

    GET /v1.0/{project_id}/databases/{database_name}?keyword=tb&with-detail=true

  • 参数说明
    表1 URI 参数

    名称

    是否必选

    说明

    project_id

    是

    项目编号，用于资源隔离。获取方式请参考获取项目ID。

    database_name

    是

    查看表所在的数据库名称。

    keyword

    否

    过滤表名称的关键词。

    with-detail

    否

    是否获取表的详细信息（所有者，size等）。

请求消息

无请求参数。

响应消息

表2 响应参数

参数

是否必选

参数类型

说明

is_success

是

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

是

String

系统提示信息，执行成功时，信息可能为空。

table_count

是

Integer

表的总个数。

tables

是

Array of objects

表的信息。具体参数请参见表3。
表3 tables参数

参数

是否必选

参数类型

说明

create_time

是

Long

表创建时间。是单位为“毫秒”的时间戳。

data_type

否

String

所列OBS表数据的类型，目前支持：parquet、ORC、CSV、JSON格式。只有OBS表有该参数，DLI表没有该参数。

data_location

是

String

数据存储的地方，分OBS表、DLI表，View。

last_access_time

是

Long

最近更新时间。是单位为“毫秒”的时间戳。

location

否

String

OBS表上的存储路径。

owner

是

String

表创建者。

table_name

是

String

表名称。

table_size

是

Long

DLI表的大小。非DLI表该参数值为0。

table_type

是

String

表类型。

  • OBS表为EXTERNAL
  • DLI表为MANAGED
  • View为VIEW

partition_columns

否

Array of Strings

分区字段。只有OBS分区表有该参数，其他表没有该参数。

若URI中的过滤条件“with-detail=false”，则只返回“data_location”，“table_name”，“table_type”三个参数。

示例

  • 请求样例： 
    None
  • 成功响应样例： 
    {
  "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"
    }
  ]
}

    调用API出错后，将不会返回上述结果，而是返回错误码和错误信息，详细介绍请参见错误码。

相关文档