› › ›

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

Получает результаты работы задания по обнаружению аномалий для одной или нескольких категорий.

Запрос

GET _ml/anomaly_detectors/<job_id>/results/categories

GET _ml/anomaly_detectors/<job_id>/results/categories/<category_id>

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

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

Описание

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

Результаты аномалий, полученные в результате анализа категоризации, доступны в виде результатов по корзинам, влияющим факторам и записям. Например, результаты могут указывать, что в 16:45 наблюдалось необычное количество сообщений категорий журнала 11. Затем можно изучить описание и примеры этой категории. Дополнительную информацию см. на странице Категоризация сообщений журналов.

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

<category_id>: (Необязательно, целое число) Идентификатор категории, уникальный в задании. Если вы не укажете ни идентификатор категории, ни partition_field_value, API возвращает информацию обо всех категориях. Если вы укажете только partition_field_value, он возвращает информацию обо всех категориях для указанного раздела.
<job_id>: (Обязательно, строка) Идентификатор задания по обнаружению аномалий.

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

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

Тело запроса

Вы также можете указать параметр запроса partition_field_value в теле запроса.

page

Свойства page

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

Тело ответа

API возвращает массив объектов категории, у которых есть следующие свойства:

category_id: (целое без знака) Уникальный идентификатор категории. category_id уникален на уровне задания, даже при включенной категоризации по разделам.
examples: (массив) Список примеров фактических значений, которые соответствуют категории.
grok_pattern: [preview] Эта функция находится в технической стадии предварительного просмотра и может быть изменена или удалена в будущих выпусках. Elastic будет работать над устранением любых проблем, но функции в техническом предварительном просмотре не подпадают под гарантию поддержки, предоставляемую официальным функциям GA. (строка) Шаблон Grok, который можно использовать в Logstash или конвейере приема для извлечения полей из сообщений, которые соответствуют категории. Это поле экспериментальное и может быть изменено или удалено в будущих выпусках. Найденные шаблоны Grok не являются оптимальными, но часто служат хорошей отправной точкой для ручного доработки.
job_id: (строка) Идентификатор задания по обнаружению аномалий.
max_matching_length: (целое без знака) Максимальная длина полей, которые соответствовали категории. Значение увеличивается на 10%, чтобы обеспечить соответствие аналогичным полям, которые не были проанализированы.

partition_field_name: (строка) Если включена категоризация по разделам, это свойство идентифицирует поле, используемое для сегментации категоризации. Его нет, когда категоризация по разделам отключена.
partition_field_value: (строка) Если включена категоризация по разделам, это свойство идентифицирует значение partition_field_name для категории. Его нет, когда категоризация по разделам отключена.
regex: (строка) Регулярное выражение, используемое для поиска значений, которые соответствуют категории.
terms: (строка) Список общих токенов, разделенных пробелом, которые сопоставлены в значениях категории.
num_matches: (целое число) Количество сообщений, соответствующих данной категории. Гарантируется только точное актуальное количество после выполнения задания _flush или _close
preferred_to_categories: (список) Список записей category_id, охватываемых текущей категорией. Любое новое сообщение, обрабатываемое категоризатором, будет сопоставляться с этой категорией, а не с категориями в этом списке. Гарантируется только точный актуальный список категорий после выполнения задания _flush или _close

Примеры

GET _ml/anomaly_detectors/esxi_log/results/categories
{
  "page":{
    "size": 1
  }
}

В этом примере API возвращает следующую информацию:

{
  "count": 11,
  "categories": [
    {
      "job_id" : "esxi_log",
      "category_id" : 1,
      "terms" : "Vpxa verbose vpxavpxaInvtVm opID VpxaInvtVmChangeListener Guest DiskInfo Changed",
      "regex" : ".*?Vpxa.+?verbose.+?vpxavpxaInvtVm.+?opID.+?VpxaInvtVmChangeListener.+?Guest.+?DiskInfo.+?Changed.*",
      "max_matching_length": 154,
      "examples" : [
        "Oct 19 17:04:44 esxi1.acme.com Vpxa: [3CB3FB90 verbose 'vpxavpxaInvtVm' opID=WFU-33d82c31] [VpxaInvtVmChangeListener] Guest DiskInfo Changed",
        "Oct 19 17:04:45 esxi2.acme.com Vpxa: [3CA66B90 verbose 'vpxavpxaInvtVm' opID=WFU-33927856] [VpxaInvtVmChangeListener] Guest DiskInfo Changed",
        "Oct 19 17:04:51 esxi1.acme.com Vpxa: [FFDBAB90 verbose 'vpxavpxaInvtVm' opID=WFU-25e0d447] [VpxaInvtVmChangeListener] Guest DiskInfo Changed",
        "Oct 19 17:04:58 esxi2.acme.com Vpxa: [FFDDBB90 verbose 'vpxavpxaInvtVm' opID=WFU-bbff0134] [VpxaInvtVmChangeListener] Guest DiskInfo Changed"
      ],
      "grok_pattern" : ".*?%{SYSLOGTIMESTAMP:timestamp}.+?Vpxa.+?%{BASE16NUM:field}.+?verbose.+?vpxavpxaInvtVm.+?opID.+?VpxaInvtVmChangeListener.+?Guest.+?DiskInfo.+?Changed.*"
    }
  ]
}

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