Stops an Elastic Compute Service (ECS) instance in the Running state. After you call this operation, the state of the instance changes to Stopping and then to Stopped.
Operation description
This operation is an asynchronous operation. After you call this operation to stop an ECS instance, the operation sets the status of the ECS instance to Stopping and begins the stop process. You can call the DescribeInstanceStatus operation to query the status of the ECS instance. When the status of the ECS instance changes to Stopped
, the instance is stopped.
Precautions
- You cannot call this operation to stop an ECS instance that is locked for security reasons. For more information, see API behavior when an instance is locked for security reasons.
- After you enable the default economical mode for all pay-as-you-go ECS instances located in virtual private clouds (VPCs) in your account, you can set
StoppedMode
to KeepCharging for the ECS instance that you want to stop to enable standard mode. This way, the ECS instance continues to be billed after the instance is stopped. The instance type resources and public IP address of the instance are retained.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
ecs:StopInstance | update | *Instance acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
InstanceId | string | Yes | The ID of the instance. | i-bp67acfmxazb4ph**** |
ConfirmStop | boolean | No | This parameter will be removed in the future and is retained only to ensure compatibility. We recommend that you ignore this parameter. | true |
ForceStop | boolean | No | Specifies whether to forcefully stop the ECS instance. Valid values:
Default value: false. | false |
StoppedMode | string | No | The stop mode of the pay-as-you-go instance. Valid values:
Default value: If the conditions for enabling the economical mode are met and you have enabled this mode in the ECS console, the default value is StopCharging . For more information, see the "Enable economical mode" section in | KeepCharging |
DryRun | boolean | No | Specifies whether to perform only a dry run, without performing the actual request. Valid values:
Default value: false. | true |
Hibernate | boolean | No | Note
This parameter is in invitational preview and is not publicly available.
| hide |
Response parameters
Examples
Sample success responses
JSON
format
{
"RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
403 | IncorrectInstanceStatus | The current status of the resource does not support this operation. | The resource is in a state that does not support the current operation. |
403 | InstanceLockedForSecurity | The specified operation is denied as your instance is locked for security reasons. | - |
403 | DiskError | IncorrectDiskStatus | The specified disk status is invalid. |
403 | InstanceType.ParameterMismatch | The input parameter ConfirmStop must be true when an instance have localstorage. | The ConfirmStop parameter is not set to true for the instance that uses local storage. |
403 | InstanceExpiredOrInArrears | The specified operation is denied as your prepay instance is expired (prepay mode) or in arrears (afterpay mode). | The subscription instance has expired. You must renew the instance before you can proceed. |
403 | InvalidInstanceId.NotSupport | Classic network Instance does not support this operation. | Instances that reside in the classic network do not support the operation. |
403 | InvalidInstanceId.NotSupport | Pre pay instance does not support this operation. | Subscription instances do not support the operation. |
403 | InvalidInstanceId.NotSupport | Local disk instance does not support this operation. | The operation is not supported while the instance has local disks attached. |
403 | InvalidInstanceId.NotSupport | Spot instance does not support this operation. | Preemptible instances do not support the operation. |
403 | IncorrectInstanceStatus | %s | The instance is in a state that does not support the current operation. |
403 | InvalidParameter.KMSKeyId.CMKUnauthorized | The CMK needs to be added ECS tag | - |
403 | InvalidParameter.KMSKeyId.CMKNotEnabled | The CMK needs to be enabled. | The customer master key (CMK) is not enabled when KMSKeyId is specified for an encrypted disk. You can call the DescribeKey operation of KMS to query information about the specified CMK. |
403 | InvalidParameter.KMSKeyId.KMSUnauthorized | ECS service have no right to access your KMS. | ECS is not authorized to access your KMS resources. |
403 | HibernationConfigured.InstanceOperationForbidden | The operation is not permitted due to limit of the hibernation configured instance. | The operation cannot be performed due to the limitations of instances for which the instance hibernation feature is enabled. |
403 | HibernationConfigured.NotEnabled | The instance hibernation configured option is not enabled. | - |
404 | InvalidInstanceId.NotFound | The specified InstanceId does not exist. | The specified instance does not exist. |
500 | InternalError | The request processing has failed due to some unknown error. | An internal error has occurred. Try again later. |
500 | InternalError | The request processing has failed due to some unknown error, exception or failure. | An internal error has occurred. Try again later. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2024-12-20 | The Error code has changed | View Change Details |
2023-07-17 | The Error code has changed | View Change Details |
2021-05-25 | The Error code has changed | View Change Details |