Managed Service for PostgreSQL API, REST: Cluster.ListBackups
Retrieves the list of available backups for the specified PostgreSQL cluster.
HTTP request
GET https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/{clusterId}/backups
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the PostgreSQL cluster. |
Query parameters
Field |
Description |
pageSize |
string (int64) The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, set |
Response
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"startedAt": "string",
"size": "string",
"type": "string",
"method": "string",
"journalSize": "string",
"status": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
backups[] |
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 |
Backup
A PostgreSQL Backup resource. For more information, see
the Developer's Guide.
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 String in RFC3339 To work with values in this field, use the APIs described in the |
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 To work with values in this field, use the APIs described in the |
size |
string (int64) Size of backup, in bytes |
type |
enum (BackupCreationType) How this backup was created (manual/automatic/etc...)
|
method |
enum (BackupMethod) Method of backup creation
|
journalSize |
string (int64) Size of the journal associated with backup, in bytes |
status |
enum (BackupStatus) Status of backup
|