› › ›

API cat datafeeds

API cat предназначены только для использования человеком с помощью командной строки или консоли Kibana. Они не предназначены для использования приложениями. Для использования приложениями используйте API для получения статистики по подаче данных.

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

Запрос

GET /_cat/ml/datafeeds/<feed_id>

GET /_cat/ml/datafeeds

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

Если включены функции безопасности Elasticsearch, у вас должны быть monitor_ml, monitor, manage_ml или manage права доступа к кластеру для использования этого API. См. Права доступа к безопасности и Права доступа к безопасности в машинном обучении.

Описание

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

Этот API возвращает не более 10 000 заданий.

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

<feed_id>: (Необязательный, строка) Числовая строка, которая однозначно идентифицирует подачу данных. Этот идентификатор может содержать строчные буквенно-цифровые символы (a-z и 0-9), дефисы и нижние подчеркивания. Он должен начинаться и заканчиваться буквенно-цифровыми символами.

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

allow_no_match

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

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

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

format

(Необязательный, строка) Короткая версия заголовка HTTP Accept. Допустимые значения включают JSON, YAML и т. д.

h

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

Если вы не указываете, какие столбцы включать, API возвращает столбцы по умолчанию. Если вы явно указываете один или несколько столбцов, он возвращает только указанные столбцы.

Допустимые столбцы:

assignment_explanation, ae

Только для запущенных подач данных, содержит сообщения, относящиеся к выбору узла.

buckets.count, bc, bucketsCount

(По умолчанию) Количество обработанных бакетов.

id

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

node.address, na, nodeAddress

Сетевой адрес узла.

node.ephemeral_id, ne, nodeEphemeralId

Временный идентификатор узла.

node.id, ni, nodeId

Уникальный идентификатор узла.

node.name, nn, nodeName

Имя узла.

search.bucket_avg, sba, searchBucketAvg

Среднее время поиска за бакет в миллисекундах.

search.count, sc, searchCount

(По умолчанию) Количество поисков, выполненных подачей данных.

search.exp_avg_hour, seah, searchExpAvgHour

Экспоненциальное среднее время поиска в час в миллисекундах.

search.time, st, searchTime

Общее время поиска подачей данных в миллисекундах.

state, s

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

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

help

(Необязательный, логический) Если true, ответ включает справочную информацию. По умолчанию false.

s

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

time

(Необязательный, единицы измерения времени) Единица измерения времени.

v

(Необязательный, логический) Если true, в ответ включаются заголовки столбцов. По умолчанию false.

Примеры

resp = client.cat.ml_datafeeds(
    v=True,
)
print(resp)

response = client.cat.ml_datafeeds(
  v: true
)
puts response

const response = await client.cat.mlDatafeeds({
  v: "true",
});
console.log(response);

GET _cat/ml/datafeeds?v=true

id                              state buckets.count search.count
datafeed-high_sum_total_sales stopped 743          7
datafeed-low_request_rate     stopped 1457         3
datafeed-response_code_rates  stopped 1460         18
datafeed-url_scanning         stopped 1460         18

© 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/cat-datafeeds.html