Suspends a change task of a Logstash cluster. After an instance is interrupted, the instance enters the suspended state.
Debugging
Request headers
/openapi/logstashes/{instanceId}/actions/interrupt
Request syntax
POST /openapi/logstashes/{InstanceId}/actions/interrupt HTTP/1.1
Request parameters
Parameter | Type | Position | Required | Example | Description |
---|---|---|---|---|---|
InstanceId | String | Path | Yes | ls-cn-4591f1y6**** | The ID of the instance. |
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. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
Code | String | InstanceNotFound | The error code returned. If the API operation is successfully called, this parameter is not returned. |
Message | String | The error message returned because the current instance does not exist. Check whether the instance Id is correct. | The error message returned. If the API operation is successfully called, this parameter is not returned. |
RequestId | String | 0FA05123-745C-42FD-A69B-AFF48EF9**** | The request ID. |
Result | Boolean | true | Indicates whether the task is suspended. Valid values:
|
Examples
Sample requests
POST /openapi/logstashes/ls-cn-4591f1y6****/actions/interrupt HTTP/1.1
Common request header
Sample success response
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Result" : true,
"RequestId" : "0FA05123-745C-42FD-A69B-AFF48EF9****"
}
Error codes
HttpCode | Error code | Error message | Remarks |
---|---|---|---|
400 | InstanceActivating | Instance is activating. | The instance is currently in effect. |
400 | InstanceNotFound | The instanceId provided does not exist. | The error message returned because the instance cannot be found. Check the instance status. |
For a list of error codes, see Service error codes.