Stops pipelines in a Logstash cluster.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

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

Request parameters

Parameter Type Position Required Example Description
InstanceId String Path Yes ls-cn-oew1qbgl****

The ID of the Logstash cluster.

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

The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length.

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

The list of pipeline IDs.


You must specify the IDs of the pipelines in the request body. Example: ["PipelineId1","PipelineId2","..."].

Response parameters

Parameter Type Example Description
Result Boolean true

The returned result. Valid values:

  • true: The pipelines are stopped.
  • false: The pipelines fail to be stopped.
RequestId String 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1****

The request ID.


Sample requests

POST /openapi/logstashes/ls-cn-oew1qbgl****/pipelines/action/stop HTTP/1.1
Common request headers

Sample success responses

JSON format

HTTP/1.1 200 OK

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

Error codes

For a list of error codes, see Service error codes.