GetTableColumns - AnalyticDB - Alibaba Cloud Documentation Center

Queries the information about columns.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
adb:getTableColumns	get	DBClusterLakeVersion acs:adb:{#regionId}:{#AccountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
SchemaName	string	No	The name of the database.	adb_demo
TableName	string	No	The name of the table.	test
ColumnName	string	No	The name of the column.	assist_user_phone
PageNumber	long	No	The page number. Pages start from page 1. Default value: 1.	1
PageSize	long	No	The number of entries per page. Valid values: 30 (default) 50 100	30
DBClusterId	string	Yes	The cluster ID.	amv-bp11q28kvl688****
RegionId	string	Yes	The region ID of the cluster.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	long	The page number. Pages start from page 1. Default value: 1.	1
PageSize	long	The number of entries per page. Valid values: 30 (default) 50 100	30
TotalCount	long	The total number of entries returned.	15
Data	object	The queried data.
PageNumber	long	The page number. Pages start from page 1. Default value: 1.	1
PageSize	long	The number of entries per page. Valid values: 30 (default) 50 100	30
TotalCount	long	The total number of entries returned.	15
Table	TableDetailModel	The information about the table.

Examples

Sample success responses

JSONformat

{
  "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"
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MDS.IllegalArgument	Invalid argument.	An invalid parameter is used.
400	MDS.InvalidPrivilege	No permissions.	You are not authorized to perform this operation.
400	MDS.MetaSchemaAlreadyExist	The database already exists.	The specified database already exists.
400	MDS.MetaSchemaNotExist	The database does not exist.	The specified database does not exist.
400	MDS.MetaTableAlreadyExist	The table already exists.	The specified table already exists.
400	MDS.MetaTableNotExist	The table is not found.	The specified table does not exist.
500	MDS.InternalError	An internal MDS error occurred.	An internal error occurred.
500	MDS.MetaVisitError	Failed to access metadata.	Failed to access the metadata.

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

Change history

Change time	Summary of changes	Operation
2023-10-25	The Error code has changed	View Change Details
2023-03-22	The Error code has changed	View Change Details