パイプラインを取得（Get pipeline）

パイプラインAPIの取得

1つ以上のインジェストパイプラインに関する情報を返します。このAPIは、パイプラインのローカル参照を返します。

Python

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

Ruby

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

Js

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のセキュリティ機能が有効になっている場合、このAPIを使用するには、read_pipeline、manage_pipeline、manage_ingest_pipelines、またはmanage クラスター権限が必要です。

パスパラメータ

• <pipeline>
• （オプション、文字列）取得するパイプラインIDのカンマ区切りリスト。ワイルドカード（*）式がサポートされています。
  すべてのインジェストパイプラインを取得するには、このパラメータを省略するか、*を使用します。

クエリパラメータ

• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。

例

特定のインジェストパイプラインの情報を取得

Python

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

Ruby

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

Js

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"
   }
   }
   ]
  }
}