All Products
Search
Document Center

Elastic Desktop Service:StopDesktops

Last Updated:Feb 25, 2026

Stops one or more cloud computers.

Operation description

You can stop only cloud computers that are in the Running state. After you call this operation, their state changes to Stopped.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

RegionId

string

Yes

The region ID. Call DescribeRegions to get a list of regions where WUYING Workspace is available.

cn-hangzhou

ClientId

string

Yes

A unique ID that the client generates.

f4a0dc8e-1702-4728-9a60-95b27a35****

SessionId

string

No

The session ID.

cd45e873-650d-4d70-acb9-f996187a****

LoginToken

string

No

The logon credential.

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

ClientOS

string

No

The operating system of the device where the client runs.

Windows_NT 10.0.18363 x64

ClientVersion

string

No

The client version. If you use the WUYING Workspace client, find this value in the About dialog box on the logon screen.

2.1.0-R-20210731.151756

DesktopId

array

Yes

The IDs of the cloud computers. You can specify from 1 to 20 IDs.

ecd-7w78ozhjcwa3u****

string

No

The ID of the cloud computer.

ecd-7w78ozhjcwa3u****

ClientToken

string

No

A client token to ensure idempotence. Generate a unique ASCII string for each request. The string must be no more than 64 characters long. For more information, see How to ensure idempotence.

6ce412a8-399f-49f9-9518-66ee028a****

SessionToken

string

No

The logon credential.

04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40

OsUpdate

boolean

No

Uuid

string

No

Response elements

Element

Type

Description

Example

object

Returns a collection of messages.

RequestId

string

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.