StopInstance-阿里云帮助中心

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

Operation description

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

使用须知

被安全锁定的实例不能通过调用该接口停止。更多信息，请参见资源安全锁定对调用 API 的影响。
开启 VPC 内实例节省停机模式后，您可以通过设置StoppedMode=KeepCharging开启普通停机模式，ECS 实例停止后会继续计费，并为您保留 ECS 实例规格库存和公网 IP 地址。

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: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: true: forcefully stops the ECS instance. If you set ForceStop to true, this operation is equivalent to a power-off operation. Cache data that is not written to storage devices on the instance is lost. false: normally stops the ECS instance. Default value: false.	false
StoppedMode	string	No	The stop mode of the pay-as-you-go instance. 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 does not support the economical mode, the system stops the instance and does not report errors during the operation call. 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. 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
DryRun	boolean	No	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
Hibernate	boolean	No	Note This parameter is in invitational preview and is not publicly available.	hide

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1C488B66-B819-4D14-8711-C4EAAA13AC01

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.Encrypted.KmsNotEnable	Failed to perform this operation because KMS is not activated.	You need to activate KMS key escrow service.
400	DiskError	IncorrectDiskStatus.	The disk state is invalid.
500	InternalError	The request processing has failed due to some unknown error.
403	IncorrectInstanceStatus	The current status of the resource does not support this operation.
403	InstanceLockedForSecurity	The specified operation is denied as your instance is locked for security reasons.
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).
403	InvalidInstanceId.NotSupport	Classic network Instance does not support this operation.	Instances that reside in the classic network do not support the operation.
403	InvalidParameter.KMSKeyId.CMKUnauthorized	The CMK needs to be added ECS tag
403	InvalidParameter.KMSKeyId.CMKNotEnabled	The CMK needs to be enabled.
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.
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	The specified InstanceId does not exist.	The specified instanceId is invalid.
503	LimitedOperation.ServiceUnavailable	The service is currently unavailable. Please try again later.	The service is currently unavailable. Please try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.