BackupService

A set of methods for managing MySQL backups.

See the documentation for details.

Call	Description
Get	Retrieves information about the specified backup.
List	Retrieves the list of backups in a folder.

Calls BackupService

Get

Retrieves information about the specified backup.

rpc Get (GetBackupRequest) returns (Backup)

GetBackupRequest

Field	Description
backup_id	string Required. ID of the backup to return information about. To get this ID, make a BackupService.List request (lists all backups in a folder) or a ClusterService.ListBackups request (lists all backups for an existing cluster).

Backup

Field	Description
id	string Required. ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp (the time when the backup operation was completed).
source_cluster_id	string ID of the cluster that the backup was created for.
started_at	google.protobuf.Timestamp Start timestamp (the time when the backup operation was started).

List

Retrieves the list of backups in a folder.
To list backups for an existing cluster, make a ClusterService.ListBackups request.

rpc List (ListBackupsRequest) returns (ListBackupsResponse)

ListBackupsRequest

Field	Description
folder_id	string Required. ID of the folder to list backups in. To get this ID, make 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 API returns a ListBackupsResponse.next_page_token that can be used to get the next page of results in the subsequent BackupService.List requests. The maximum value is 1000.
page_token	string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListBackupsResponse.next_page_token returned by the previous BackupService.List request. The maximum string length in characters is 100.

ListBackupsResponse

Field	Description
backups[]	Backup List of backups.
next_page_token	string The token that can be used to get the next page of results. If the number of results is larger than ListBackupsRequest.page_size, use the next_page_token as the value for the ListBackupsRequest.page_token in the subsequent BackupService.List(#List) request to iterate through multiple pages of results. Each of the subsequent [BackupService.List] requests should use the next_page_token value returned by the previous request to continue paging through the results. The maximum string length in characters is 100.

Backup

Field	Description
id	string Required. ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp (the time when the backup operation was completed).
source_cluster_id	string ID of the cluster that the backup was created for.
started_at	google.protobuf.Timestamp Start timestamp (the time when the backup operation was started).