Call the InterruptLogstashTask to interrupt the instance change task. After interrupted, it enters the suspended state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request header

/openapi/logstashes/{instanceId}/actions/interrupt

Request structure

POST /openapi/logstashes/[InstanceId]/actions/interrupt HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
InstanceId String Yes ls-cn-4591f1y6****

The ID of the instance.

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

A unique token generated by the client to guarantee the idempotency of the request. The value of this parameter is generated by the client and is unique among different requests. The maximum length is 64 ASCII characters.

Response parameters

Parameter Type Example Description
Code String .

The error code. This parameter is not returned if you call the operation normally.

Message String .

The error message. This parameter is not returned if you call the operation normally.

RequestId String 0FA05123-745C-42FD-A69B-AFF48EF9****

The ID of the request.

Result Boolean true

Returned results:

  • true: The task is interrupted.
  • false: The task has failed to be interrupted.

Examples

Sample requests

POST /openapi/logstashes/ls-cn-4591f1y6 ****/actions/interrupt HTTP/1.1 
common request header

Sample success responses

JSON Syntax

{
    "Result": true,
    "RequestId": "0FA05123-745C-42FD-A69B-AFF48EF9****"
}

Error codes

HttpCode Error code Error message Description
400 InstanceNotFound The instanceId provided does not exist. The error message returned because the instance cannot be found. Check the status of the instance.

For a list of error codes, visit the API Error Center.