Managed Service for ClickHouse API, gRPC: ClusterService.ListBackups

Field

Description

cluster_id

string

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

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size, the service returns a ListClusterBackupsResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.

page_token

string

Page token. To get the next page of results, set page_token to the
ListClusterBackupsResponse.next_page_token returned by the previous list request.

Field

Description

backups[]

Backup

List of ClickHouse Backup resources.

next_page_token

string

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

Field

Description

id

string

ID of the backup.

folder_id

string

ID of the folder that the backup belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format
(i.e. when the backup operation was completed).

source_cluster_id

string

ID of the ClickHouse cluster that the backup was created for.

source_shard_names[]

string

Names of the shards included in the backup.

started_at

google.protobuf.Timestamp

Time when the backup operation was started.

size

int64

Size of backup in bytes.

type

enum BackupType

How this backup was created (manual/automatic/etc...).

• BACKUP_TYPE_UNSPECIFIED
• AUTOMATED: Backup created by automated daily schedule.
• MANUAL: Backup created by user request.