Method 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

Parameter Description
clusterId Required. ID of the ClickHouse cluster to list databases in. To get the cluster ID, use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. to get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

{
  "databases": [
    {
      "name": "string",
      "clusterId": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
databases[] object

A ClickHouse Database resource. For more information, see the Developer's Guide.

databases[].
name
string

Name of the database.

databases[].
clusterId
string

ID of the ClickHouse cluster that the database belongs to.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.