Managed Service for ClickHouse API, REST: Cluster.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
Field |
Description |
clusterId |
string Required field. ID of the ClickHouse 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",
"sourceShardNames": [
"string"
],
"startedAt": "string",
"size": "string",
"type": "string"
}
],
"nextPageToken": "string"
}
Field |
Description |
backups[] |
List of ClickHouse 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 ClickHouse Backup resource. See the Developer's Guide
for more information.
Field |
Description |
id |
string 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 ClickHouse cluster that the backup was created for. |
sourceShardNames[] |
string Names of the shards included in the backup. |
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 (BackupType) How this backup was created (manual/automatic/etc...).
|