Queries information about tables in a specified database of an ApsaraDB for ClickHouse cluster.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeTables

The operation that you want to perform. Set the value to DescribeTables.

DBClusterId String Yes cc-bp108z124a8o7****

The ID of the cluster.

SchemaName String Yes database

The name of the database.

Response parameters

Parameter Type Example Description
RequestId String 05321590-BB65-4720-8CB6-8218E041CDD0

The ID of the request.

Items Array of Table

The information about tables in the database.

Table
TableName String test

The name of a table in the database.

DBClusterId String cc-bp108z124a8o7****

The ID of the cluster.

SchemaName String database

The name of the database.

Examples

Sample requests

http(s)://clickhouse.aliyuncs.com/?Action=DescribeTables
&DBClusterId=cc-bp108z124a8o7****
&SchemaName=database
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeTablesResponse>
    <RequestId>05321590-BB65-4720-8CB6-8218E041CDD0</RequestId>
    <Items>
        <TableName>test</TableName>
        <DBClusterId>cc-bp108z124a8o7****</DBClusterId>
        <SchemaName>database</SchemaName>
    </Items>
</DescribeTablesResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "05321590-BB65-4720-8CB6-8218E041CDD0",
  "Items" : {
    "TableName" : "test",
    "DBClusterId" : "cc-bp108z124a8o7****",
    "SchemaName" : "database"
  }
}

Error codes

HttpCode Error code Error message Description
500 InternalError An error occurred while processing your request. The error message returned because an internal error has occurred. Try again later.
503 ServiceUnavailable An error occurred while processing your request. The error message returned because the service is unavailable. Try again later.

For a list of error codes, visit the API Error Center.