You can call this operation to stop one or more cloud desktops that are running. After the operation is called, the cloud desktops enter the Stopped state.

Description

The cloud desktop to be stopped must be in the Running (Running) state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically 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.

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

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

RegionId String Yes cn-hangzhou

The ID of the region.

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
&DesktopId.1=ecd-7w78ozhjcwa3u****
&<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"
}

Error codes

For a list of error codes, visit the API Error Center.