Get

Returns the specified backup of an OpenSearch cluster.

TypeScript

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

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 GetBackupRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(BackupServiceStub)
response = service.Get(GetBackupRequest(backup_id="backupId"))
print(response)

GetBackupRequest

backupId : string

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

startedAt : google.protobuf.Timestamp

Time when the backup operation was started.

createdAt : google.protobuf.Timestamp

Time when the backup operation was completed.

indices : string

Names of indices in the backup.

opensearchVersion : string

OpenSearch version used to create the backup.

sizeBytes : int64

Size of the backup in bytes.

indicesTotal : int64

The number of indices in the backup.

---