文档

ListTableMetas - 获取数据表列表

更新时间:

获取数据表列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/tablemetas

请求参数

名称类型必填描述示例值
Typestring

数据表类型。

  • MaxCompute

  • Hologres

MaxCompute
Namestring

表名称过滤。

test1
Modulestring

数据表模块。

  • ABTest-实验数据表。

  • ExperimentTool-实验工具表。

  • DataDiagnosis-数据诊断

ABTest
PageNumberinteger

页码。

1
PageSizeinteger

页大小。

10
InstanceIdstring

实例 ID,可通过接口 ListInstances 获取。

pairec-cn-test1

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
TotalCountlong

总个数。

20
TableMetasobject []

数据表列表。

TableMetaIdstring

数据表 ID。

3
Namestring

数据表名称。

test_table
Descriptionstring

数据表描述。

this is a test table
ResourceIdstring

资源 ID。

reso-2s416t***
TableNamestring

数据库中的表名。

table_mysql
Typestring

数据表类型。

  • MaxCompute

  • Hologres

MaxCompute
Modulestring

数据表模块

  • ABTest-实验数据表。

  • ExperimentTool-实验工具表。

  • DataDiagnosis-数据诊断

ABTest
CanDeleteboolean

是否可以删除,如果表在其他地方正在被引用,则返回 false。

true
GmtCreateTimestring

创建时间。

2021-12-12 12:24:33
GmtModifiedTimestring

更新时间。

2021-12-12 12:24:33
GmtImportedTimestring

字段导入时间。

imprecation
Fieldsobject []

表的字段列表。

Namestring

字段名称。

gender
Meaningstring

字段含义。

the gender of people
Typestring

字段类型。

BIGINT
IsDimensionFieldboolean

是否是维度字段。

false
Urlstring

如果是 MaxCompute 表,此处为数据地图的表的链接。

https://dmc-xxx.com/dm/table/xxx
Configstring

数据表的一些额外的配置。

{"table_type":"item"}

示例

正常返回示例

JSON格式

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "TotalCount": 20,
  "TableMetas": [
    {
      "TableMetaId": "3",
      "Name": "test_table",
      "Description": "this is a test table",
      "ResourceId": "reso-2s416t***",
      "TableName": "table_mysql",
      "Type": "MaxCompute",
      "Module": "ABTest",
      "CanDelete": true,
      "GmtCreateTime": "2021-12-12 12:24:33",
      "GmtModifiedTime": "2021-12-12 12:24:33",
      "GmtImportedTime": "imprecation",
      "Fields": [
        {
          "Name": "gender",
          "Meaning": "the gender of people",
          "Type": "BIGINT",
          "IsDimensionField": false
        }
      ],
      "Url": "https://dmc-xxx.com/dm/table/xxx",
      "Config": "{\"table_type\":\"item\"}"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更