Get

Returns the specified PostgreSQL Backup resource.

To get the list of available PostgreSQL Backup resources, make a List request.

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 information about. To get the backup ID, use a ClusterService.ListBackups request.

Backup

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

BackupMethod

• BACKUP_METHOD_UNSPECIFIED

• BASE

  Base backup

• INCREMENTAL

  Delta (incremental) PostgreSQL backup

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

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

startedAt : google.protobuf.Timestamp

Time when the backup operation was started.

size : int64

Size of backup, in bytes

type : BackupCreationType

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

method : BackupMethod

Method of backup creation

journalSize : int64

Size of the journal associated with backup, in bytes

status : BackupStatus

Status of backup

---