文档

GetTableObjects - 查询表信息

更新时间:

查询表信息。

接口说明

  • 地域的公网接入地址:adb.<region-id>.aliyuncs.com。示例:adb.cn-hangzhou.aliyuncs.com
  • 地域的 VPC 接入地址:adb-vpc.<region-id>.aliyuncs.com。示例:adb-vpc.cn-hangzhou.aliyuncs.com

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
adb:getTableObjectsget
  • DBClusterLakeVersion
    acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

请求参数

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

数据库名称。

adb_demo
OrderBystring

排序字段。 类型取值:

  • Asc;
  • Desc;

域取值: -TableName; -TableSize; -CreateTime; -UpdateTime;

默认值:{"Type": "Desc","Field": "TableName"};

{"Type": "Desc","Field": "TableName"}
FilterTblNamestring

表名。

test_tbl
PageNumberlong

页码,取值为大于 0 且不超过 Integer 数据类型的最大值。默认值为 1

1
PageSizelong

每页记录数,取值:

  • 30;
  • 50;
  • 100;

默认值:30。

30
DBClusterIdstring

集群 ID。

am-bp1565u55p32****
FilterTblTypestring

表类型。 取值:

-DIMENSION_TABLE

-FACT_TABLE

-EXTERNAL_TABLE

默认值:空

FACT_TABLE
FilterOwnerstring

所有者。

admin
FilterDescriptionstring

描述。

description
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

863D51B7-5321-41D8-A0B6-A088B0******
PageNumberlong

页码,取值为正整数。默认值为 1

1
PageSizelong

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
TotalCountlong

总记录数。

1
Dataobject

返回数据。

PageNumberlong

页码,取值为正整数。默认值为 1

1
PageSizelong

每页记录数,取值:

  • 30(默认值)
  • 50
  • 100
30
TotalCountlong

总记录数。

1
TableSummaryModelsarray

结果数组。

TableSummaryModel

表概要信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "863D51B7-5321-41D8-A0B6-A088B0******",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 1,
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TotalCount": 1,
    "TableSummaryModels": [
      {
        "SchemaName": "schemaName",
        "TableName": "tableName",
        "TableType": "PHYSICAL_SCHEMA_NAME",
        "TableSize": 1234,
        "CreateTime": "2023-01-05 13:17:55",
        "UpdateTime": "2023-01-05 13:17:55",
        "SQL": "create table(a varchar)",
        "Description": "descrtiption",
        "Owner": "abc"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MDS.IllegalArgumentInvalid argument.用户使用了非法参数
400MDS.InvalidPrivilegeNo permissions.用户无权限进行操作
400MDS.MetaSchemaAlreadyExistThe database already exists.数据库已存在
400MDS.MetaSchemaNotExistThe database does not exist.操作的数据库不存在
400MDS.MetaTableAlreadyExistThe table already exists.操作的表已经存在
400MDS.MetaTableNotExistThe table is not found.操作的表不存在
500MDS.InternalErrorAn internal MDS error occurred.MDS服务内部错误
500MDS.MetaVisitErrorFailed to access metadata.访问元数据失败

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

变更历史

变更时间变更内容概要操作
2024-08-20OpenAPI 错误码发生变更查看变更详情
2023-10-25OpenAPI 错误码发生变更查看变更详情
2023-03-22OpenAPI 错误码发生变更查看变更详情