› › ›

API получения задач аналитики фреймов данных

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

Запрос

GET _ml/data_frame/analytics/<data_frame_analytics_id>

GET _ml/data_frame/analytics/<data_frame_analytics_id>,<data_frame_analytics_id>

GET _ml/data_frame/analytics/

GET _ml/data_frame/analytics/_all

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

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

Описание

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

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

<data_frame_analytics_id>

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

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

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

allow_no_match

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

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

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

from

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

size

(Необязательно, целое число) Указывает максимальное количество задач аналитики фреймов данных для получения. Значение по умолчанию - 100.

exclude_generated

(Необязательно, логическое значение) Указывает, нужно ли удалять определённые поля из конфигурации при получении. Это позволяет представить конфигурацию в формате, пригодном для извлечения и последующего добавления в другой кластер. Значение по умолчанию - false.

Тело ответа

data_frame_analytics

(массив) Массив ресурсов задач анализа фреймов данных, отсортированных по значению id в порядке возрастания.

Свойства ресурсов задач анализа фреймов данных

analysis: (объект) Тип анализа, выполняемого над source.

analyzed_fields

(объект) Содержит includes и/или excludes шаблоны, которые выбирают поля, включённые в анализ.

Свойства analyzed_fields

excludes: (Необязательный массив) Массив строк, определяющих поля, исключённые из анализа.
includes: (Необязательный массив) Массив строк, определяющих поля, включённые в анализ.

dest

(строка) Конфигурация назначения анализа.

Свойства dest

index: (строка) Индекс назначения, в котором хранятся результаты задачи анализа фреймов данных.
results_field: (строка) Название поля, в котором хранятся результаты анализа. По умолчанию ml.

id

(строка) Уникальный идентификатор задачи анализа фреймов данных.

model_memory_limit

(строка) model_memory_limit, установленное для задачи анализа фреймов данных.

source

(объект) Конфигурация источников данных для анализа. Она содержит параметр index и необязательно параметры query и _source.

Свойства source

index

(массив) Индекс или индексы, на которых необходимо выполнить анализ. Это может быть один индекс или шаблон индекса, а также массив индексов или шаблонов.

query

(объект) Запрос, указанный для задачи анализа фреймов данных. Язык запросов Elasticsearch (DSL). Это значение соответствует объекту запроса в теле POST-запроса Elasticsearch. По умолчанию это свойство имеет следующее значение: {"match_all": {}}.

_source

(объект) Содержит указанные includes и/или excludes шаблоны, которые выбирают поля, присутствующие в результате. Исключённые поля не могут быть включены в анализ.

Свойства _source

excludes: (массив) Массив строк, определяющих поля, исключённые из результата.
includes: (массив) Массив строк, определяющих поля, включённые в результат.

Коды ответов

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

Примеры

В следующем примере получает конфигурацию для задачи анализа фреймов данных loganalytics:

GET _ml/data_frame/analytics/loganalytics

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

{
  "count": 1,
  "data_frame_analytics": [
    {
      "id": "loganalytics",
      "source": {
        "index": "logdata",
        "query": {
          "match_all": {}
        }
      },
      "dest": {
        "index": "logdata_out",
        "results_field": "ml"
      },
      "analysis": {
        "outlier_detection": {}
      },
      "model_memory_limit": "1gb",
      "create_time": 1562265491319,
      "version": "8.0.0"
    }
  ]
}

© 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/get-dfanalytics.html