Managed Service for ClickHouse API, REST: Database.Get

Статья создана

Обновлена 23 января 2026 г.

Returns the specified ClickHouse Database resource.

To get the list of available ClickHouse Database resources, make a List request.

HTTP request

GET https://mdb.api.yandexcloud.kz/managed-clickhouse/v1/clusters/{clusterId}/databases/{databaseName}

Field

Description

clusterId

string

Required field. ID of the ClickHouse cluster that the database belongs to.
To get the cluster ID, use a ClusterService.List request.

The maximum string length in characters is 50.

databaseName

string

Required field. Name of the ClickHouse Database resource to return.
To get the name of the database, use a DatabaseService.List request.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

HTTP Code: 200 - OK

{
  "name": "string",
  "clusterId": "string",
  "engine": "string"
}

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. `DATABASE_ENGINE_ATOMIC` `DATABASE_ENGINE_REPLICATED`