Contact UsGet started

Managed Service for Redis API, REST: Backup.Get

Written by
Improved by
Updated at November 26, 2024

Returns the specified Redis backup.

To get the list of available Redis backups, make a List request.

HTTP request

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

Path parameters

Field

Description

backupId

string

Required field. ID of the Redis backup to return.
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",
  "sourceShardNames": [
    "string"
  ],
  "type": "string"
}

Description of a Redis backup. For more information, see
the Managed Service for Redis documentation.

Field

Description

id

string

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

startedAt

string (date-time)

Start timestamp in RFC3339 text format
(i.e. 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).

sourceShardNames[]

string

Shard names used as a source for backup.

type

enum (BackupType)

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

  • BACKUP_TYPE_UNSPECIFIED
  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request
Previous
Overview
Next
List