› › ›

API получения конфигурации конвейера

Возвращает информацию об одном или нескольких конвейерах ingest. Данный API возвращает локальную ссылку на конвейер.

resp = client.ingest.get_pipeline(
    id="my-pipeline-id",
)
print(resp)

response = client.ingest.get_pipeline(
  id: 'my-pipeline-id'
)
puts response

const response = await client.ingest.getPipeline({
  id: "my-pipeline-id",
});
console.log(response);

GET /_ingest/pipeline/my-pipeline-id

Запрос

GET /_ingest/pipeline/<pipeline>

GET /_ingest/pipeline

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

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

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

<pipeline>

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

Для получения всех конвейеров ingest, опустите этот параметр или используйте *.

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

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

Примеры

Получение информации о конкретном конвейере ingest

resp = client.ingest.get_pipeline(
    id="my-pipeline-id",
)
print(resp)

response = client.ingest.get_pipeline(
  id: 'my-pipeline-id'
)
puts response

const response = await client.ingest.getPipeline({
  id: "my-pipeline-id",
});
console.log(response);

GET /_ingest/pipeline/my-pipeline-id

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

{
  "my-pipeline-id" : {
    "description" : "describe pipeline",
    "version" : 123,
    "processors" : [
      {
        "set" : {
          "field" : "foo",
          "value" : "bar"
        }
      }
    ]
  }
}

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