パイプラインAPIの取得

このAPIは、Logstash Central Managementで使用されるパイプラインを取得します。

リクエスト

GET _logstash/pipeline

GET _logstash/pipeline/<pipeline_id>

前提条件

  • Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmanage_logstash_pipelinesクラスター権限が必要です。

説明

1つ以上のLogstashパイプラインを取得します。

パスパラメータ

  • <pipeline_id>
  • （オプション、文字列）パイプライン識別子のカンマ区切りリスト。

例

次の例は、my_pipelineという名前のパイプラインを取得します:

Python

  1. resp = client.logstash.get_pipeline(
  2.    id="my_pipeline",
  3. )
  4. print(resp)

Ruby

  1. response = client.logstash.get_pipeline(
  2.   id: 'my_pipeline'
  3. )
  4. puts response

Js

  1. const response = await client.logstash.getPipeline({
  2.   id: "my_pipeline",
  3. });
  4. console.log(response);

コンソール

  1. GET _logstash/pipeline/my_pipeline

リクエストが成功した場合、レスポンスのボディにはパイプライン定義が含まれます:

コンソール-結果

  1. {
  2.   "my_pipeline": {
  3.    "description": "Sample pipeline for illustration purposes",
  4.    "last_modified": "2021-01-02T02:50:51.250Z",
  5.    "pipeline_metadata": {
  6.    "type": "logstash_pipeline",
  7.    "version": "1"
  8.    },
  9.    "username": "elastic",
  10.    "pipeline": "input {}\n filter { grok {} }\n output {}",
  11.    "pipeline_settings": {
  12.    "pipeline.workers": 1,
  13.    "pipeline.batch.size": 125,
  14.    "pipeline.batch.delay": 50,
  15.    "queue.type": "memory",
  16.    "queue.max_bytes": "1gb",
  17.    "queue.checkpoint.writes": 1024
  18.    }
  19.   }
  20. }