Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST API ›API для обнаружения аномалий с машинным обучением

API получения статистики по данным по источникам

Справочник по новым API

Для получения самых последних данных об API обратитесь к API для обнаружения аномалий с машинным обучением.

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

Запрос

GET _ml/datafeeds/<feed_id>/_stats

GET _ml/datafeeds/<feed_id>,<feed_id>/_stats

GET _ml/datafeeds/_stats

GET _ml/datafeeds/_all/_stats

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

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

Описание

Если источник данных остановлен, вы получите только информацию о datafeed_id и state.

Этот API возвращает не более 10 000 источников данных.

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

<feed_id>

(Необязательно, строка) Идентификатор источника данных. Он может быть идентификатором источника данных или выражением с подстановкой.

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

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

allow_no_match

(Необязательно, логическое значение) Указывает, что делать, когда запрос:

  • Содержит выражения с подстановкой, и нет источников данных, соответствующих запросу.
  • Содержит строку _all или нет идентификаторов, и нет совпадений.
  • Содержит выражения с подстановкой, и есть только частичные совпадения.

Значение по умолчанию — true, которое возвращает пустой массив datafeeds при отсутствии совпадений и подмножество результатов при частичном совпадении. Если этот параметр равен false, запрос возвращает код состояния 404 при отсутствии совпадений или только частичном совпадении.

Тело ответа

API возвращает массив объектов счётчиков источников данных. Все эти свойства информационные; вы не можете обновить их значения.

assignment_explanation
(строка) Только для запущенных источников данных, содержит сообщения, относящиеся к выбору узла.
datafeed_id
(строка) Числовая строка, которая однозначно идентифицирует источник данных. Этот идентификатор может содержать строчные буквенно-цифровые символы (a-z и 0-9), дефисы и подчёркивания. Он должен начинаться и заканчиваться буквенно-цифровыми символами.
node

(объект) Только для запущенных источников данных, эта информация относится к узлу, на котором запущен источник данных.

Подробности
attributes
(объект) Список атрибутов узла, таких как ml.machine_memory или параметры ml.max_open_jobs.
ephemeral_id
(строка) Временный идентификатор узла.
id
(строка) Уникальный идентификатор узла.
name
(строка) Имя узла. Например, 0-o0tOo.
transport_address
(строка) Хост и порт, где принимаются транспортные HTTP-соединения.
running_state

(объект) Объект, содержащий состояние работы этого источника данных. Он предоставляется только если источник данных запущен.

Подробности
real_time_configured
(булево значение) Указывает, является ли источник данных "реальным временем"; означает, что для источника данных не задано время end.
real_time_running
(булево значение) Указывает, завершил ли источник данных обработку доступных прошлых данных. Для источников данных без заданного времени end это означает, что источник данных теперь обрабатывает данные "в реальном времени".
search_interval

(Необязательно, объект) Предоставляет последний интервал времени, по которому источник данных искал.

Подробности
start_ms
Начальное время как эпоха в миллисекундах.
end_ms
Конечное время как эпоха в миллисекундах.
state

(строка) Состояние источника данных, которое может принимать следующие значения:

  • starting: Источник данных запрошен на запуск, но ещё не запущен.
  • started: Источник данных активно получает данные.
  • stopping: Источник данных запрошен на плавное завершение и выполняет последнее действие.
  • stopped: Источник данных остановлен и не будет получать данные до перезапуска.
timing_stats

(объект) Объект, предоставляющий статистическую информацию о временных аспектах этого источника данных.

Подробности
average_search_time_per_bucket_ms
(двойное значение) Среднее время поиска на ведро в миллисекундах.
bucket_count
(целое число) Количество обработанных ведер.
exponential_average_search_time_per_hour_ms
(двойное значение) Экспоненциальное среднее время поиска в час в миллисекундах.
job_id
Идентификатор задачи обнаружения аномалий.
search_count
Количество выполненных поисков источником данных.
total_search_time_ms
Общее время поиска, проведённое источником данных, в миллисекундах.

Коды ответа

404 (Отсутствующие ресурсы)
Если allow_no_match равно false, этот код указывает, что ресурсов, соответствующих запросу, нет или есть только частичные совпадения.

Примеры

resp = client.ml.get_datafeed_stats(
    datafeed_id="datafeed-high_sum_total_sales",
)
print(resp)
response = client.ml.get_datafeed_stats(
  datafeed_id: 'datafeed-high_sum_total_sales'
)
puts response
const response = await client.ml.getDatafeedStats({
  datafeed_id: "datafeed-high_sum_total_sales",
});
console.log(response);
GET _ml/datafeeds/datafeed-high_sum_total_sales/_stats

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

{
  "count" : 1,
  "datafeeds" : [
    {
      "datafeed_id" : "datafeed-high_sum_total_sales",
      "state" : "started",
      "node" : {
        "id" : "7bmMXyWCRs-TuPfGJJ_yMw",
        "name" : "node-0",
        "ephemeral_id" : "hoXMLZB0RWKfR9UPPUCxXX",
        "transport_address" : "127.0.0.1:9300",
        "attributes" : {
          "ml.machine_memory" : "17179869184",
          "ml.max_open_jobs" : "512"
        }
      },
      "assignment_explanation" : "",
      "timing_stats" : {
        "job_id" : "high_sum_total_sales",
        "search_count" : 7,
        "bucket_count" : 743,
        "total_search_time_ms" : 134.0,
        "average_search_time_per_bucket_ms" : 0.180349932705249,
        "exponential_average_search_time_per_hour_ms" : 11.514712961628677
      }
    }
  ]
}

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API