Managed Service for MySQL API, gRPC: BackupService
Written by
Updated at September 4, 2024
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. |
Delete | Deletes the specified MySQL cluster backup. |
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). |
size | int64 Size of backup, in bytes |
type | enum BackupCreationType How this backup was created (manual/automatic/etc...)
|
status | enum BackupStatus Status of backup
|
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 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). |
size | int64 Size of backup, in bytes |
type | enum BackupCreationType How this backup was created (manual/automatic/etc...)
|
status | enum BackupStatus Status of backup
|
Delete
Deletes the specified MySQL cluster backup.
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 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 if operation finished successfully. |
DeleteBackupMetadata
Field | Description |
---|---|
backup_id | string Required. ID of the MySQL backup that is currently being deleted. |
cluster_id | string ID of the MySQL backup that is being deleted. |