› › ›

API cat datafeeds

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

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

Запрос

GET /_cat/ml/datafeeds/<feed_id>

GET /_cat/ml/datafeeds

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

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

Описание

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

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

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

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

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

allow_no_datafeeds

(Необязательно, логическое значение) [7.10] Устарело в 7.10. Используйте allow_no_match вместо этого.

allow_no_match

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

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

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

format

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

h

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

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

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

assignment_explanation, ae

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

buckets.count, bc, bucketsCount

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

id

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

node.address, na, nodeAddress

Сеть адрес узла.

node.ephemeral_id, ne, nodeEphemeralId

Временный ID узла.

node.id, ni, nodeId

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

node.name, nn, nodeName

Имя узла.

search.bucket_avg, sba, searchBucketAvg

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

search.count, sc, searchCount

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

search.exp_avg_hour, seah, searchExpAvgHour

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

search.time, st, searchTime

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

state, s

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

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

help

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

s

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

time

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

v

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

Примеры

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