List

Retrieves the list of backups in a folder.

To list backups for an existing cluster, make a ClusterService.ListBackups request.

TypeScript

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListBackupsRequest =
  cloudApi.mdb.clickhouse_backup_service.ListBackupsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.BackupServiceClient);

  const result = await client.list(
    ListBackupsRequest.fromPartial({
      folderId: "folderId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.clickhouse.v1.backup_service_pb2_grpc import BackupServiceStub
from yandex.cloud.mdb.clickhouse.v1.backup_service_pb2 import ListBackupsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(BackupServiceStub)
response = service.List(
    ListBackupsRequest(
        folder_id="folderId",
        # page_size = 0,
        # page_token = "pageToken"
    )
)
print(response)

ListBackupsRequest

folderId : string

ID of the folder to list backups in.

To get this ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize : int64

The maximum number of results per page to return.

If the number of available results is larger than page_size, the API returns a ListBackupsResponse.next_page_token that can be used to get the next page of results in the subsequent BackupService.List requests.

pageToken : string

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by the previous BackupService.List request.

ListBackupsResponse

backups : Backup

List of backups.

nextPageToken : string

The token that can be used to get the next page of results.

If the number of results is larger than ListBackupsRequest.page_size, use the next_page_token as the value for the ListBackupsRequest.page_token in the subsequent BackupService.List request to iterate through multiple pages of results.

Each of the subsequent BackupService.List requests should use the next_page_token value returned by the previous request to continue paging through the results.

Backup

An object that represents MySQL backup.

See the documentation for details.

BackupCreationType

• BACKUP_CREATION_TYPE_UNSPECIFIED

• AUTOMATED

  Backup created by automated daily schedule

• MANUAL

  Backup created by user request

BackupStatus

• BACKUP_STATUS_UNSPECIFIED

• DONE

  Backup is done

• CREATING

  Backup is creating

id : string

ID of the backup.

folderId : string

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp

Creation timestamp (the time when the backup operation was completed).

sourceClusterId : string

ID of the cluster that the backup was created for.

startedAt : google.protobuf.Timestamp

Start timestamp (the time when the backup operation was started).

size : int64

Size of backup, in bytes

type : BackupCreationType

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

status : BackupStatus

Status of backup

---