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

Метод listHosts

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

HTTP-запрос

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

Path-параметры

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

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на одной странице в ответе. Если количество результатов больше чем page_size, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение page_token равным значению поля 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
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
hosts[] object

Метаданные хоста кластера.
hosts[].
name		 string

Имя хоста.
hosts[].
clusterId		 string

Идентификатор кластера Elasticsearch.
hosts[].
zoneId		 string

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

Тип хоста.

  • DATA_NODE: этот хост является узлом Elasticsearch с ролью Data node.
  • MASTER_NODE: этот хост является узлом Elasticsearch с ролью Master node.
hosts[].
resources		 object
hosts[].
resources.
resourcePresetId		 string

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

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

Тип хранилища для хоста. Все доступные типы перечислены в документации.
hosts[].
health		 string

Агрегированные данные о работоспособности хоста.

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

Метаданные сервисов кластера.
hosts[].
services[].
type		 string

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

  • ELASTICSEARCH: сервис Elasticsearch.
hosts[].
services[].
health		 string

Данные о работоспособности сервиса.

  • UNKNOWN: состояние сервиса неизвестно.
  • ALIVE: сервис работает в штатном режиме.
  • DEAD: сервис не работает или не отвечает.
hosts[].
subnetId		 string

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

Флаг, определяющий, назначен ли хосту публичный IP-адрес.

Если значение равно true, то этот хост доступен в Интернете через его публичный IP-адрес.
nextPageToken string

Токен для получения следующей страницы результатов в ответе.

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