› › ›

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.

Примеры

resp = client.ml.get_calendar_events(
    calendar_id="planned-outages",
)
print(resp)

response = client.ml.get_calendar_events(
  calendar_id: 'planned-outages'
)
puts response

const response = await client.ml.getCalendarEvents({
  calendar_id: "planned-outages",
});
console.log(response);

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"
    }
  ]
}

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

resp = client.ml.get_calendar_events(
    calendar_id="planned-outages",
    start="1635638400000",
    end="1635724800000",
)
print(resp)

response = client.ml.get_calendar_events(
  calendar_id: 'planned-outages',
  start: 1_635_638_400_000,
  end: 1_635_724_800_000
)
puts response

const response = await client.ml.getCalendarEvents({
  calendar_id: "planned-outages",
  start: 1635638400000,
  end: 1635724800000,
});
console.log(response);

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