Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Managed Service for PostgreSQL
  • Getting started
  • Access management
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • Get
        • List
        • Delete
  • Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes

In this article:

  • gRPC request
  • GetBackupRequest
  • Backup
  1. API reference
  2. gRPC
  3. Backup
  4. Get

Managed Service for PostgreSQL API, gRPC: BackupService.Get

Written by
Yandex Cloud
Updated at November 26, 2024
  • gRPC request
  • GetBackupRequest
  • Backup

Returns the specified PostgreSQL Backup resource.

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

gRPC requestgRPC request

rpc Get (GetBackupRequest) returns (Backup)

GetBackupRequestGetBackupRequest

{
  "backup_id": "string"
}

Field

Description

backup_id

string

Required field. ID of the backup to return information about.
To get the backup ID, use a ClusterService.ListBackups request.

BackupBackup

{
  "id": "string",
  "folder_id": "string",
  "created_at": "google.protobuf.Timestamp",
  "source_cluster_id": "string",
  "started_at": "google.protobuf.Timestamp",
  "size": "int64",
  "type": "BackupCreationType",
  "method": "BackupMethod",
  "journal_size": "int64",
  "status": "BackupStatus"
}

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

Field

Description

id

string

Required. ID of the backup.

folder_id

string

ID of the folder that the backup belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp in RFC3339 text format
(i.e. when the backup operation was completed).

source_cluster_id

string

ID of the PostgreSQL cluster that the backup was created for.

started_at

google.protobuf.Timestamp

Time when the backup operation was started.

size

int64

Size of backup, in bytes

type

enum BackupCreationType

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

  • BACKUP_CREATION_TYPE_UNSPECIFIED
  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request

method

enum BackupMethod

Method of backup creation

  • BACKUP_METHOD_UNSPECIFIED
  • BASE: Base backup
  • INCREMENTAL: Delta (incremental) PostgreSQL backup

journal_size

int64

Size of the journal associated with backup, in bytes

status

enum BackupStatus

Status of backup

  • BACKUP_STATUS_UNSPECIFIED
  • DONE: Backup is done
  • CREATING: Backup is creating

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.