Managed Service for ClickHouse API, REST: Database.List
Retrieves the list of ClickHouse Database resources in the specified cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/databases
Path parameters
|
Field |
Description |
|
clusterId |
string Required field. ID of the ClickHouse cluster to list databases in. |
Query parameters
|
Field |
Description |
|
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
|
pageToken |
string Page token. to get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"databases": [
{
"name": "string",
"clusterId": "string",
"engine": "string"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
databases[] |
List of ClickHouse databases. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
Database
A ClickHouse Database resource. For more information, see the
Developer's Guide.
|
Field |
Description |
|
name |
string Name of the database. |
|
clusterId |
string ID of the ClickHouse cluster that the database belongs to. |
|
engine |
enum (DatabaseEngine) Database engine. For details, see ClickHouse documentation.
|