Managed Service for ClickHouse API, REST: Cluster

Method

Description

Get

Returns the specified ClickHouse cluster.

List

Retrieves a list of ClickHouse clusters that belong

Create

Creates a ClickHouse cluster in the specified folder.

Update

Updates the specified ClickHouse cluster.

Delete

Deletes the specified ClickHouse cluster.

Start

Starts the specified ClickHouse cluster.

Stop

Stops the specified ClickHouse cluster.

Move

Moves a ClickHouse cluster to the specified folder.

AddZookeeper

Adds a ZooKeeper subcluster to the specified ClickHouse cluster.

Backup

Creates a backup for the specified ClickHouse cluster.

Restore

Creates a new ClickHouse cluster using the specified backup.

RescheduleMaintenance

Reschedules planned maintenance operation.

ListLogs

Retrieves logs for the specified ClickHouse cluster.

StreamLogs

Same as ListLogs but using server-side streaming. Also allows for tail -f semantics.

ListOperations

Retrieves the list of Operation resources for the specified cluster.

ListBackups

Retrieves the list of available backups for the specified ClickHouse cluster.

ListHosts

Retrieves a list of hosts for the specified cluster.

AddHosts

Creates new hosts for a cluster.

UpdateHosts

Updates the specified hosts.

DeleteHosts

Deletes the specified hosts for a cluster.

RestartHosts

GetShard

Returns the specified shard.

ListShards

Retrieves a list of shards that belong to the specified cluster.

AddShard

Creates a new shard in the specified cluster.

AddShards

Creates one or more shards in the specified cluster.

UpdateShard

Modifies the specified shard.

DeleteShard

Deletes the specified shard.

DeleteShards

Deletes the specified shards (one or more).

GetShardGroup

Returns the specified shard group.

ListShardGroups

Retrieves a list of shard groups that belong to specified cluster.

CreateShardGroup

Creates a new shard group in the specified cluster.

UpdateShardGroup

Updates the specified shard group.

DeleteShardGroup

Deletes the specified shard group.

ListExternalDictionaries

Retrieves a list of external dictionaries that belong to specified cluster.

CreateExternalDictionary

Creates an external dictionary for the specified ClickHouse cluster.

UpdateExternalDictionary

Updates an external dictionary for the specified ClickHouse cluster.

DeleteExternalDictionary

Deletes the specified external dictionary.