API фоновых задач

Создание фоновой задачи

Общий вид запроса для запуска фоновой задачи:

POST _sme/async_requests/request
{
  "query" : "source sysmon_operational-* qsize=5 ",
  "dtFieldName": "@timestamp",
  "dtStart": "now-1d",
  "dtEnd": "now",
  "calculateStats": true,
  "calculateExecutionCost": "DEBUG"
}

Название	Синтаксис	Обязательный	По умолчанию	Описание
query	<string>	Обязательный		Поисковый запрос.
dtFieldName	<string>	Нет	указывается в кластерной настройке sme.core.global_dt_params.dt_field_name	Имя поля в котором хранится временная метка.
dtStart	<string>	Нет	указывается в кластерной настройке sme.core.global_dt_params.dt_start	Начальная временная метка поиска.
dtEnd	<string>	Нет	указывается в кластерной настройке sme.core.global_dt_params.dt_end	Конечная временная метка поиска.
calculateStats	<bool>	Нет	false	При значении true выполняется расчет sidebar и timeline.
calculateExecutionCost	<string>	Нет	OFF	Рассчитывает статистику выполнения запроса. Может принимать значения OFF, INFO, DEBUG.

к сведению

Значения sidebar и timeline всегда будут рассчитываться при помощи java.

Запрос результата фоновой задачи

GET _sme/async_requests/response/{id}?from={from}&to={to}

Название	Синтаксис	Обязательный	По умолчанию	Описание
id	<string>	Да		Id фоновой задачи.
from	<int>	Нет	не ограничено	Начальный индекс результатов (включительно).
to	<int>	Нет	не ограничено	Конечный индекс результатов (не включительно).

Пример запроса получения всех результатов фоновой задачи:

GET _sme/async_requests/response/12345

Пример запроса результатов с индексами от 100 до 199:

GET _sme/async_requests/response/12345?from=100&to=200

Запрос логов фоновой задачи

GET _sme/async_requests/logs/{id}

Название	Синтаксис	Обязательный	По умолчанию	Описание
id	<string>	Да		Id фоновой задачи.

Пример запроса получения логов фоновой задачи:

GET _sme/async_requests/logs/12345

Запрос статуса фоновой задачи

GET _sme/async_requests/status/{id}

Название	Синтаксис	Обязательный	По умолчанию	Описание
id	<string>	Да		Id фоновой задачи. Если не указать id, вернутся статусы всех фоновых задач, доступных пользователю.

Пример запроса получения статуса определенной фоновой задачи:

GET _sme/async_requests/status/12345

Пример запроса получения статуса всех фоновых задач:

GET _sme/async_requests/status/

Остановка выполнения фоновой задачи

к сведению

Этот запрос работает только для не завершенных фоновых задач.

POST _sme/async_requests/break/{id}

Название	Синтаксис	Обязательный	По умолчанию	Описание
id	<string>	Да		Id фоновой задачи. Если не указать id, отменятся все активные фоновые задачи, доступные пользователю.

Пример отмены определенной фоновой задачи:

POST _sme/async_requests/break/12345

Пример отмены всех активных фоновых задач:

POST _sme/async_requests/break/

Удаление результата фоновой задачи

DELETE _sme/async_requests/delete/{id}

Название	Синтаксис	Обязательный	По умолчанию	Описание
id	<string>	Да		Id фоновой задачи.

Пример удаления результата фоновой задачи с диска:

DELETE _sme/async_requests/delete/12345

Выгрузка результата фоновой задачи в файл

Общий вид запроса для получения файла с результатами фоновой задачи:

POST _sme/async_requests/file_download/{id}
{
  "file_name": "my_file",
  "file_type": "json",
  "compress_results": false,
  "download_all_results": false,
  "download_results_size": 1000
}

Название	Синтаксис	Обязательный	По умолчанию	Описание
id	<string>	Да		Id фоновой задачи.
file_name	<int>	Да		Название файла с результатом.
file_type	<int>	Да		Тип файла с результатом (json, csv, xlsx).
compress_results	<bool>	Нет	false	При значении true создает .zip архив.
download_all_results	<bool>	Нет	false	При значении true выгружает все события.
download_results_size	<int>	Нет	10000	Используется при download_all_results=false.