Stops the process of a Cloud Assistant command that is running on one or more instances.

Description

  • If you stop the process of a command that runs only once, the executions that have started are not interrupted. The executions that have not started are canceled.
  • If you stop the process of a command that runs on a recurring schedule, the executions that have started are not interrupted but subsequent executions are cancelled.

Debugging

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 parameters

Parameter Type Required Example Description
Action String Yes StopInvocation

The operation that you want to perform. Set the value to StopInvocation.

RegionId String Yes cn-hangzhou

The region ID of the Cloud Assistant command. You can call the DescribeRegions operation to query the most recent region list.

InvokeId String Yes t-7d2a745b412b4601b2d47f6a768d****

The ID of the execution. You can call the DescribeInvocations operation to query all execution IDs.

InstanceId.N String No i-bp67acfmxazb4p****

The ID of instance N on which to stop the process of the Cloud Assistant command. You can specify up to 50 instance IDs in each request. Valid values of N: 1 to 50.

Response parameters

Parameter Type Example Description
RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

The ID of the request.

Examples

Sample requests

https://ecs.aliyuncs.com/?Action=StopInvocation
&InvokeId=t-7d2a745b412b4601b2d47f6a768d****
&RegionId=cn-hangzhou
&InstanceId.1=bp67acfmxazb4p****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<StopInvocationResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</StopInvocationResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code Error code Error message Description
400 RegionId.ApiNotSupported The api is not supported in this region. The error message returned because the API operation cannot be called in the specified region. Check whether the RegionId parameter is valid.
403 InstanceIds.ExceedLimit The number of instance IDs exceeds the upper limit. The error message returned because the number of specified instance IDs exceeds the upper limit.
403 Operation.Forbidden The operation is not permitted. The error message returned because the operation is not supported.
404 InvalidInvokeId.NotFound The specified invoke ID does not exist. The error message returned because the specified InvokeId parameter does not exist.
500 InternalError.Dispatch An error occurred when you dispatched the request. The error message returned because an error occurred when the request was being sent. Try again later.

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