Contact UsGet started

Managed Service for Greenplum® API, REST: Cluster.ListBackups

Written by
Updated at October 17, 2024

Retrieves a list of available backups for the specified Greenplum® cluster.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-greenplum/v1/clusters/{clusterId}/backups

Path parameters

Field

Description

clusterId

string

Required field. ID of the Greenplum® cluster.

To get the Greenplum® cluster ID use a ClusterService.List request.

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return.

If the number of available results is larger than pageSize, the service returns a ListClusterBackupsResponse.nextPageToken that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClusterBackupsResponse.nextPageToken returned by the previous list request.

Response

HTTP Code: 200 - OK

{
  "backups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "sourceClusterId": "string",
      "startedAt": "string",
      "size": "string",
      "type": "string",
      "method": "string",
      "journalSize": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

backups[]

Backup

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 nextPageToken as the value for the ListClusterBackupsRequest.pageToken query parameter in the next list request.

Each subsequent list request has its own nextPageToken to continue paging through the results.

Backup

Field

Description

id

string

Required. ID of the backup.

folderId

string

ID of the folder that the backup belongs to.

createdAt

string (date-time)

Time when the backup operation was completed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

sourceClusterId

string

ID of the Greenplum® cluster that the backup was created for.

startedAt

string (date-time)

Time when the backup operation was started.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

size

string (int64)

Size of the backup in bytes.

type

enum (BackupCreationType)

How this backup was created (manual/automatic/etc...)

  • BACKUP_CREATION_TYPE_UNSPECIFIED
  • AUTOMATED: Backup created by automated daily schedule
  • MANUAL: Backup created by user request

method

enum (BackupMethod)

Method of backup creation

  • BACKUP_METHOD_UNSPECIFIED
  • BASE: Base backup
  • INCREMENTAL: Delta (incremental) Greenplum backup

journalSize

string (int64)

Size of the journal associated with backup, in bytes
Previous
StreamLogs
Next
Backup