GetTableColumns - 查询列信息

更新时间:

查询列信息。

接口说明

  • 地域的公网接入地址: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:getTableColumnsget
*DBClusterLakeVersion
acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}

请求参数

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

数据库名。

adb_demo
TableNamestring

表名。

test
ColumnNamestring

列名。

assist_user_phone
PageNumberlong

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

1
PageSizelong

每页记录数,取值范围如下:

  • 30(默认值)。
  • 50
  • 100
30
DBClusterIdstring

集群 ID。

amv-bp11q28kvl688****
RegionIdstring

地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumberlong

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

1
PageSizelong

每页记录数,取值范围如下:

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

结果中数据的总条数。

15
Dataobject

返回数据。

PageNumberlong

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

1
PageSizelong

每页记录数,取值范围如下:

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

结果中数据的总条数。

15
TableTableDetailModel

表的详细信息。

示例

正常返回示例

JSON格式

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 15,
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TotalCount": 15,
    "Table": {
      "SchemaName": "schemaName",
      "TableName": "tableName",
      "TableType": "PHYSICAL_SCHEMA_NAME",
      "CreateTime": "2023-01-05 13:17:55",
      "UpdateTime": "2023-01-05 13:17:55",
      "Description": "Description",
      "Owner": "abc",
      "Columns": [
        {
          "ColumnName": "example",
          "Type": "string",
          "Description": "description",
          "SchemaName": "schemaName",
          "TableName": "tableName",
          "CreateTime": "2023-01-05'T'13:17:55'Z'",
          "UpdateTime": "2023-01-05'T'13:17:55'Z'",
          "PartitionKey": true,
          "Nullable": false,
          "PrimaryKey": true,
          "DistributeKey": false
        }
      ],
      "Catalog": "oss"
    }
  }
}

错误码

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.访问元数据失败

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

变更历史

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