Service doublecloud.clickhouse.v1.ClusterService

Get

Returns the specified ClickHouse cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster resource to return.

sensitive

bool
Whether to include sensitive data in the response. If unspecified, defaults to
false.

Response

Field

Description

id

string
ID of the ClickHouse cluster.

project_id

string
ID of the project that the ClickHouse cluster belongs to.

cloud_type

string
Type of the cloud where instances should be hosted.

region_id

string
ID of the region to place instances.

create_time

google.protobuf.Timestamp
Creation timestamp.

name

string
Name of the ClickHouse cluster.
The name is unique within the project.

description

string
Description of the ClickHouse cluster.

status

doublecloud.v1.ClusterStatus
Current state of the cluster.

version

string
Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources
Resources allocated to the ClickHouse cluster.

connection_info

doublecloud.clickhouse.v1.ConnectionInfo
Connection information.

access

doublecloud.v1.Access
Access settings

private_connection_info

doublecloud.clickhouse.v1.PrivateConnectionInfo
Private connection information.

encryption

doublecloud.v1.DataEncryption
DataEncryption settings

network_id

string
ID of the network that the ClickHouse cluster belongs to.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig
ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow
Window of maintenance operations.

maintenance_operation

doublecloud.v1.MaintenanceOperation
Maintenance operation planned at nearest maintenance_window.

metrics_exporter_connection_info

doublecloud.clickhouse.v1.MetricsExporterConnectionInfo
Prometheus JMX exporter endpoint HTTP basic auth information.

List

Retrieves a list of ClickHouse clusters that belong to the specified project.

Request

Field

Description

project_id

string
ID of the project to list ClickHouse clusters in.

paging

doublecloud.v1.Paging
Paging information of the request

view

doublecloud.clickhouse.v1.ClusterView
The level of detail to be returned. If unspecified, defaults to
CLUSTER_VIEW_BASIC.

Response

Field

Description

clusters

list
List of ClickHouse cluster resources.

clusters[]

doublecloud.clickhouse.v1.Cluster

next_page

doublecloud.v1.NextPage
Pagination information of the response

Create

Creates a ClickHouse cluster in the specified project.

Request

Field

Description

project_id

string
ID of the project to create the ClickHouse cluster in.

cloud_type

string
Type of the cloud where instances should be hosted.

region_id

string
ID of the region to place instances.

name

string
Name of the ClickHouse cluster. The name must be unique within the project.

description

string
Description of the ClickHouse cluster.

version

string
Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources
Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access
Access settings

encryption

doublecloud.v1.DataEncryption
DataEncryption settings

network_id

string
ID of the network to create ClickHouse cluster in.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig
ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow
Window of maintenance operations.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

Update

Updates the specified ClickHouse cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster resource to update.
To get the ClickHouse cluster ID, use a [ClusterService.List] request.

name

string
New name for the cluster.

description

string
New description of the ClickHouse cluster.

version

string
Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources
Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access
Access settings

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig
ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow
Window of maintenance operations.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

Delete

Deletes the specified ClickHouse cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster to delete.
To get the ClickHouse cluster ID, use a [ClusterService.List] request.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

ResetCredentials

Reset credentials for the specified cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster to reset credentials.
To get the ClickHouse cluster ID, use a [ClusterService.List] request.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

ListHosts

Retrieves a list of hosts for the specified cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster to list hosts in.

paging

doublecloud.v1.Paging
Paging information of the request

Response

Field

Description

hosts

list
Requested list of hosts for the cluster.

hosts[]

doublecloud.clickhouse.v1.Host

next_page

doublecloud.v1.NextPage
Pagination information of the response

Restore

Creates a new ClickHouse cluster from the specified backup.

Request

Field

Description

backup_id

string
Required. ID of the backup to restore from.

project_id

string
ID of the project to create the ClickHouse cluster in.

region_id

string
ID of the region to place instances.

name

string
Name of the ClickHouse cluster. The name must be unique within the project.

description

string
Description of the ClickHouse cluster.

version

string
Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources
Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access
Security settings

encryption

doublecloud.v1.DataEncryption
DataEncryption settings

network_id

string
ID of the network to create ClickHouse cluster in.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig
ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow
Window of maintenance operations.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

ListBackups

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

Request

Field

Description

cluster_id

string
Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging
Paging information of the request

Response

Field

Description

backups

list
Requested list of backups.

backups[]

doublecloud.clickhouse.v1.Backup

next_page

doublecloud.v1.NextPage
Pagination information of the response

Start

Starts stopped ClickHouse cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster to start.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

Stop

Stops running ClickHouse cluster.

Request

Field

Description

cluster_id

string
ID of the ClickHouse cluster to stop.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

RescheduleMaintenance

Reschedule planned maintenance operation.

Request

Field

Description

cluster_id

string
Required. ID of the ClickHouse cluster to maintenance reschedule.

reschedule_type

doublecloud.v1.RescheduleType
Required. The type of reschedule request.

delayed_until_time

google.protobuf.Timestamp
The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time
scheduled.

Response

Field

Description

id

string
ID of the operation.

project_id

string
ID of the project where operation performed.

description

string
Description of the operation.

created_by

string
ID of the user or service account who initiated the operation.

metadata

list
Operation metadata (e.g. cluster_id for create cluster operation).

metadata[]

doublecloud.v1.Operation.MetadataEntry

create_time

google.protobuf.Timestamp
The time when the operation was created.

start_time

google.protobuf.Timestamp
The time when the operation was started.

finish_time

google.protobuf.Timestamp
The time when the operation was finished.

status

doublecloud.v1.Operation.Status
The status of the operation.

error

google.rpc.Status
The error result of the operation in case of failure or cancellation.

resource_id

string
ID of the resource operation performed on.

ListOperations

List cluster operations.

Request

Field

Description

cluster_id

string
Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging
Paging information of the request

Response

Field

Description

operations

list

operations[]

doublecloud.v1.Operation

next_page

doublecloud.v1.NextPage
Pagination information of the response