Contact UsGet started

Managed Service for MySQL API, REST: Cluster.ListBackups

Written by
Improved by
Updated at April 18, 2025

Retrieves a list of backups for a cluster.

To list all backups in a folder, make a BackupService.List request.

HTTP request

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

Path parameters

Field

Description

clusterId

string

Required field. ID of the cluster to list backups for.

To get this ID, make 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 API returns a ListClusterBackupsResponse.nextPageToken that can be used to get the next page of results in the subsequent ClusterService.ListBackups requests.

pageToken

string

Page token that can be used to iterate through multiple pages of results.

To get the next page of results, set pageToken to the ListClusterBackupsResponse.nextPageToken returned by the previous ClusterService.ListBackups request.

Response

HTTP Code: 200 - OK

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

Field

Description

backups[]

Backup

List of the cluster backups.

nextPageToken

string

The token that can be used to get the next page of results.

If the number of results is larger than ListClusterBackupsRequest.pageSize, use the nextPageToken as the value for the ListClusterBackupsRequest.pageToken in the subsequent ClusterService.ListBackups request to iterate through multiple pages of results.

Each of the subsequent ClusterService.ListBackups requests should use the nextPageToken value returned by the previous request to continue paging through the results.

Backup

An object that represents MySQL backup.

See the documentation for details.

Field

Description

id

string

Required field. ID of the backup.

folderId

string

ID of the folder that the backup belongs to.

createdAt

string (date-time)

Creation timestamp (the 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 cluster that the backup was created for.

startedAt

string (date-time)

Start timestamp (the 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...)

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

status

enum (BackupStatus)

Status of backup

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

journalSize

string (int64)

Size of the journal associated with backup, in bytes.
Previous
ListOperations
Next
ListHosts