Elasticsearch

Elasticsearch — распределённый поисковый движок: индексы, документы и аналитика. Блок ходит в API (Application Programming Interface — программный интерфейс) своего кластера или Elastic Cloud.

С Elasticsearch в Pailot вы можете:

Искать документы через Query DSL (Domain Specific Language — язык запросов Elasticsearch)
Индексировать, читать, частично обновлять и удалять документы
Делать bulk (пакет операций в одном запросе) и считать совпадения
Создавать и удалять индексы, смотреть здоровье и статистику кластера

Нужны тип развёртывания (self_hosted или cloud) и метод входа (api_key или basic_auth). Блок ставят на холст как отдельный шаг или прикрепляют к агенту. Секреты — в переменных окружения рабочего пространства.

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя индекса
`query`	string	Нет	Query DSL — строка JSON
`from`	number	Нет	Смещение страницы (по умолчанию 0)
`size`	number	Нет	Число результатов (по умолчанию 10)
`sort`	string	Нет	Сортировка — строка JSON
`sourceIncludes`	string	Нет	Поля `_source` через запятую — включить
`sourceExcludes`	string	Нет	Поля `_source` через запятую — исключить
`trackTotalHits`	boolean	Нет	Точный подсчёт совпадений (по умолчанию true)

Выход

Параметр	Тип	Описание
`took`	number	Время поиска в миллисекундах
`timed_out`	boolean	Поиск превысил таймаут
`hits`	object	Результаты: число совпадений и документы
`aggregations`	json	Агрегации, если были

`elasticsearch_index_document`

Индексировать документ (создать или обновить).

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Целевой индекс
`documentId`	string	Нет	ID документа (если пусто — сгенерируется)
`document`	string	Да	Тело документа — строка JSON
`refresh`	string	Нет	Политика refresh: true, false или wait_for

Выход

Параметр	Тип	Описание
`_index`	string	Индекс, куда записали документ
`_id`	string	ID документа
`_version`	number	Версия документа
`result`	string	Результат (created или updated)

`elasticsearch_get_document`

Прочитать документ по ID.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя индекса
`documentId`	string	Да	ID документа
`sourceIncludes`	string	Нет	Поля через запятую — включить
`sourceExcludes`	string	Нет	Поля через запятую — исключить

Выход

Параметр	Тип	Описание
`_index`	string	Имя индекса
`_id`	string	ID документа
`_version`	number	Версия документа
`found`	boolean	Документ найден
`_source`	json	Содержимое документа

`elasticsearch_update_document`

Частично обновить документ слиянием полей.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя индекса
`documentId`	string	Да	ID документа
`document`	string	Да	Частичный документ для слияния — строка JSON
`retryOnConflict`	number	Нет	Число повторов при конфликте версии

Выход

Параметр	Тип	Описание
`_index`	string	Имя индекса
`_id`	string	ID документа
`_version`	number	Новая версия документа
`result`	string	Результат (updated или noop)

`elasticsearch_delete_document`

Удалить документ по ID.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя индекса
`documentId`	string	Да	ID документа
`refresh`	string	Нет	Политика refresh: true, false или wait_for

Выход

Параметр	Тип	Описание
`_index`	string	Имя индекса
`_id`	string	ID документа
`_version`	number	Версия документа
`result`	string	Результат (deleted или not_found)

`elasticsearch_bulk`

Несколько операций index, create, delete или update в одном запросе.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Нет	Индекс по умолчанию, если в операции не указан
`operations`	string	Да	Операции bulk — строка NDJSON (JSON по строкам)
`refresh`	string	Нет	Политика refresh: true, false или wait_for

Выход

Параметр	Тип	Описание
`took`	number	Время операции в миллисекундах
`errors`	boolean	Были ли ошибки в операциях
`items`	array	Результат каждой операции

`elasticsearch_count`

Число документов, подходящих под запрос.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Индекс для подсчёта
`query`	string	Нет	Необязательный фильтр — строка JSON

Выход

Параметр	Тип	Описание
`count`	number	Число документов по запросу
`_shards`	object	Статистика шардов

`elasticsearch_create_index`

Создать индекс с необязательными settings и mappings.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя нового индекса
`settings`	string	Нет	Настройки индекса — строка JSON
`mappings`	string	Нет	Маппинги индекса — строка JSON

Выход

Параметр	Тип	Описание
`acknowledged`	boolean	Запрос принят
`shards_acknowledged`	boolean	Шарды подтверждены
`index`	string	Имя созданного индекса

`elasticsearch_delete_index`

Удалить индекс и все его документы. Операция необратима.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя индекса

Выход

Параметр	Тип	Описание
`acknowledged`	boolean	Удаление подтверждено

`elasticsearch_get_index`

Информация об индексе: settings, mappings и aliases.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`index`	string	Да	Имя индекса

Выход

Параметр	Тип	Описание
`index`	json	Данные индекса: aliases, mappings и settings

`elasticsearch_cluster_health`

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

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth
`waitForStatus`	string	Нет	Ждать статус: green, yellow или red
`timeout`	string	Нет	Таймаут ожидания (например, 30s, 1m)

Выход

Параметр	Тип	Описание
`cluster_name`	string	Имя кластера
`status`	string	Статус: green, yellow или red
`number_of_nodes`	number	Всего узлов
`number_of_data_nodes`	number	Число узлов данных
`active_shards`	number	Активные шарды
`unassigned_shards`	number	Неназначенные шарды

`elasticsearch_cluster_stats`

Сводная статистика кластера.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth

Выход

Параметр	Тип	Описание
`cluster_name`	string	Имя кластера
`status`	string	Статус здоровья
`nodes`	object	Статистика узлов: число и версии
`indices`	object	Статистика индексов: документы и размер

`elasticsearch_list_indices`

Список индексов: здоровье, статус и статистика.

Вход

Параметр	Тип	Обязательный	Описание
`deploymentType`	string	Да	Тип развёртывания: self_hosted или cloud
`host`	string	Нет	URL узла Elasticsearch (для self_hosted)
`cloudId`	string	Нет	Cloud ID Elastic (для cloud)
`authMethod`	string	Да	Метод входа: api_key или basic_auth
`apiKey`	string	Нет	Ключ API Elasticsearch
`username`	string	Нет	Имя пользователя для basic auth
`password`	string	Нет	Пароль для basic auth

Выход

Параметр	Тип	Описание
`message`	string	Краткое сообщение по индексам
`indices`	json	Массив сведений об индексах

Elasticsearch

На этой странице