更新时间:2022-04-16 GMT+08:00
分享

查询所有表(推荐)

功能介绍

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

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

    GET /v1.0/{project_id}/databases/{database_name}/tables

  • 参数说明
    表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
    • 非DLI表 : 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

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

table_count

Integer

表的总个数。

tables

Array of Objects

表的信息。具体参数请参见表4

表4 tables参数

参数名称

是否必选

参数类型

说明

create_time

Long

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

data_type

String

所列OBS表数据的类型,目前支持:parquet、ORC、CSV、JSON、Carbon、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

表类型。

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

partition_columns

String

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

page-size

Integer

分页大小,最小为1,最大为100。

current-page

Integer

当前页码,最小为1。

若URI中的过滤条件“with-detail=false”,则tables相关参数中只返回“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"
        }
      ]
    }

状态码

状态码如表5所示。

表5 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后,将不会返回上述结果,而是返回错误码和错误信息,更多介绍请参见错误码

分享:

    相关文档

    相关产品

close