DescribeTables - ApsaraDB for ClickHouse - Alibaba Cloud Documentation Center

Queries the information about tables in a database of 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.

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-bp108z124a8o7****
SchemaName	string	Yes	The database name.	database

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	05321590-BB65-4720-8CB6-8218E041CDD0
Items	array<object>	The information about the tables.
	object
TableName	string	The table name.	test
DBClusterId	string	The cluster ID.	cc-bp108z124a8o7****
SchemaName	string	The database name.	database

Examples

Sample success responses

JSONformat

{
  "RequestId": "05321590-BB65-4720-8CB6-8218E041CDD0",
  "Items": {
    "Table": [
      {
        "TableName": "test",
        "DBClusterId": "cc-bp108z124a8o7****",
        "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
2022-03-25	The Error code has changed. The request parameters of the API has changed	View Change Details