StopInstances-阿里云帮助中心

Stops Elastic Compute Service (ECS) instances. You can specify parameters to determine whether to forcefully stop the instances and the stop mode.

Operation description

该接口为异步接口，实例的停止不是立即完成的，成功调用后，实例会先进入停止中（Stoping）状态，你可以调用 DescribeInstanceStatus 查看实例状态，当返回的状态为Stopped 时代表停止成功。

使用须知

停止实例后实例不可用，请确认停止实例不会对您的业务造成影响。您可以调用 StartInstance 或 StartInstances 接口启动实例。
被安全锁定的实例不能通过调用该接口停止。更多信息，请参见资源安全锁定对调用 API 的影响。

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:StopInstances

update

*Instance

acs:ecs:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DryRun	boolean	No	Specifies whether to send a precheck request. Valid values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and instance status. If the check fails, the corresponding error message is returned. If the request passes the dry run, `DRYRUN.SUCCESS` is returned. Note If you set `BatchOptimization` to `SuccessFirst` and `DryRun` to true, only `DRYRUN.SUCCESS` is returned, regardless of whether the request passes the dry run. false: performs a dry run and performs the actual request. If the request passes the dry run, instances are stopped. Default value: false.	false
RegionId	string	Yes	The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
ForceStop	boolean	No	Specifies whether to forcefully stop instances. Valid values: true: forcefully stops the ECS instance. Alert** Force Stop: forcefully stops the instance. A force stop is equivalent to a physical shutdown and may cause data loss if instance data has not been written to disks. false: normally stops the ECS instance. Default value: false.	false
StoppedMode	string	No	Stop mode. Valid values: StopCharging: economical mode. After an instance is stopped in economical mode: Billing for the following resources of the instance stops: computing resources (vCPUs, memory, and GPUs), image licenses, and public bandwidth of the static public IP address (if any) that uses the pay-by-bandwidth metering method. Billing for the following resources of the instance continues: system disk, data disks, and public bandwidth of the elastic IP address (EIP) (if any) that uses the pay-by-bandwidth metering method. The instance may fail to restart due to the reclaimed computing resources or insufficient resources. Try again later or change the instance type of the instance. If an EIP is associated with the instance before the instance is stopped, the EIP remains unchanged after the instance is restarted. If a static public IP address is associated with the instance before the instance is stopped, the static public IP address may change, but the private IP address does not change. For more information, see Economical mode. Note** If the instance itself does not support the economical shutdown mode, the API side does not intercept errors, and the instance is preferentially stopped. The following types of instances are not supported: classic network instances, local disks, and monthly instances. KeepCharging: standard mode. After the instance is stopped in standard mode, you continue to be charged for the instance. If you want to change the operating system, re-initialize disks, change the instance type, or modify the private IP address, we recommend selecting this mode to avoid startup failures. Default value: If the conditions for enabling the economical mode for an instance in a VPC are met and you have enabled this mode in the ECS console, the default value is `StopCharging`. Otherwise, the default value is `KeepCharging`.	KeepCharging
BatchOptimization	string	No	Specifies the batch operation mode. Valid values: AllTogether: The batch operation is successful only after all operations are successful. If any operation fails, the batch operation is considered failed, and all operations that have been performed are undone to restore the instances to the status before the batch operation. SuccessFirst: allows each operation in a batch to be independently executed. If an operation fails, other operations can continue and confirm success. In this mode, successful operations are committed and failed operations are marked as failed, but the execution results of other operations are not affected. Default value: AllTogether.	AllTogether
InstanceId	array	Yes	The IDs of ECS instances. You can specify 1 to 100 instance IDs.	i-bp67acfmxazb4p****
	string	No	The ID of the ECS instance.	i-bp67acfmxazb4p****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1C488B66-B819-4D14-8711-C4EAAA13AC01
InstanceResponses	object
InstanceResponse	array<object>	The instance-specific responses, which contain the status of each instance before and after the operation was called and the results of the operation.
	object
Code	string	The error code returned for the instance. A return value of 200 indicates that the operation was successful. For more information, see the "Error codes" section of this topic.	200
Message	string	The error message returned for the instance. The return value `success` indicates that the operation is successful. For more information, see the "Error codes" section of this topic.	success
InstanceId	string	The ID of the instance.	i-bp67acfmxazb4p****
CurrentStatus	string	The current status of the instance.	Stopping
PreviousStatus	string	The status of the instance before the operation was called.	Running

Examples

Success response

JSON format

{
  "RequestId": "1C488B66-B819-4D14-8711-C4EAAA13AC01",
  "InstanceResponses": {
    "InstanceResponse": [
      {
        "Code": "200",
        "Message": "success",
        "InstanceId": "i-bp67acfmxazb4p****",
        "CurrentStatus": "Stopping",
        "PreviousStatus": "Running"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be added ECS tag
400	InvalidParameter.KMSKeyId.KMSUnauthorized	ECS service account have no right to access your KMS.
400	DRYRUN.SUCCESS	This request is a dryrun request with successful result.	The request is checked and determined as valid.
400	InvalidParameter.Encrypted.KmsNotEnable	Failed to perform this operation because KMS is not activated.	You need to activate KMS key escrow service.
500	InternalError	The request processing has failed due to some unknown error.
403	InvalidInstanceId.NotFound	InstanceId should not be null.
403	InvalidParameter.TooManyInstanceIds	Instance ids cannot be more than 100.	InstanceIds cannot be more than 100.
403	Abs.InvalidInstanceIds.MalFormed	The specified instanceIds is not valid.
403	InstanceLockedForSecurity	%s
403	InstanceExpiredOrInArrears	%s
403	IncorrectInstanceStatus	%s	The instance is in a state that does not support the current operation.
403	InvalidInstanceId.NotSupport	%s
403	InsufficientBalance	Your account does not have enough balance.
403	InstanceNotReady	The specified instance is not ready for use.
403	InvalidOperation.KMSKeyIdNotFound	The specified KMSKeyId not found, %s.	The associated KMS encryption key cannot be found. Verify that the KMS encryption key is valid.
403	InvalidOperation.KMSServiceNotOpen	KMS service is currently not open.	The KMS service has not been enabled.
403	OperationDenied.SystemInstanceNotSupport	The system instance does not support the %s operation because %s.
404	InvalidInstanceId.NotFound	%s
404	InvalidInstanceIds.NotFound	The specified InstanceIds does not exist.	The specified InstanceId parameter does not exist. You can call the DescribeInstances operation to query the state of the instance.
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.	The service is currently unavailable. Please try again later.
409	InvalidOperation.Conflict	Request was denied due to conflict with a previous request, please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.