› › ›

API создания или обновления конвейера обработки данных

Создаёт или обновляет конвейер обработки данных. Изменения, внесённые с помощью этого API, вступают в силу немедленно.

PUT _ingest/pipeline/my-pipeline-id
{
  "description" : "My optional pipeline description",
  "processors" : [
    {
      "set" : {
        "description" : "My optional processor description",
        "field": "my-keyword-field",
        "value": "foo"
      }
    }
  ]
}

Запрос

PUT /_ingest/pipeline/<pipeline>

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

Если в Elasticsearch включены функции безопасности, у вас должны быть manage_pipeline, manage_ingest_pipelines или manage права на управление кластером, чтобы использовать этот API.

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

<pipeline>: (Обязательный, строка) Идентификатор конвейера обработки данных для создания или обновления.

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

if_version: (Необязательный, целое число) Выполнить операцию только в том случае, если у конвейера есть такая версия. Если указано и обновление выполнено успешно, версия конвейера увеличивается.
master_timeout: (Необязательный, единицы измерения времени) Период ожидания подключения к узлу мастера. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.
timeout: (Необязательный, единицы измерения времени) Период ожидания ответа. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.

Тело запроса

description

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

on_failure

(Необязательный, массив объектов обработчика) Обработчики, которые выполняются сразу после сбоя обработки.

Каждый обработчик поддерживает значение на уровне обработчика on_failure. Если обработчик без значения on_failure завершается ошибкой, Elasticsearch использует этот параметр на уровне конвейера в качестве резервного варианта. Обработчики в этом параметре выполняются последовательно в указанном порядке. Elasticsearch не будет пытаться выполнить оставшиеся обработчики конвейера.

processors

(Обязательный, массив объектов обработчика) Обработчики, используемые для выполнения преобразований над документами перед индексированием. Обработчики выполняются последовательно в указанном порядке.

version

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

См. параметр if_version выше, чтобы узнать, как используется атрибут версии.

_meta

(Необязательный, объект) Необязательные метаданные о конвейере обработки данных. Может содержать любые данные. Эта карта не генерируется автоматически Elasticsearch.

Примеры

Метаданные конвейера

Вы можете использовать параметр _meta для добавления произвольных метаданных в конвейер. Этот определяемый пользователем объект хранится в состоянии кластера, поэтому предпочтительно хранить его коротким.

Параметр _meta является необязательным и не генерируется или используется Elasticsearch автоматически.

Чтобы сбросить _meta, замените конвейер без указания его.

PUT /_ingest/pipeline/my-pipeline-id
{
  "description" : "My optional pipeline description",
  "processors" : [
    {
      "set" : {
        "description" : "My optional processor description",
        "field": "my-keyword-field",
        "value": "foo"
      }
    }
  ],
  "_meta": {
    "reason": "set my-keyword-field to foo",
    "serialization": {
      "class": "MyPipeline",
      "id": 10
    }
  }
}

Чтобы проверить _meta, используйте API получения конвейера.

© 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/put-pipeline-api.html