List

Retrieves the list of Redis backups available for the specified folder.

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 the folder ID, use 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 service returns a ListBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests.

pageToken : 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 : Backup

Requested list of backups.

nextPageToken : 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

Description of a Redis backup. For more information, see the Managed Service for Redis documentation.

id : string

ID of the backup.

folderId : string

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp

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

sourceClusterId : string

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

startedAt : google.protobuf.Timestamp

Start timestamp in RFC3339 text format (i.e. when the backup operation was started).

sourceShardNames : string

Shard names used as a source for backup.

---