All Products
Search
Document Center

WUYING Workspace:StopDesktops

Last Updated:Sep 13, 2023

Stops cloud desktops.

Operation Description

The cloud desktops that you want to stop by calling this operation must be in the Running state. If the call is successful, the cloud desktops 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.

debugging

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
ClientIdstringYes

The client ID. The system generates a unique ID for each client.

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

The session ID.

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

The logon token.

v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
ClientOSstringNo

The client OS.

Windows_NT 10.0.18363 x64
ClientVersionstringNo

The client version.

2.1.0-R-20210731.151756
DesktopIdarrayYes

The cloud desktop IDs. You can specify 1 to 20 IDs.

stringYes

The cloud desktop ID.

ecd-7w78ozhjcwa3u****
ClientTokenstringYes

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****
SessionTokenstringNo

The logon token.

04b7b80a0b020715c5c1b4175fc4771698****9e2a759557a4624665fd53ae40

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

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 timeSummary of changesOperation
2023-05-18The input parameters of the API operation change.see changesets
Change itemChange content
Input ParametersThe input parameters of the API operation change.
    Added Input Parameters: SessionToken