全部產品
Search
文件中心

Elasticsearch:StopPipelines

更新時間:Jan 16, 2025

調用StopPipelines,停止運行Logstash管道。

調試

您可以在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****

用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字元。

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

管道ID列表。

RequestBody

RequestBody中還需填入管道ID列表,用來指定待停止的管道,樣本:["PipelineId1","PipelineId2","..."]

返回資料

名稱 類型 樣本值 描述
Result Boolean 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****"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。