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

Cluster

Набор методов для управления кластерами Elasticsearch.

JSON-представление

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "elasticsearch": {
      "dataNode": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        },
        "elasticsearchConfigSet_7_6": {
          "effectiveConfig": {
            "fielddataCacheSize": "integer",
            "maxClauseCount": "integer"
          },
          "userConfig": {
            "fielddataCacheSize": "integer",
            "maxClauseCount": "integer"
          },
          "defaultConfig": {
            "fielddataCacheSize": "integer",
            "maxClauseCount": "integer"
          }
        }
      },
      "masterNode": {
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string",
          "diskTypeId": "string"
        }
      }
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}
Поле Описание
id string

Идентификатор кластера Elasticsearch. Этот идентификатор генерируется при создании кластера.
folderId string

Идентификатор каталога, которому принадлежит кластер Elasticsearch.
createdAt string (date-time)

Время создания.

Строка в формате RFC3339.
name string

Имя кластера Elasticsearch. Имя должно быть уникальным в рамках каталога. Длина 1-63 символов.
description string

Описание кластера Elasticsearch. Длина описания должна быть от 0 до 256 символов.
labels object

Пользовательские метки для кластера Elasticsearch в виде пар key:value. Максимум 64 на ресурс.
environment string

Среда развертывания кластера Elasticsearch.

  • PRODUCTION: стабильная среда с осторожной политикой обновления — во время регулярного обслуживания применяются только срочные исправления.
  • PRESTABLE: среда с более агрессивной политикой обновления — новые версии развертываются независимо от обратной совместимости.
monitoring[] object

Метаданные системы мониторинга.
monitoring[].
name		 string

Название системы мониторинга.
monitoring[].
description		 string

Описание системы мониторинга.
monitoring[].
link		 string

Ссылка на графики системы мониторинга для кластера Elasticsearch.
config object

Конфигурация кластера Elasticsearch.
config.
version		 string

Версия Elasticsearch.
config.
elasticsearch		 object

Конфигурация и распределение ресурсов для узлов Elasticsearch.
config.
elasticsearch.
dataNode		 object

Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Data node.
config.
elasticsearch.
dataNode.
resources		 object
config.
elasticsearch.
dataNode.
resources.
resourcePresetId		 string

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

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

Тип хранилища для хоста. Все доступные типы перечислены в документации.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6		 object

Конфигурация Elasticsearch 7.6 для узла с ролью Data node.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
effectiveConfig		 object

Обязательное поле. Действующие настройки для кластера Elasticsearch (сочетание параметров, определенных в userConfig и defaultConfig).

Здесь перечислены поддерживаемые параметры конфигурации Elasticsearch 7.6.

Подробное описание всех параметров доступно в документации Elasticsearch.

Любые параметры, не перечисленные здесь, не поддерживаются.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
effectiveConfig.
fielddataCacheSize		 integer (int64)

Максимальный процент от общего объема кучи (heap), который может выделяться под кэш данных в полях.

Все значения полей, помещенные в этот кэш, загружаются в память для обеспечения быстрого доступа к этим значениям при работе с документами. Построение кэша данных для поля — затратная операция, поэтому рекомендуется иметь достаточный объем памяти для этого кэша и поддерживать его в заполненном состоянии.

Значение по умолчанию: не ограничено.

См. подробное описание в документации Elasticsearch.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
effectiveConfig.
maxClauseCount		 integer (int64)

Максимальное число выражений, которое может содержаться в булевом запросе (bool query).

Эта настройка позволяет не допустить разрастания поисковых запросов до больших размеров, чтобы запросы не потребляли много памяти и ресурсов процессора. Настройка влияет не только на запросы типа bool, но и на многие другие запросы, которые неявно преобразуются Elasticsearch в запросы типа bool.

Значение по умолчанию: 1024.

См. подробное описание в документации Elasticsearch.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
userConfig		 object

Пользовательские настройки для кластера Elasticsearch.

Здесь перечислены поддерживаемые параметры конфигурации Elasticsearch 7.6.

Подробное описание всех параметров доступно в документации Elasticsearch.

Любые параметры, не перечисленные здесь, не поддерживаются.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
userConfig.
fielddataCacheSize		 integer (int64)

Максимальный процент от общего объема кучи (heap), который может выделяться под кэш данных в полях.

Все значения полей, помещенные в этот кэш, загружаются в память для обеспечения быстрого доступа к этим значениям при работе с документами. Построение кэша данных для поля — затратная операция, поэтому рекомендуется иметь достаточный объем памяти для этого кэша и поддерживать его в заполненном состоянии.

