Queries a list of databases, tables, and columns in an ApsaraDB for ClickHouse cluster.
Debugging
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 |
TableName | string | Yes | The table name. | table |
Response parameters
Examples
Sample success responses
JSON
format
{
"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 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