Skip to main content

Get

Returns the specified backup of Elasticsearch cluster.

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

Required. ID of the backup to return.

Backup

id : string

Required. ID of the backup.

folderId : string

ID of the folder that the backup belongs to.

sourceClusterId : string

ID of the associated Elasticsearch cluster.

startedAt : google.protobuf.Timestamp

The time when the backup operation was started.

createdAt : google.protobuf.Timestamp

The time when the backup was created (i.e. when the backup operation completed).

indices : string

Indices names. (max 100)

elasticsearchVersion : string

Elasticsearch version used to create the snapshot

sizeBytes : int64

Total size of all indices in backup. in bytes

indicesTotal : int64

Total count of indices in backup