Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for PostgreSQL API, REST: Backup.Get

Written by
Updated at October 17, 2024

Returns the specified PostgreSQL Backup resource.

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

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/backups/{backupId}

Path parameters

Field

Description

backupId

string

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

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "sourceClusterId": "string",
  "startedAt": "string",
  "size": "string",
  "type": "string",
  "method": "string",
  "journalSize": "string",
  "status": "string"
}

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

Field

Description

id

string

Required. ID of the backup.

folderId

string

ID of the folder that the backup belongs to.

createdAt

string (date-time)

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

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

sourceClusterId

string

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

startedAt

string (date-time)

Time when the backup operation was started.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

size

string (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

journalSize

string (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
Previous
Overview
Next
List