BackupService

A set of methods for managing MongoDB Backup resources.

Call	Description
Get	Returns the specified MongoDB backup.
List	Retrieves the list of backups available for the specified folder.
Delete	Returns the list of available backups for the specified MongoDB cluster.

Calls BackupService

Get

Returns the specified MongoDB backup.
To get the list of available MongoDB backups, make a List request.

rpc Get (GetBackupRequest) returns (Backup)

GetBackupRequest

Field	Description
backup_id	string Required. ID of the backup to return information about. To get the backup ID, use a ClusterService.ListBackups request.

Backup

Field	Description
id	string ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
source_cluster_id	string ID of the MongoDB cluster that the backup was created for.
started_at	google.protobuf.Timestamp Time when the backup operation was started.
source_shard_names[]	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...) AUTOMATED: Backup created by automated daily schedule MANUAL: Backup created by user request

List

Retrieves the list of backups available for the specified folder.

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequest

Field	Description
folder_id	string Required. ID of the folder to list backups in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListBackupsResponse

Field	Description
backups[]	Backup List of Backup resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListBackupsRequest.page_size, use the next_page_token as the value for the ListBackupsRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Backup

Field	Description
id	string ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
source_cluster_id	string ID of the MongoDB cluster that the backup was created for.
started_at	google.protobuf.Timestamp Time when the backup operation was started.
source_shard_names[]	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...) AUTOMATED: Backup created by automated daily schedule MANUAL: Backup created by user request

Delete

Returns the list of available backups for the specified MongoDB cluster.

rpc Delete (DeleteBackupRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteBackupMetadata

    Operation.response:google.protobuf.Empty

DeleteBackupRequest

Field	Description
backup_id	string Required. Required. ID of the backup to delete.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteBackupMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteBackupMetadata

Field	Description
backup_id	string Required. ID of the deleting MongoDB backup.