All Products
Search
Document Center

ApsaraDB for ClickHouse:DescribeAllDataSource

Last Updated:Jul 17, 2024

Queries a list of databases, tables, and columns in an ApsaraDB for ClickHouse cluster.

Debugging

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

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DBClusterIdstringYes

The cluster ID.

cc-bp108z124a8o7****
SchemaNamestringYes

The database name.

database
TableNamestringYes

The table name.

table

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

05321590-BB65-4720-8CB6-8218E041CDD0
Tablesarray<object>

The information about the tables.

object
TableNamestring

The table name.

table
DBClusterIdstring

The cluster ID.

cc-bp108z124a8o7****
SchemaNamestring

The database name.

database
Columnsarray<object>

The information about the columns.

object
Typestring

The type of the column.

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-bp108z124a8o7****
PrimaryKeyboolean

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

  • true
  • false
true
SchemaNamestring

The database name.

database
Schemasarray<object>

The information about the databases.

object
DBClusterIdstring

The cluster ID.

cc-bp108z124a8o7****
SchemaNamestring

The database name.

database

Examples

Sample success responses

JSONformat

{
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0",
  "Tables": {
    "Table": [
      {
        "TableName": "table",
        "DBClusterId": "cc-bp108z124a8o7****",
        "SchemaName": "database"
      }
    ]
  },
  "Columns": {
    "Column": [
      {
        "Type": "String",
        "ColumnName": "name",
        "TableName": "table",
        "AutoIncrementColumn": true,
        "DBClusterId": "cc-bp108z124a8o7****",
        "PrimaryKey": true,
        "SchemaName": "database"
      }
    ]
  },
  "Schemas": {
    "Schema": [
      {
        "DBClusterId": "cc-bp108z124a8o7****",
        "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
No change history