Значение по умолчанию: не ограничено.

См. подробное описание в документации Elasticsearch.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
userConfig.
maxClauseCount		 integer (int64)

Максимальное число выражений, которое может содержаться в булевом запросе (bool query).

Эта настройка позволяет не допустить разрастания поисковых запросов до больших размеров, чтобы запросы не потребляли много памяти и ресурсов процессора. Настройка влияет не только на запросы типа bool, но и на многие другие запросы, которые неявно преобразуются Elasticsearch в запросы типа bool.

Значение по умолчанию: 1024.

См. подробное описание в документации Elasticsearch.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
defaultConfig		 object

Настройки по умолчанию для кластера Elasticsearch.

Здесь перечислены поддерживаемые параметры конфигурации Elasticsearch 7.6.

Подробное описание всех параметров доступно в документации Elasticsearch.

Любые параметры, не перечисленные здесь, не поддерживаются.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
defaultConfig.
fielddataCacheSize		 integer (int64)

Максимальный процент от общего объема кучи (heap), который может выделяться под кэш данных в полях.

Все значения полей, помещенные в этот кэш, загружаются в память для обеспечения быстрого доступа к этим значениям при работе с документами. Построение кэша данных для поля — затратная операция, поэтому рекомендуется иметь достаточный объем памяти для этого кэша и поддерживать его в заполненном состоянии.

Значение по умолчанию: не ограничено.

См. подробное описание в документации Elasticsearch.
config.
elasticsearch.
dataNode.
elasticsearchConfigSet_7_6.
defaultConfig.
maxClauseCount		 integer (int64)

Максимальное число выражений, которое может содержаться в булевом запросе (bool query).

Эта настройка позволяет не допустить разрастания поисковых запросов до больших размеров, чтобы запросы не потребляли много памяти и ресурсов процессора. Настройка влияет не только на запросы типа bool, но и на многие другие запросы, которые неявно преобразуются Elasticsearch в запросы типа bool.

Значение по умолчанию: 1024.

См. подробное описание в документации Elasticsearch.
config.
elasticsearch.
masterNode		 object

Конфигурация и распределение ресурсов для узлов Elasticsearch с ролью Master node.
config.
elasticsearch.
masterNode.
resources		 object

Ресурсы, выделенные узлам Elasticsearch с ролью Master node.
config.
elasticsearch.
masterNode.
resources.
resourcePresetId		 string

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

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

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

Идентификатор сети, к которой принадлежит кластер.
health string

Здоровье кластера.

  • HEALTH_UNKNOWN: состояние кластера неизвестно (health всех хостов в кластере — UNKNOWN).
  • ALIVE: кластер работает нормально (health всех хостов в кластере — ALIVE).
  • DEAD: кластер не работает (health всех хостов в кластере — DEAD).
  • DEGRADED: кластер находится в состоянии деградации (health по крайней мере одного из хостов в кластере — не ALIVE).
status string

Текущее состояние кластера.

  • STATUS_UNKNOWN: состояние кластера неизвестно.
  • CREATING: кластер создается.
  • RUNNING: кластер работает нормально.
  • ERROR: в кластере произошла ошибка, блокирующая работу.
  • UPDATING: кластер изменяется.
  • STOPPING: кластер останавливается.
  • STOPPED: кластер остановлен.
  • STARTING: кластер запускается.

Методы

Метод Описание
addHosts Добавляет новые хосты в указанный кластер Elasticsearch.
create Создает новый кластер Elasticsearch в указанном каталоге.
delete Удаляет указанный кластер Elasticsearch.
deleteHosts Удаляет хосты из указанного кластера Elasticsearch.
get Возвращает указанный кластер Elasticsearch.
list Получает список кластеров Elasticsearch, принадлежащих указанному каталогу.
listHosts Получает список хостов для указанного кластера Elasticsearch.
listLogs Получает логи для указанного кластера Elasticsearch.
listOperations Получает список операций для указанного кластера Elasticsearch.
move Перемещает кластер Elasticsearch в указанный каталог.
start Запускает указанный кластер Elasticsearch.
stop Останавливает указанный кластер Elasticsearch.
streamLogs То же самое, что listLogs, с той разницей, что со стороны сервера передается поток логов. Допускается использовать семантику tail -f при работе с потоком логов.
update Изменяет указанный кластер Elasticsearch.
В этой статье: