Метод list

Получает список ресурсов Database для указанного кластера ClickHouse.

HTTP-запрос

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

Path-параметры

Параметр Описание
clusterId Обязательное поле. Идентификатор кластера ClickHouse, для которого нужно вывести список баз данных. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Номер страницы. Чтобы получить следующую страницу результатов, установите значение pageToken равным значению поля nextPageToken прошлого запроса. Максимальная длина строки в символах — 100.

Ответ

HTTP Code: 200 - OK

{
  "databases": [
    {
      "name": "string",
      "clusterId": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
databases[] object

Ресурс Database для ClickHouse. Подробнее см. в разделе Developer's Guide.

databases[].
name
string

Имя базы данных.

databases[].
clusterId
string

Идентификатор кластера ClickHouse, к которому принадлежит база данных.

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.