API закрытия задач обнаружения аномалий
Закрывает одну или несколько задач обнаружения аномалий.
Запрос
POST _ml/anomaly_detectors/<job_id>/_close
POST _ml/anomaly_detectors/<job_id>,<job_id>/_close
POST _ml/anomaly_detectors/_all/_close
Предварительные условия
- Требуется привилегия
manage_mlкластера. Эта привилегия включена в встроенную рольmachine_learning_admin.
Описание
Задача может быть открыта и закрыта несколько раз на протяжении всего ее жизненного цикла.
Закрытая задача не может получать данные или выполнять операции анализа, но вы по-прежнему можете просматривать и изучать результаты.
Если вы закрываете задачу обнаружения аномалий, у которой работает поток данных, запрос сначала пытается остановить поток данных. Это поведение эквивалентно вызову API остановки потока данных с теми же параметрами timeout и force, что и в запросе на закрытие задачи.
При закрытии задачи она выполняет задачи по обслуживанию, такие как обрезка истории модели, сброс буферов, вычисление окончательных результатов и сохранение снимков модели. В зависимости от размера задачи, закрытие может занять несколько минут, а время повторного открытия — аналогичное.
После закрытия задача оказывает минимальную нагрузку на кластер, за исключением поддержания метаданных. Поэтому рекомендуется закрывать задачи, которые больше не требуются для обработки данных.
Когда поток данных, имеющий указанную конечную дату, останавливается, он автоматически закрывает связанную с ним задачу.
Если вы используете параметр запроса force, запрос возвращается, не выполняя связанные действия, такие как сброс буферов и сохранение снимков модели. Поэтому не используйте этот параметр, если вы хотите, чтобы задача находилась в согласованном состоянии после возврата API закрытия задачи. Параметр запроса force следует использовать только в ситуациях, когда задача уже завершилась неудачно или когда вас не интересуют результаты, которые задача могла недавно выдать или может выдать в будущем.
Параметры пути
-
<job_id> -
(Обязательный, строка) Идентификатор задачи обнаружения аномалий. Это может быть идентификатор задачи, имя группы или выражение с подстановкой.
Вы можете закрыть все задачи, используя
_allили указав*в качестве идентификатора задачи.
Параметры запроса
-
allow_no_match -
(Необязательно, логическое значение) Указывает, что делать, когда запрос:
- Содержит выражения с подстановкой, и нет соответствующих задач.
- Содержит строку
_allили нет идентификаторов, и нет совпадений. - Содержит выражения с подстановкой и есть только частичные совпадения.
Значение по умолчанию —
true, которое возвращает пустой массивjobsпри отсутствии совпадений и подмножество результатов при частичных совпадениях. Если этот параметр равенfalse, запрос возвращает код состояния404при отсутствии совпадений или только частичных совпадениях. -
force - (Необязательно, логическое значение) Используйте для закрытия завершившейся неудачно задачи или для принудительного закрытия задачи, которая не ответила на первоначальный запрос на закрытие.
-
timeout - (Необязательно, единицы измерения времени) Управляет временем ожидания закрытия задачи. Значение по умолчанию — 30 минут.
Тело запроса
Вы также можете указать параметры запроса (такие как allow_no_match и force) в теле запроса.
Коды ответов
-
404(Отсутствующие ресурсы) - Если
allow_no_matchравноfalse, этот код указывает на отсутствие ресурсов, соответствующих запросу, или только частичных совпадений для запроса.
Примеры
resp = client.ml.close_job(
job_id="low_request_rate",
)
print(resp) response = client.ml.close_job( job_id: 'low_request_rate' ) puts response
const response = await client.ml.closeJob({
job_id: "low_request_rate",
});
console.log(response); POST _ml/anomaly_detectors/low_request_rate/_close
При закрытии задачи вы получаете следующие результаты:
{
"closed": true
}
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ml-close-job.html