All Products
Search
Document Center

AnalyticDB:DescribeColumns

Last Updated:Nov 10, 2025

Queries a list of columns in a table.

Operation description

  • Regional public endpoint: adb.<region-id>.aliyuncs.com. Example: adb.cn-hangzhou.aliyuncs.com.
  • Regional Virtual Private Cloud (VPC) endpoint: adb-vpc.<region-id>.aliyuncs.com. Example: adb-vpc.cn-hangzhou.aliyuncs.com.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
adb:describeAllDataSourceget
*DBClusterLakeVersion
acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID.

cn-hangzhou
DBClusterIdstringYes

The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

amv-bp1xxxxxxxx47
SchemaNamestringNo

The name of the database.

adb_demo
TableNamestringNo

The name of the table.

test

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AD222E9-E606-4A42-BF6D-XXX442913CEF
Itemsarray<object>

The queried columns.

Columnobject

The queried column.

Typestring

The data type of the column.

bigint
ColumnNamestring

The name of the column.

id
TableNamestring

The name of the table.

test
AutoIncrementColumnboolean

Indicates whether the column is an auto-increment column. Valid values:

  • true
  • false
true
DBClusterIdstring

The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster.

amv-bp111m2cfrdl1****
PrimaryKeyboolean

Indicates whether the column is the primary key of the table. Valid values:

  • true
  • false
false
SchemaNamestring

The name of the database.

adb_demo

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-XXX442913CEF",
  "Items": {
    "Column": [
      {
        "Type": "bigint",
        "ColumnName": "id",
        "TableName": "test",
        "AutoIncrementColumn": true,
        "DBClusterId": "amv-bp111m2cfrdl1****",
        "PrimaryKey": false,
        "SchemaName": "adb_demo"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400MDS.IllegalArgumentInvalid argument.An invalid parameter is used.
400MDS.InvalidPrivilegeNo permissions.You are not authorized to perform this operation.
400MDS.MetaSchemaAlreadyExistThe database already exists.The specified database already exists.
400MDS.MetaSchemaNotExistThe database does not exist.The specified database does not exist.
400MDS.MetaTableAlreadyExistThe table already exists.The specified table already exists.
400MDS.MetaTableNotExistThe table is not found.The specified table does not exist.
403MDS.RamAuthAccessDeniedram auth access denied.RAM authentication failed
500MDS.InternalErrorAn internal MDS error occurred.An internal error occurred.
500MDS.MetaVisitErrorFailed to access metadata.Failed to access the metadata.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-11The Error code has changedView Change Details
2023-08-25The Error code has changedView Change Details
2023-08-22The Error code has changedView Change Details