› › ›

API получения календарей

Извлекает конфигурационную информацию для календарей.

Запрос

GET _ml/calendars/<calendar_id>

GET _ml/calendars/_all

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

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

Описание

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

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

<calendar_id>

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

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

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

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

Тело запроса

page

Свойства page

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

Тело ответа

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

calendar_id: (строка) Строка, уникально идентифицирующая календарь.
job_ids: (массив) Массив идентификаторов задач обнаружения аномалий. Например: ["total-requests"].

Примеры

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

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

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

GET _ml/calendars/planned-outages

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

{
  "count": 1,
  "calendars": [
    {
      "calendar_id": "planned-outages",
      "job_ids": [
        "total-requests"
      ]
    }
  ]
}

© 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.html