Stops one or more cloud desktops that are running.

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

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes StopDesktops

The operation that you want to perform. Set the value to StopDesktops.

ClientId String Yes f4a0dc8e-1702-4728-9a60-95b27a35****

The ID of the client.

DesktopId.N RepeatList Yes ecd-7w78ozhjcwa3u****

The ID of cloud desktop N. You can specify one or more IDs of cloud desktops. Valid values of N: 1 to 20.

LoginToken String Yes v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****

The logon credential.

RegionId String Yes cn-hangzhou

The ID of the region.

SessionId String Yes cd45e873-650d-4d70-acb9-f996187a****

The ID of the session.

ClientOS String No Windows_NT 10.0.18363 x64

The OS used by the client.

ClientVersion String No 2.1.0-R-20210731.151756

The version of the client.

Response parameters

Parameter Type Example Description
RequestId String 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=StopDesktops
&ClientId=f4a0dc8e-1702-4728-9a60-95b27a35****
&DesktopId.1=ecd-7w78ozhjcwa3u****    
&LoginToken=v18101ac6a9e69c66b04a163031680463660b4b216cd758f34b60b9ad6a7c7f7334b83dd8f75eef4209c68f9f1080b****
&RegionId=cn-hangzhou
&SessionId=cd45e873-650d-4d70-acb9-f996187a****
&<Common request parameters>|

Sample success responses

XML format

<StopDesktopsResponse>
      <RequestId>1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53</RequestId>
</StopDesktopsResponse>

JSON format

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