GetTableColumns - 查询列信息

更新时间:
复制 MD 格式

查询列信息。

接口说明

  • 地域的公网接入地址: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暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

SchemaName

string

否

数据库名。

adb_demo

TableName

string

否

表名。

test

ColumnName

string

否

列名。

assist_user_phone

PageNumber

integer

否

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

1

PageSize

integer

否

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

  • 30(默认值)。

  • 50。

  • 100。

30

DBClusterId

string

是

集群 ID。

amv-bp11q28kvl688****

RegionId

string

是

地域 ID。

cn-hangzhou

返回参数

名称

类型

描述

示例值

object

返回结果。

RequestId

string

请求 ID。

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

PageNumber

integer

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

1

PageSize

integer

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

  • 30(默认值)。

  • 50。

  • 100。

30

TotalCount

integer

结果中数据的总条数。

15

Data

object

返回数据。

PageNumber

integer

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

1

PageSize

integer

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

  • 30(默认值)。

  • 50。

  • 100。

30

TotalCount

integer

结果中数据的总条数。

15

Table TableDetailModel

表的详细信息。

示例

正常返回示例

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",
      "CreatedBySource": "APS",
      "CreatedByUser": "example_user",
      "Location": "oss://**************",
      "Parameters": {
        "key": "key:value"
      }
    }
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 MDS.IllegalArgument Invalid argument. 用户使用了非法参数
400 MDS.InvalidPrivilege No permissions. 用户无权限进行操作
400 MDS.MetaSchemaAlreadyExist The database already exists. 数据库已存在
400 MDS.MetaSchemaNotExist The database does not exist. 操作的数据库不存在
400 MDS.MetaTableAlreadyExist The table already exists. 操作的表已经存在
400 MDS.MetaTableNotExist The table is not found. 操作的表不存在
500 MDS.InternalError An internal MDS error occurred. MDS服务内部错误
500 MDS.MetaVisitError Failed to access metadata. 访问元数据失败
403 MDS.RamAuthAccessDenied ram auth access denied. RAM鉴权失败

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

变更历史

更多信息,参考变更详情。