Managed Service for MongoDB API, gRPC: BackupService.Get
Returns the specified MongoDB backup.
To get the list of available MongoDB backups, make a List request.
gRPC request
rpc Get (GetBackupRequest) returns (Backup)
GetBackupRequest
{
"backupId": "string"
}
Field |
Description |
backupId |
string Required field. ID of the backup to return information about. |
Backup
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"sourceClusterId": "string",
"startedAt": "google.protobuf.Timestamp",
"sourceShardNames": [
"string"
],
"size": "int64",
"type": "BackupType",
"journalSize": "int64"
}
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 |
Creation timestamp in RFC3339 |
sourceClusterId |
string ID of the MongoDB cluster that the backup was created for. |
startedAt |
Time when the backup operation was started. |
sourceShardNames[] |
string Shard names used as a source for backup. |
size |
int64 Size of backup in bytes |
type |
enum BackupType How this backup was created (manual/automatic/etc...)
|
journalSize |
int64 Size of the journal associated with backup, in bytes |