StopDesktops - Elastic Desktop Service - Alibaba Cloud Documentation Center

Stop cloud computers that are in the Running state. After the operation is successfully called, the cloud computers enter the Stopped state.

Operation description

The cloud computers that you want to stop must be in the Running state.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
ecd:StopDesktops	update	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
StoppedMode	string	No	The billing mode after you stop the cloud computer. Default value: StopCharging. Valid values: StopCharging: After the cloud computer is stopped, the system automatically reclaims computing resources. You are no longer charged for computing resources. However, you are still charged for storage resources. KeepCharging: After the cloud computer is stopped, the system does not reclaim resources to prevent insufficient resources and startup failures. You are still charged for the resources.	StopCharging
DesktopId	array	Yes	The cloud computer IDs. You can specify the IDs of 1 to 100 cloud computers.
	string	Yes	The ID of the cloud computer.	ecd-7w78ozhjcwa3u****
OsUpdate	boolean	No	Whether to perform a patch update when the update is ready. A value of true indicates that a patch update is performed.	false

Response parameters

Parameter	Type	Description	Example
	object	Schema of response.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2025-03-18	The request parameters of the API has changed	View Change Details