Skip to main content

Get

Retrieves information about the specified backup.

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

const GetBackupRequest =
cloudApi.mdb.clickhouse_backup_service.GetBackupRequest;

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

const result = await client.get(
GetBackupRequest.fromPartial({
backupId: "backupId",
})
);
console.log(result);
})();

GetBackupRequest​

backupId : string​

ID of the backup to return information about.

To get this ID, make a BackupService.List request (lists all backups in a folder) or a ClusterService.ListBackups request (lists all backups for an existing cluster).

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