Stops one or more running cloud desktops. After the operation is called, the specified cloud desktops are stopped.

Description

The cloud desktop must be in the 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 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.

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

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

RegionId String Yes cn-hangzhou

The ID of the region.

StoppedMode String No StopCharging

The billing mode after you stop the cloud desktop.

  • StopCharging: Computing resources are not billed after you stop the cloud desktop. After the cloud desktop is stopped, the system automatically reclaims computing resources. From this point on, you are no longer charged for computing resources. However, you are still charged for storage resources.
  • KeepCharging: The billing continues after you stop the cloud desktop. After the cloud desktop is stopped, the system does not reclaim resources to avoid startup failures due to insufficient resources. You are still charged for the resources.

Default value: StopCharging

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
&RegionId=cn-hangzhou
&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"
}