Managed Service for MongoDB API, REST: Backup.Get

Field

Description

backupId

string

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

Field

Description

id

string

ID of the backup. Required.

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 MongoDB 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).

sourceShardNames[]

string

Shard names used as a source for backup.

size

string (int64)

Size of backup in bytes

type

enum (BackupType)

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

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

journalSize

string (int64)

Size of the journal associated with backup, in bytes