すべてのプロダクト
Search

このプロダクト

    Elasticsearch:パイプラインの作成

    ドキュメントセンター

    Elasticsearch:パイプラインの作成

    最終更新日:Mar 17, 2025

    Logstash クラスターにパイプラインを作成します。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer は、さまざまな SDK の操作のサンプルコードを動的に生成します。

    リクエストヘッダー

    この操作には操作固有のリクエストヘッダーはなく、共通のリクエストヘッダーのみを使用します。 詳細については、「共通パラメーター」トピックの「共通リクエストヘッダー」セクションをご参照ください。

    リクエスト構文

    POST /openapi/logstashes/{InstanceId}/pipelines HTTP/1.1

    リクエストパラメーター

    パラメーター タイプ 場所 必須 例 説明
    InstanceId String Path はい ls-cn-oew1qbgl****

    Logstash クラスターの ID。
    trigger ブール値 Query いいえ false

    設定を保存してパイプラインをデプロイするかどうかを指定します。有効な値：

    • true: 設定を保存してパイプラインをデプロイします。
    • false (デフォルト): 設定のみを保存します。
    ClientToken String Query いいえ 5A2CFF0E-5718-45B5-9D4D-70B3FF****

    リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。 トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
    Array Body いいえ

    パイプラインに関する情報を指定するために使用されるリクエスト本文パラメーター。 詳細については、logstash.yml をご参照ください。
    pipelineId String Body はい pipeline-test

    パイプラインの ID。
    description String Body いいえ this is a test

    パイプラインの説明。
    config String Body はい input { } filter { } output { }

    パイプラインの構成。
    workers Integer Body いいえ 2

    パイプラインのワーカースレッド数。 このパラメーターのデフォルト値は vCPU の数です。
    batchSize Integer Body いいえ 125

    パイプラインのバッチサイズ。 デフォルト値：125。
    batchDelay Integer Body いいえ 50

    パイプラインのバッチ遅延。 デフォルト値：50。単位：ミリ秒。
    queueType String Body いいえ MEMORY

    キューのタイプ。有効な値：

    • MEMORY: 従来のメモリベースのキュー。
    • PERSISTED: ディスクベースの ACKed キュー。永続キューです。
    queueMaxBytes Integer Body いいえ 1024

    キューの合計容量。 デフォルト値：1024。単位：MB。
    queueCheckPointWrites Integer Body いいえ 1024

    キューチェックポイントの書き込み回数。 デフォルト値：1024。

    レスポンスパラメーター

    パラメーター タイプ 例 説明
    Result ブール値 true

    パイプラインが作成されたかどうかを示します。有効な値：

    • true
    • false
    RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

    リクエスト ID。

    例

    リクエストの例

    POST /openapi/logstashes/ls-cn-oew1qbgl****/pipelines?trigger=false&ClientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

[ {
  "pipelineId" : "pipeline-test",
  "description" : "this is a test",
  "config" : "input { } filter { } output { }",
  "workers" : 2,
  "batchSize" : 125,
  "batchDelay" : 50,
  "queueType" : "MEMORY",
  "queueMaxBytes" : 1024,
  "queueCheckPointWrites" : 1024
} ]

    成功レスポンスの例

    JSON 形式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "732A60FB-1899-4466-83D2-E96DA455****"
}

    エラーコード

    エラーコードのリストについては、「サービスエラーコード」をご参照ください。