Подключиться
Yandex Managed Service for ClickHouse

Метод listHosts

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

HTTP-запрос

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

Path-параметры

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "hosts": [
    {
      "name": "string",
      "clusterId": "string",
      "zoneId": "string",
      "type": "string",
      "resources": {
        "resourcePresetId": "string",
        "diskSize": "string",
        "diskTypeId": "string"
      },
      "health": "string",
      "services": [
        {
          "type": "string",
          "health": "string"
        }
      ],
      "subnetId": "string",
      "assignPublicIp": true,
      "shardName": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
hosts[] object

Запрошенный список хостов для кластера.
hosts[].
name		 string

Имя хоста ClickHouse. Имя хоста назначается MDB во время создания и не может быть изменено. Длина 1-63 символов.

Имя уникально для всех существующих хостов MDB в Яндекс.Облаке, так как оно определяет полное доменное имя (FQDN) хоста.
hosts[].
clusterId		 string

Идентификатор хоста ClickHouse. Этот идентификатор генерирует MDB при создании.
hosts[].
zoneId		 string

Идентификатор зоны доступности, в которой находится хост ClickHouse.
hosts[].
type		 string

Тип хоста.

  • CLICKHOUSE: Хост ClickHouse.
  • ZOOKEEPER: Хост ZooKeeper.
hosts[].
resources		 object

Ресурсы, выделенные хосту ClickHouse.
hosts[].
resources.
resourcePresetId		 string

Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
hosts[].
resources.
diskSize		 string (int64)

Объем хранилища, доступного хосту, в байтах.
hosts[].
resources.
diskTypeId		 string

Тип хранилища для хоста. Возможные значения:

  • network-hdd — сетевой HDD-диск;
  • network-ssd — сетевой SSD-диск;
  • local-ssd — локальное SSD-хранилище.
hosts[].
health		 string

Код работоспособности хоста.

  • UNKNOWN: Состояние хоста неизвестно.
  • ALIVE: Хост работает и выполняет все свои функции.
  • DEAD: Хост не работает и не может выполнять свои основные функции.
  • DEGRADED: Хост деградировал, и может выполнять только некоторые из своих основных функций.
hosts[].
services[]		 object

Сервисы, предоставляемые хостом.
hosts[].
services[].
type		 string

Тип сервиса, предоставляемого хостом.

  • CLICKHOUSE: Хост — это сервер ClickHouse.
  • ZOOKEEPER: Хост — сервер ZooKeeper.
hosts[].
services[].
health		 string

Код состояния доступности сервера.

  • UNKNOWN: Работоспособность сервера неизвестна.
  • ALIVE: Сервер работает нормально.
  • DEAD: Сервер отключен или не отвечает.
hosts[].
subnetId		 string

Идентификатор подсети, к которой принадлежит хост.
hosts[].
assignPublicIp		 boolean (boolean)

Флаг, показывающий статус публичного IP-адреса для этого хоста.
hosts[].
shardName		 string
nextPageToken string

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