Skip to main content

List

Retrieves the list of backups available for the specified folder.

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);
})();

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​

List of Backup resources.

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​

A MongoDB Backup resource. For more information, see the Developer's Guide.

BackupType​
  • BACKUP_TYPE_UNSPECIFIED

  • AUTOMATED

    Backup created by automated daily schedule

  • MANUAL

    Backup created by user request

id : string​

ID of the backup. Required.

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 MongoDB cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

sourceShardNames : string​

Shard names used as a source for backup.

size : int64​

Size of backup in bytes

type : BackupType​

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

journalSize : int64​

Size of the journal associated with backup, in bytes