UpdatePipelines - Elasticsearch - Alibaba Cloud ドキュメントセンター

Logstash クラスターのパイプラインを更新します。

デバッグ

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

リクエストヘッダー

この操作では、共通のリクエストヘッダーのみを使用します。詳細については、「共通リクエストヘッダー」をご参照ください。

リクエスト構文

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

リクエストパラメーター

パラメーター	タイプ	位置	必須	例	説明
InstanceId	String	Path	はい	ls-cn-oew1qbgl****	Logstash クラスターの ID。
trigger	Boolean	Query	なし	false	アプリケーションの作成後すぐにデプロイするかどうかを指定します。
clientToken	String	Query	なし	5A2CFF0E-5718-45B5-9D4D-70B3FF****	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。
	String	Body	なし	[ { "pipelineId": "test", "config": "input {\n\n}\nfilter {\n\n}\noutput {\n \n}" } ]	更新されたパイプライン情報を指定します。

RequestBody

更新されたパイプライン情報を指定するには、RequestBody パラメーターに JSON 形式のパイプライン配列も入力する必要があります。

パラメーター	タイプ	必須	例	説明
pipelineId	String	はい	pipeline-test	更新するパイプラインの ID。
description	String	なし	this is a test	パイプラインの説明。
config	String	はい	input { } filter { } output { }	パイプラインの構成。
workers	Integer	いいえ	2	パイプラインのワーカースレッド数。
batchSize	Integer	いいえ	125	パイプラインのバッチサイズ。
batchDelay	Integer	いいえ	50	パイプラインのバッチ遅延。単位：ミリ秒。
queueType	String	なし	MEMORY	キューのタイプ。 MEMORY と PERSISTED がサポートされています。
pipelineStatus	String	なし	RUNNING	パイプラインのステータス。 trigger パラメーターが true に設定されている場合、このパラメーターは必須です。有効な値：NOT_DEPLOYED、RUNNING、DELETED。
queueMaxBytes	Integer	いいえ	1024	キューの最大バイト数。
queueCheckPointWrites	Integer	いいえ	1024	キューチェックポイントの書き込み回数。

サンプルステートメント：


[
    {
        "pipelineId": "test",
        "config": "input {\n\n}\nfilter {\n\n}\noutput {\n \n}"
    }
]

レスポンスパラメーター

パラメーター

タイプ

例

説明

Result

Boolean

true

返された結果：

true：更新は成功しました。
false：更新は失敗しました。

RequestId

String

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

リクエスト ID。

例

サンプルリクエスト

PUT /openapi/logstashes/ls-cn-oew1qbgl****/pipelines?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF****&trigger=false HTTP/1.1
共通リクエストパラメーター
[
{"pipelineId":"test", "config":"input {\n\n}\nfilter {\n\n}\noutput {\n \n}"},

{"pipelineId":"test1", "config":"input {\n\n}\nfilter {\n\n}\noutput {\n  \n}"}
]

サンプルの成功レスポンス

JSON 形式

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

{
  "Result" : true,
  "RequestId" : "734F9DEC-74AC-4D6E-B97F-FFDAA90B****"
}

HTTP ステータスコード

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