› › ›

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 при отсутствии совпадений или только частичных совпадениях.

exclude_generated

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

from

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

size

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

Тело ответа

data_frame_analytics

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

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

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

analyzed_fields

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

Свойства analyzed_fields

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

authorization

(объект) Права доступа, которые использует задача для выполнения запросов. Если функции безопасности Elastic Stack были отключены во время последнего обновления задачи, это свойство опущено.

Свойства authorization

api_key

(объект) Если для последнего обновления задачи использовался API-ключ, его имя и идентификатор указаны в ответе.

Свойства api_key

id: (строка) Идентификатор API-ключа.
name: (строка) Название API-ключа.

roles

(массив строк) Если для последнего обновления задачи использовался идентификатор пользователя, его роли на момент обновления указаны в ответе.

service_account

(строка) Если для последнего обновления задачи использовалась учетная запись сервиса, имя учетной записи указано в ответе.

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:

resp = client.ml.get_data_frame_analytics(
    id="loganalytics",
)
print(resp)

response = client.ml.get_data_frame_analytics(
  id: 'loganalytics'
)
puts response

const response = await client.ml.getDataFrameAnalytics({
  id: "loganalytics",
});
console.log(response);

GET _ml/data_frame/analytics/loganalytics

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

{
  "count" : 1,
  "data_frame_analytics" : [
    {
      "id" : "loganalytics",
      "create_time" : 1656364565517,
      "version" : "8.4.0",
      "authorization" : {
        "roles" : [
          "superuser"
        ]
      },
      "description" : "Outlier detection on log data",
      "source" : {
        "index" : [
          "logdata"
        ],
        "query" : {
          "match_all" : { }
        }
      },
      "dest" : {
        "index" : "logdata_out",
        "results_field" : "ml"
      },
      "analysis" : {
        "outlier_detection" : {
          "compute_feature_influence" : true,
          "outlier_fraction" : 0.05,
          "standardization_enabled" : true
        }
      },
      "model_memory_limit" : "1gb",
      "allow_lazy_start" : false,
      "max_num_threads" : 1
    }
  ]
}

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