› › ›

API получения трансформеров

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

Запрос

GET _transform/<transform_id>

GET _transform/<transform_id>,<transform_id>

GET _transform/

GET _transform/_all

GET _transform/*

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

Требуется привилегия кластера monitor_transform. Данная привилегия включена в встроенную роль transform_user.

Описание

Вы можете получить информацию о нескольких трансформерах в одном запросе API, используя список идентификаторов, разделённых запятыми, или выражение с подстановкой. Вы можете получить информацию обо всех трансформерах, используя _all, указав * в качестве <transform_id>, или опуская <transform_id>.

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

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

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

allow_no_match

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

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

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

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

exclude_generated

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

from

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

size

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

Тело ответа

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

create_time: (строка) Время создания трансформера. Например, 1576094542936. Это информационное свойство; вы не можете изменить его значение.
version: (строка) Номер версии конфигурации трансформера, в котором был создан обученная модель.

Начиная с Elasticsearch 8.10.0, используется новый номер версии для отслеживания изменений конфигурации и состояния в плагине трансформера. Этот новый номер версии не связан с версией продукта и будет увеличиваться независимо. Значение version представляет новый номер версии.

Коды ответов

404 (Отсутствующие ресурсы): Если allow_no_match равно false, этот код указывает, что нет ресурсов, соответствующих запросу, или есть только частичные совпадения с запросом.

Примеры

Следующий пример извлекает информацию о максимум десяти трансформерах:

resp = client.transform.get_transform(
    size="10",
)
print(resp)

response = client.transform.get_transform(
  size: 10
)
puts response

const response = await client.transform.getTransform({
  size: 10,
});
console.log(response);

GET _transform?size=10

Следующий пример получает конфигурационную информацию для трансформера ecommerce_transform1:

resp = client.transform.get_transform(
    transform_id="ecommerce_transform1",
)
print(resp)

response = client.transform.get_transform(
  transform_id: 'ecommerce_transform1'
)
puts response

const response = await client.transform.getTransform({
  transform_id: "ecommerce_transform1",
});
console.log(response);

GET _transform/ecommerce_transform1

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

{
  "count" : 1,
  "transforms" : [
    {
      "id" : "ecommerce_transform1",
      "authorization" : {
        "roles" : [
          "superuser"
        ]
      },
      "version" : "8.4.0",
      "create_time" : 1656023416565,
      "source" : {
        "index" : [
          "kibana_sample_data_ecommerce"
        ],
        "query" : {
          "term" : {
            "geoip.continent_name" : {
              "value" : "Asia"
            }
          }
        }
      },
      "dest" : {
        "index" : "kibana_sample_data_ecommerce_transform1",
        "pipeline" : "add_timestamp_pipeline"
      },
      "frequency" : "5m",
      "sync" : {
        "time" : {
          "field" : "order_date",
          "delay" : "60s"
        }
      },
      "pivot" : {
        "group_by" : {
          "customer_id" : {
            "terms" : {
              "field" : "customer_id"
            }
          }
        },
        "aggregations" : {
          "max_price" : {
            "max" : {
              "field" : "taxful_total_price"
            }
          }
        }
      },
      "description" : "Maximum priced ecommerce data by customer_id in Asia",
      "settings" : { },
      "retention_policy" : {
        "time" : {
          "field" : "order_date",
          "max_age" : "30d"
        }
      }
    }
  ]
}

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