DescribeColumns - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries information about columns.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The cluster ID.	cc-2zeux3ua25242****
SchemaName	string	Yes	The database name. You can call the DescribeSchemas operation to query database names.	database
TableName	string	Yes	The table name. You can call the DescribeTables operation to query table names.	table

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	66428721-FFEC-5023-B4E5-3BD1B67837E0
Items	array<object>	Details of the columns.
	object
Type	string	The column type.	String
ColumnName	string	The column name.	name
TableName	string	The table name.	table
AutoIncrementColumn	boolean	Indicates whether the column is an auto-increment column. Valid values: true false	true
DBClusterId	string	The cluster ID.	cc-2zeux3ua25242****
PrimaryKey	boolean	Indicates whether the column is the primary key of the table. Valid values: true false	true
SchemaName	string	The database name.	database

Examples

Sample success responses

JSONformat

{
  "RequestId": "66428721-FFEC-5023-B4E5-3BD1B67837E0",
  "Items": {
    "Column": [
      {
        "Type": "String",
        "ColumnName": "name",
        "TableName": "table",
        "AutoIncrementColumn": true,
        "DBClusterId": "cc-2zeux3ua25242****",
        "PrimaryKey": true,
        "SchemaName": "database"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request.	An error occurred while processing your request.
503	ServiceUnavailable	An error occurred while processing your request.	An error occurred while processing your request.

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

Change history

Change time	Summary of changes	Operation

No change history