StopDesktops - - Alibaba Cloud Documentation Center

Stops cloud computers.

Operation description

The cloud computers that you want to stop must be in the Running state. After you call this operation, the cloud computers enter the Stopped 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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the regions supported by WUYING Workspace.	cn-hangzhou
ClientId	string	Yes	The client ID. The system generates a unique ID for each client.	f4a0dc8e-1702-4728-9a60-95b27a35****
SessionId	string	Yes	The session ID.	cd45e873-650d-4d70-acb9-f996187a****
LoginToken	string	Yes	The logon token.	v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
ClientOS	string	No	The operating system (OS) of the device that runs the Alibaba Cloud Workspace client (hereinafter referred to as WUYING client).	Windows_NT 10.0.18363 x64
ClientVersion	string	No	The client version. If you use a WUYING client, you can view the client version in the About dialog box on the client logon page.	2.1.0-R-20210731.151756
DesktopId	array	Yes	The IDs of the cloud computers. You can specify the IDs of 1 to 20 cloud computers.
	string	Yes	The ID of the cloud computer.	ecd-7w78ozhjcwa3u****
ClientToken	string	Yes	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How do I ensure the idempotence of a request?	6ce412a8-399f-49f9-9518-66ee028a****
SessionToken	string	No	The logon token.	04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
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
2023-05-18	The request parameters of the API has changed	View Change Details