› › ›

API cat transforms

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

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

Запрос

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

Устанавливает ограничение на количество входных документов в секунду. Это ограничение устанавливает время ожидания между запросами поиска.

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.

Примеры

resp = client.cat.transforms(
    v=True,
    format="json",
)
print(resp)

response = client.cat.transforms(
  v: true,
  format: 'json'
)
puts response

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

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/8.17/cat-transforms.html