› › ›

API cat transforms

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

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

Запрос

GET /_cat/transforms/<transform_id>

GET /_cat/transforms/_all

GET /_cat/transforms/*

GET /_cat/transforms

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

Если включены функции безопасности Elasticsearch, у вас должны быть monitor_transform права кластера для использования этого API. Встроенная роль transform_user обладает этими правами. Дополнительную информацию см. в Правах безопасности и Встроенных ролях.

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

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

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

allow_no_match

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

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

Значение по умолчанию — true, которое возвращает пустой массив transforms, если нет совпадений, и подмножество результатов при частичных совпадениях.

Если этот параметр равен false, запрос возвращает код состояния 404, если нет совпадений или только частичные совпадения.

format

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

from

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

h

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

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

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

changes_last_detection_time, cldt: (По умолчанию) Отметка времени последнего обнаруженного изменения в исходных индексах.
checkpoint, cp: (По умолчанию) Номер последовательности контрольной точки.
checkpoint_duration_time_exp_avg, cdtea, checkpointTimeExpAvg: Экспоненциальное скользящее среднее значение продолжительности контрольной точки в миллисекундах.
checkpoint_progress, c, checkpointProgress: (По умолчанию) Прогресс следующей контрольной точки, которая в настоящее время выполняется.
create_time, ct, createTime: Время создания преобразования.
delete_time, dtime: Время, затраченное на удаление, в миллисекундах.
description, d: Описание преобразования.
dest_index, di, destIndex: Индекс назначения для преобразования.

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

В случае преобразования latest сопоставления никогда не выводятся. Если динамические сопоставления для целевого индекса нежелательны, используйте API создания индекса до начала преобразования.

documents_deleted, docd

Количество документов, удаленных из целевого индекса из-за политики удержания для этого преобразования.

documents_indexed, doci

Количество документов, проиндексированных в целевой индекс для преобразования.

docs_per_second, dps

Устанавливает ограничение на количество входных документов в секунду. Эта настройка ограничивает преобразование, добавляя время ожидания между запросами поиска. Значение по умолчанию — null, что отключает ограничение.

documents_processed, docp

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

frequency, f

Интервал между проверками изменений в исходных индексах, когда преобразование выполняется непрерывно. Также определяет интервал повторной попытки в случае временных сбоев во время поиска или индексирования. Минимальное значение — 1s, максимальное — 1h. Значение по умолчанию — 1m.

id

(По умолчанию) Идентификатор преобразования.

index_failure, if

Количество сбоев индексирования.

index_time, itime

Время, затраченное на индексирование, в миллисекундах.

index_total, it

Количество операций индексирования.

indexed_documents_exp_avg, idea

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

last_search_time, lst, lastSearchTime

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

max_page_search_size, mpsz

Определяет начальный размер страницы для составного агрегирования для каждой контрольной точки. При возникновении исключений разрыва цепи размер страницы динамически корректируется до меньшего значения. Минимальное значение — 10, максимальное — 65,536. Значение по умолчанию — 500.

pages_processed, pp

Количество обработанных операций поиска или массового индексирования. Документы обрабатываются партиями, а не по одному.

pipeline, p

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

processed_documents_exp_avg, pdea

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

processing_time, pt

Время, затраченное на обработку результатов, в миллисекундах.

reason, r

Если преобразование имеет состояние failed, эта свойство предоставляет подробности о причине ошибки.

search_failure, sf

Количество сбоев поиска.

search_time, stime

Время, затраченное на поиск, в миллисекундах.

search_total, st

Количество операций поиска в исходном индексе для преобразования.

source_index, si, sourceIndex

(По умолчанию) Исходные индексы для преобразования. Это может быть один индекс, шаблон индекса (например, "my-index-*"), массив индексов (например, ["my-index-000001", "my-index-000002"]) или массив шаблонов индексов (например, ["my-index-*", "my-other-index-*"]. Для удаленных индексов используйте синтаксис "remote_name:index_name".

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

state, s

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

aborting: Преобразование отменяется.
failed: Преобразование завершилось ошибкой. Для получения дополнительной информации об ошибке проверьте поле reason.
indexing: Преобразование активно обрабатывает данные и создает новые документы.
started: Преобразование выполняется, но не активно индексирует данные.
stopped: Преобразование остановлено.
stopping: Преобразование останавливается.

transform_type, tt

Указывает тип преобразования: batch или continuous.

trigger_count, tc

Количество раз, когда преобразование было запущено планировщиком. Например, планировщик запускает индексатор преобразования для проверки обновлений или обработки новых данных через интервал, указанный в свойстве frequency.

version, v

Версия Elasticsearch, существовавшая на узле при создании преобразования.

help: (Необязательно, булево) Если true, ответ включает справочную информацию. По умолчанию — false.
s: (Необязательно, строка) Список столбцов или псевдонимов столбцов, разделенных запятыми, используемых для сортировки ответа.
size: (Необязательно, целое число) Указывает максимальное количество преобразований для получения. Значение по умолчанию — 100.
time: (Необязательно, единицы измерения времени) Единица измерения времени, используемая для отображения значений времени.
v: (Необязательно, булево) Если true, ответ включает заголовки столбцов. По умолчанию — false.

Примеры

GET /_cat/transforms?v=true&format=json

[
  {
    "id" : "ecommerce_transform",
    "state" : "started",
    "checkpoint" : "1",
    "documents_processed" : "705",
    "checkpoint_progress" : "100.00",
    "changes_last_detection_time" : null
  }
]

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