› › ›

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 при отсутствии совпадений или только при частичных совпадениях.

from

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

size

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

exclude_generated

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

Тело ответа

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

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

Коды ответа

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

Примеры

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

GET _transform?size=10

Следующий пример получает информацию о конфигурации преобразования ecommerce_transform:

GET _transform/ecommerce_transform

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

{
  "count" : 1,
  "transforms" : [
    {
      "id" : "ecommerce_transform",
      "source" : {
        "index" : [
          "kibana_sample_data_ecommerce"
        ],
        "query" : {
          "term" : {
            "geoip.continent_name" : {
              "value" : "Asia"
            }
          }
        }
      },
      "dest" : {
        "index" : "kibana_sample_data_ecommerce_transform"
      },
      "frequency": "1m",
      "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" : { },
      "version" : "7.5.0",
      "create_time" : 1576094542936
    }
  ]
}

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