すべてのプロダクト
Search
ドキュメントセンター

Elasticsearch:パイプラインの実行

最終更新日:Mar 17, 2025

RunPipelines を呼び出して、Logstash パイプラインをすぐにデプロイします。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。便宜上、OpenAPI Explorer でこの操作を呼び出すことをお勧めします。 OpenAPI Explorer を使用すると、API 操作の検索、API 操作の呼び出し、SDK サンプルコードの動的生成を行うことができます。

リクエストヘッダー

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

リクエスト構文

POST /openapi/logstashes/[InstanceId]/pipelines/action/run HTTPS|HTTP

リクエストパラメーター

パラメータータイプ必須説明
InstanceIdStringはいls-cn-oew1qbgl****

Logstash インスタンスの ID。

ClientTokenStringいいえ5A2CFF0E-5718-45B5-9D4D-70B3FF****

リクエストの冪等性を保証するためにクライアントによって生成された一意のトークン。 このパラメーターの値はクライアントによって生成され、異なるリクエスト間で一意です。 最大長は 64 ASCII 文字です。

リクエスト本文

RequestBody にパイプライン ID リストを入力して、デプロイするパイプラインを指定します。 例:["PipelineId1","PipelineId2","..."]

レスポンスパラメーター

パラメータータイプ説明
RequestIdString5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

リクエストの ID。

Resultブール値true

返された結果:

  • true:デプロイメント成功
  • false:デプロイメント失敗

リクエストの例

POST /openapi/logstashes/ls-cn-oew1qbgl****/pipelines/action/run HTTP/1.1
共通リクエストヘッダー
["PipelineId1","PipelineId2","..."]

成功レスポンスの例

JSON 構文

{
    "Result": true,
    "RequestId": "529AEFD2-F5FA-492F-8921-520141B9****"
}

エラーコード

エラーコードのリストについては、API エラーセンターをご覧ください。