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
Parameter | Description |
---|---|
backupId | Required. ID of the backup to return information about. To get the backup ID, use a listBackups request. |
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 text format (i.e. when the backup operation was completed). String in RFC3339 text format. The range of possible values is from 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 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 | string How this backup was created (manual/automatic/etc...)
|
journalSize | string (int64) Size of the journal associated with backup, in bytes |