› › ›

API получения запланированных событий

Получает информацию о запланированных событиях в календарях.

Запрос

GET _ml/calendars/<calendar_id>/events

GET _ml/calendars/_all/events

Предварительные условия

Требуется привилегия кластера monitor_ml. Эта привилегия включена в встроенную роль machine_learning_user.

Описание

Для получения дополнительной информации см. Календари и запланированные события.

Параметры пути

<calendar_id>

(Обязательно, строка) Строка, уникально идентифицирующая календарь.

Вы можете получить информацию о запланированных событиях для нескольких календарей в одном запросе API, используя список идентификаторов, разделенных запятыми, или выражение с подстановкой. Вы можете получить информацию о запланированных событиях для всех календарей, используя _all или * в качестве идентификатора календаря.

Параметры запроса

end: (Необязательно, строка) Указывает на получение событий со временем, предшествующим этому времени.
from: (Необязательно, целое число) Пропускает указанное количество событий. По умолчанию 0.
job_id: (Необязательно, строка) Указывает на получение событий для конкретного идентификатора задачи обнаружения аномалий или группы задач. Должен использоваться с идентификатором календаря _all или *.
size: (Необязательно, целое число) Указывает максимальное количество событий для получения. По умолчанию 100.
start: (Необязательно, строка) Указывает на получение событий со временем, следующим за этим временем.

Тело запроса

Параметры запроса также можно указать в теле запроса; исключениями являются from и size, используйте page вместо них:

page

Свойства page

from: (Необязательно, целое число) Пропускает указанное количество событий. По умолчанию 0.
size: (Необязательно, целое число) Указывает максимальное количество событий для получения. По умолчанию 100.

Тело ответа

API возвращает массив ресурсов запланированных событий, имеющих следующие свойства:

calendar_id: (строка) Строка, уникально идентифицирующая календарь.
description: (строка) Описание запланированного события.
end_time: (дата) Отметка времени окончания запланированного события в миллисекундах с начала эпохи или в формате ISO 8601.
event_id: (строка) Автоматически сгенерированный идентификатор запланированного события.
start_time: (дата) Отметка времени начала запланированного события в миллисекундах с начала эпохи или в формате ISO 8601.

Примеры

GET _ml/calendars/planned-outages/events

API возвращает следующие результаты:

{
  "count": 3,
  "events": [
    {
      "description": "event 1",
      "start_time": 1513641600000,
      "end_time": 1513728000000,
      "calendar_id": "planned-outages",
      "event_id": "LS8LJGEBMTCMA-qz49st"
    },
    {
      "description": "event 2",
      "start_time": 1513814400000,
      "end_time": 1513900800000,
      "calendar_id": "planned-outages",
      "event_id": "Li8LJGEBMTCMA-qz49st"
    },
    {
      "description": "event 3",
      "start_time": 1514160000000,
      "end_time": 1514246400000,
      "calendar_id": "planned-outages",
      "event_id": "Ly8LJGEBMTCMA-qz49st"
    }
  ]
}

Следующий пример получает запланированные события, которые происходят в определенный период времени:

GET _ml/calendars/planned-outages/events?start=1635638400000&end=1635724800000

© 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/7.17/ml-get-calendar-event.html