Managed Service for PostgreSQL API, REST: Cluster.ListBackups

Field

Description

clusterId

string

Required field. ID of the PostgreSQL cluster.
To get the PostgreSQL cluster ID use a ClusterService.List request.

The maximum string length in characters is 50.

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.

The maximum value is 1000.

pageToken

string

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

The maximum string length in characters is 100.

Field

Description

backups[]

Backup

List of PostgreSQL Backup resources.

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 will have its own nextPageToken to continue paging through the results.

Field

Description

id

string

Required. ID of the backup.

folderId

string

ID of the folder that the backup belongs to.

createdAt

string (date-time)

Creation timestamp in RFC3339 text format
(i.e. 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 PostgreSQL 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 backup, in bytes

type

enum (BackupCreationType)

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

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

method

enum (BackupMethod)

Method of backup creation

• BASE: Base backup
• INCREMENTAL: Delta (incremental) PostgreSQL backup

journalSize

string (int64)

Size of the journal associated with backup, in bytes

status

enum (BackupStatus)

Status of backup

• DONE: Backup is done
• CREATING: Backup is creating

retentionPolicyId

string

ID of assigned BackupRetentionPolicy.

retentionPolicyName

string

Name of assigned BackupRetentionPolicy.

retainUntil

string (date-time)

Expiration timestamp of the backup set by the BackupRetentionPolicy.

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).