Method listBackups

Retrieves the list of available backups for the specified ClickHouse cluster.

HTTP request

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

Path parameters

Parameter Description
clusterId Required. ID of the ClickHouse cluster. To get the ClickHouse cluster ID, use a list request. The maximum string length in characters is 50.

Query parameters

Parameter Description
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.

Response

HTTP Code: 200 - OK

 {
  "backups": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "sourceClusterId": "string",
      "startedAt": "string"
    }
  ],
  "nextPageToken": "string"
}
Field Description
backups[] object

A ClickHouse Backup resource. See the Developer's Guide for more information.

backups[].
id
string

ID of the backup.

backups[].
folderId
string

ID of the folder that the backup belongs to.

backups[].
createdAt
string (date-time)

Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).

backups[].
sourceClusterId
string

ID of the ClickHouse cluster that the backup was created for.

backups[].
startedAt
string (date-time)

Time when the backup operation was started.

nextPageToken string

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken query parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.