Call the DescribeColumns API to query columns in a table - AnalyticDB - Alibaba Cloud - AnalyticDB

Enumerates the columns of a specified table in an instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:DescribeColumns

get

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	am-bp1xxxxxxxx47
SchemaName	string	Yes	The database name.	adb_demo
TableName	string	Yes	The table name.	test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
Items	object
Column	array<object>	The list of columns.
	object
Type	string	The data type of the column.	bigint
ColumnName	string	The column name.	id
TableName	string	The table name.	test
AutoIncrementColumn	boolean	Indicates whether the column is an auto-increment column.	true
DBClusterId	string	The cluster ID.	am-bp1xxxxxxxx47
PrimaryKey	boolean	Indicates whether the column is a primary key.	false
SchemaName	string	The database name.	adb_demo

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "Items": {
    "Column": [
      {
        "Type": "bigint",
        "ColumnName": "id",
        "TableName": "test",
        "AutoIncrementColumn": true,
        "DBClusterId": "am-bp1xxxxxxxx47",
        "PrimaryKey": false,
        "SchemaName": "adb_demo"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.