Service doublecloud.clickhouse.v1.BackupService

Get

Returns the specified backup of ClickHouse cluster.

Request

Field

Description

backup_id

string
Required. ID of the backup to return.

Response

Field

Description

id

string
Required. ID of the backup.

project_id

string
ID of the project that the backup belongs to.

name

string
User defined or autogenerated backup name. Contains shard name until we
implement consistent multishard backups.

create_time

google.protobuf.Timestamp
The time when the backup was created (i.e. when the backup operation completed).

start_time

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

source_cluster_id

string
ID of the associated ClickHouse cluster.

size

int64
Size of backup in bytes

type

doublecloud.clickhouse.v1.Backup.Type
How this backup was created (manual/automatic/etc...)

List

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

Request

Field

Description

project_id

string
Required. ID of the project to list backups in.

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

Create

Creates new ClickHouse cluster backup.

Request

Field

Description

cluster_id

string
Required. ID of the ClickHouse cluster to back up.

name

string
Optional. Name of the ClickHouse cluster backup.

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

Delete specified ClickHouse cluster backup.

Request

Field

Description

backup_id

string
Required. ID of the backup to delete.

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.