Managed Service for MongoDB API, REST: Backup.Get
Returns the specified MongoDB backup.
To get the list of available MongoDB backups, make a List request.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-mongodb/v1/backups/{backupId}
Path parameters
Field |
Description |
backupId |
string Required field. ID of the backup to return information about. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"startedAt": "string",
"sourceShardNames": [
"string"
],
"size": "string",
"type": "string",
"journalSize": "string"
}
A MongoDB Backup resource. For more information, see the
Developer's Guide.
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 String in RFC3339 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
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...)
|
journalSize |
string (int64) Size of the journal associated with backup, in bytes |