All Products
Search
Document Center

Elastic Compute Service:StopInstance

Last Updated:May 16, 2024

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

  • If you call the DescribeInstances operation to query the details of an instance and OperationLocks in the response contains "LockReason": "security", the instance is locked for security reasons and cannot be stopped. For more information, see API behavior when an instance is locked for security reasons.
  • If the economical mode is enabled, you can set StoppedMode to KeepCharging to switch to the standard mode. This allows an instance that is stopped in standard mode to retain its instance type resources and public IP address. However, you continue to be charged for the instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the instance.

i-bp67acfmxazb4ph****
ConfirmStopbooleanNo

This parameter will be removed in the future and is retained only to ensure compatibility. We recommend that you ignore this parameter.

true
ForceStopbooleanNo

Specifies whether to forcibly stop the instance. Valid values:

  • true
  • false

Default value: false.

false
StoppedModestringNo

The stop mode of the pay-as-you-go instance. Valid values:

  • StopCharging: economical mode. For information about how StopCharging takes effect, see the "Conditions for enabling economical mode" section in Economical mode.
  • KeepCharging: standard mode. You continue to be charged for instances that are stopped in standard mode.

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 Economical mode. Otherwise, the default value is KeepCharging.

KeepCharging
DryRunbooleanNo

Specifies whether to perform only a dry run, without performing the actual request. Valid values:

  • true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, service limits, and available ECS resources. If the request fails the dry run, an error message is returned. If the request passes the dry run, the DryRunOperation error code is returned.
  • false: performs a dry run and performs the actual request.

Default value: false.

true
HibernatebooleanNo
Note This parameter is in invitational preview and is not publicly available.
hide

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

1C488B66-B819-4D14-8711-C4EAAA13AC01

Examples

Sample success responses

JSONformat

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01"
}

Error codes

HTTP status codeError codeError messageDescription
403IncorrectInstanceStatusThe current status of the resource does not support this operation.The resource is in a state that does not support the current operation.
403InstanceLockedForSecurityThe specified operation is denied as your instance is locked for security reasons.-
403DiskErrorIncorrectDiskStatusThe specified disk status is invalid.
403InstanceType.ParameterMismatchThe 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.
403InstanceExpiredOrInArrearsThe 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.
403InvalidInstanceId.NotSupportClassic network Instance does not support this operation.Instances that reside in the classic network do not support the operation.
403InvalidInstanceId.NotSupportPre pay instance does not support this operation.Subscription instances do not support the operation.
403InvalidInstanceId.NotSupportLocal disk instance does not support this operation.The operation is not supported while the instance has local disks attached.
403InvalidInstanceId.NotSupportSpot instance does not support this operation.Preemptible instances do not support the operation.
403IncorrectInstanceStatus%sThe instance is in a state that does not support the current operation.
403InvalidParameter.KMSKeyId.CMKUnauthorizedThe CMK needs to be added ECS tag-
403InvalidParameter.KMSKeyId.CMKNotEnabledThe 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.
403InvalidParameter.KMSKeyId.KMSUnauthorizedECS service have no right to access your KMS.ECS is not authorized to access your KMS resources.
403HibernationConfigured.InstanceOperationForbiddenThe 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.
403HibernationConfigured.NotEnabledThe instance hibernation configured option is not enabled.-
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.The specified instance does not exist.
500InternalErrorThe request processing has failed due to some unknown error.An internal error has occurred. Try again later.
500InternalErrorThe 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 timeSummary of changesOperation
2023-07-17The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 403
    delete Error Codes: 404
    delete Error Codes: 500
2021-05-25The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 403 change
    delete Error Codes: 404
    delete Error Codes: 500