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
{
"cluster_id": "string",
"page_size": "int64",
"page_token": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Greenplum® cluster. 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. To get the next page of results, set 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",
"method": "BackupMethod",
"journal_size": "int64",
"shared_size": "int64"
}
],
"next_page_token": "string"
}
|
Field |
Description |
|
backups[] |
List of Greenplum® backups. |
|
next_page_token |
string This token allows you to get the next page of results for list requests. |
Backup
|
Field |
Description |
|
id |
string Required field. Required. ID of the backup. |
|
folder_id |
string ID of the folder that the backup belongs to. |
|
created_at |
Time when the backup operation was completed. |
|
source_cluster_id |
string ID of the Greenplum® cluster that the backup was created for. |
|
started_at |
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.
|
|
journal_size |
int64 Size of the journal associated with backup, in bytes. |
|
shared_size |
int64 Size of data added by this backup to storage shared between backups, in bytes. |