Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Managed Service for ClickHouse API, gRPC: BackupService.List

Written by
Updated at November 26, 2024

Retrieves the list of Backup resources available for the specified folder.

gRPC request

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequest

{
  "folder_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

folder_id

string

Required field. ID of the folder to list backups in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.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 ListBackupsResponse.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 ListBackupsResponse.next_page_token
returned by the previous list request.

ListBackupsResponse

{
  "backups": [
    {
      "id": "string",
      "folder_id": "string",
      "created_at": "google.protobuf.Timestamp",
      "source_cluster_id": "string",
      "source_shard_names": [
        "string"
      ],
      "started_at": "google.protobuf.Timestamp",
      "size": "int64",
      "type": "BackupType"
    }
  ],
  "next_page_token": "string"
}

Field

Description

backups[]

Backup

List of 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 ListBackupsRequest.page_size, use the next_page_token as the value
for the ListBackupsRequest.page_token parameter in the next list request. Each subsequent
list request will have its own next_page_token to continue paging through the results.

Backup

A ClickHouse Backup resource. See the Developer's Guide
for more information.

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.
Previous
Get
Next
Delete