All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeColumns

Last Updated:Nov 12, 2024

Queries information about columns.

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:
    • 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.
OperationAccess levelResource typeCondition keyAssociated operation
clickhouse:DescribeColumnsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-2zeux3ua25242****
SchemaNamestringYes

The database name. You can call the DescribeSchemas operation to query database names.

database
TableNamestringYes

The table name. You can call the DescribeTables operation to query table names.

table

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

66428721-FFEC-5023-B4E5-3BD1B67837E0
Itemsarray<object>

Details of the columns.

Columnobject
Typestring

The column type.

String
ColumnNamestring

The column name.

name
TableNamestring

The table name.

table
AutoIncrementColumnboolean

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

  • true
  • false
true
DBClusterIdstring

The cluster ID.

cc-2zeux3ua25242****
PrimaryKeyboolean

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

  • true
  • false
true
SchemaNamestring

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 codeError codeError messageDescription
500InternalErrorAn error occurred while processing your request.An error occurred while processing your request.
503ServiceUnavailableAn 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 timeSummary of changesOperation
2024-09-23API Description Update. The Error code has changedView Change Details