Managed Service for MongoDB API, gRPC: BackupService.List
Retrieves the list of backups available for the specified folder.
gRPC request
rpc List (ListBackupsRequest) returns (ListBackupsResponse)
ListBackupsRequest
{
"folderId": "string",
"pageSize": "int64",
"pageToken": "string"
}
Field |
Description |
folderId |
string Required field. ID of the folder to list backups in. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
ListBackupsResponse
{
"backups": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"sourceClusterId": "string",
"startedAt": "google.protobuf.Timestamp",
"sourceShardNames": [
"string"
],
"size": "int64",
"type": "BackupType",
"journalSize": "int64"
}
],
"nextPageToken": "string"
}
Field |
Description |
backups[] |
List of Backup resources. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
Backup
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 |