Managed Service for Greenplum® API, gRPC: ClusterService.ListBackups
Retrieves a list of available backups for the specified Greenplum® cluster.
gRPC request
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
|
Field |
Description |
|
clusterId |
string Required field. ID of the Greenplum® cluster. To get the Greenplum® cluster ID use 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. 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",
"method": "BackupMethod",
"journalSize": "int64"
}
],
"nextPageToken": "string"
}
|
Field |
Description |
|
backups[] |
List of Greenplum® backups. |
|
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.pageSize, use the Each subsequent list request has its own |
Backup
|
Field |
Description |
|
id |
string Required. ID of the backup. |
|
folderId |
string ID of the folder that the backup belongs to. |
|
createdAt |
Time when the backup operation was completed. |
|
sourceClusterId |
string ID of the Greenplum® cluster that the backup was created for. |
|
startedAt |
Time when the backup operation was started. |
|
size |
int64 Size of the backup in bytes. |
|
type |
enum BackupCreationType How this backup was created (manual/automatic/etc...)
|
|
method |
enum BackupMethod Method of backup creation
|
|
journalSize |
int64 Size of the journal associated with backup, in bytes |