Метод listBackups
Получает список доступных резервных копий для указанного кластера ClickHouse.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/{clusterId}/backups
Path-параметры
| Параметр | Описание |
|---|---|
| clusterId | Обязательное поле. Идентификатор кластера ClickHouse. Чтобы получить идентификатор кластера ClickHouse, используйте запрос list. Максимальная длина строки в символах — 50. |
Query-параметры
| Параметр | Описание |
|---|---|
| pageSize | Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000. |
| pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
Ответ
HTTP Code: 200 - OK
{
"backups": [
{
"id": "string",
"folderId": "string",
"createdAt": "string",
"sourceClusterId": "string",
"sourceShardNames": [
"string"
],
"startedAt": "string"
}
],
"nextPageToken": "string"
}
| Поле | Описание |
|---|---|
| backups[] | object Ресурс Backup для ClickHouse. Подробное описание см. в документации. |
| backups[]. id |
string Идентификатор резервной копии. |
| backups[]. folderId |
string Идентификатор каталога, которому принадлежит резервная копия. |
| backups[]. createdAt |
string (date-time) Время создания в формате RFC3339 (т. е. когда операция резервного копирования была завершена). Строка в формате RFC3339. |
| backups[]. sourceClusterId |
string Идентификатор кластера ClickHouse, для которого была создана резервная копия. |
| backups[]. sourceShardNames[] |
string Имена шардов, включенных в резервную копию. |
| backups[]. startedAt |
string (date-time) Время запуска операции резервного копирования. Строка в формате RFC3339. |
| nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |