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

Elasticsearch:StopPipelines

最終更新日:Mar 17, 2025

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

デバッグ

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

リクエストヘッダー

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

リクエスト構文

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

リクエストパラメーター

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

Logstash クラスターの ID。

ClientToken String Query いいえ 5A2CFF0E-5718-45B5-9D4D-70B3FF****

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

String Body いいえ ["PipelineId1","PipelineId2","..."]

パイプライン ID のリスト。

リクエスト本文

リクエスト本文でパイプラインの ID を指定する必要があります。 例: ["PipelineId1","PipelineId2","..."]

レスポンスパラメーター

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

返された結果。有効な値:

  • true: パイプラインが停止しました。
  • false: パイプラインを停止できませんでした。
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

リクエスト ID。

リクエストの例

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

正常なレスポンスの例

JSON 形式

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

{
  "Result" : true,
  "RequestId" : "57092D4B-C92E-4CF9-B73C-B4B376C9****"
}

エラーコード

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