StopInstance - ENS - Alibaba Cloud Documentation Center

Stops an instance.

Operation description

You can call this operation to stop instances that are only in the Running state.
If the call is successful, the state of the instance becomes Stopping.
Once the instance is stopped, the state of the instance becomes Stopped.
Force stop is supported, which is equivalent to power-off. Data that is not written to disks on the instance may be lost.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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
ens:StopInstance	update	Instance `acs:ens::{#accountId}:instance/{#InstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance that you want to stop. You can specify only one instance ID.	i-instanceid****
ForceStop	string	No	Specifies whether to forcibly stop the servers. true: forcibly stops the instance. false: normally stops the servers. This is the default value.	true

Response parameters

Parameter	Type	Description	Example
	object
Code	integer	The returned service code. 0 indicates that the request was successful.	0
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter	The input parameters that is mandatory for processing this request is not supplied.	-
400	InstanceIdNotFound	The input parameter instancdId that is not found.	The specified instance ID does not exist.
400	NoPermission	Permission denied.	-
400	CallInterface	Call Interface Happen Error.	An error occurred when you call the operation.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-12-21	The Error code has changed. The request parameters of the API has changed	View Change Details