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
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the cluster to list backups for. To get this ID, make a ClusterService.List request. |
|
pageSize |
int64 The maximum number of results per page to return. If the number of available results is larger than |
|
pageToken |
string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set |
ListClusterBackupsResponse
{
"backups": [
{
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"sourceClusterId": "string",
"startedAt": "google.protobuf.Timestamp",
"size": "int64",
"type": "BackupCreationType",
"status": "BackupStatus"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
backups[] |
List of the cluster backups. |
|
nextPageToken |
string The token that can be used to get the next page of results. If the number of results is larger than ListClusterBackupsRequest.pageSize, use the Each of the subsequent ClusterService.ListBackups requests should use the |
Backup
An object that represents MySQL backup.
See the documentation for details.
|
Field |
Description |
|
id |
string Required field. ID of the backup. |
|
folderId |
string ID of the folder that the backup belongs to. |
|
createdAt |
Creation timestamp (the time when the backup operation was completed). |
|
sourceClusterId |
string ID of the cluster that the backup was created for. |
|
startedAt |
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
|