調用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 | 返回結果:
|
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****"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。