Managed Service for MySQL API, gRPC: ClusterService.ListBackups
Retrieves a list of backups for a cluster.
To list all backups in a folder, make a BackupService.List request.
gRPC request
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the cluster to list backups for. The maximum string length in characters is 50. |
|
page_size |
int64 The maximum number of results per page to return. The maximum value is 1000. |
|
page_token |
string Page token that can be used to iterate through multiple pages of results. The maximum string length in characters is 100. |
ListClusterBackupsResponse
{
"backups": [
{
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"source_cluster_id": "string",
"started_at": "google.protobuf.Timestamp",
"size": "int64",
"type": "BackupCreationType",
"status": "BackupStatus",
"journal_size": "int64"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
backups[] |
List of the cluster backups. |
|
next_page_token |
string The token that can be used to get the next page of results. |
Backup
An object that represents MySQL backup.
See the documentation for details.
|
Field |
Description |
|
id |
string Required field. ID of the backup. |
|
folder_id |
string ID of the folder that the backup belongs to. |
|
created_at |
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 |
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
|
|
journal_size |
int64 Size of the journal associated with backup, in bytes. |