调用StopDesktops停止一台或者多台运行中的云桌面。接口调用成功后,云桌面进入已停止状态。

接口说明

云桌面的状态必须为运行中(Running)。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String StopDesktops

系统规定参数。取值:StopDesktops。

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

云桌面ID。可设置一个或多个。N的取值范围:1~20。

RegionId String cn-hangzhou

地域ID。

StoppedMode String StopCharging

关机后的计费模式。

  • StopCharging:关机后不收取计算资源的费用。云桌面关机后,系统将自动回收计算资源。此时计算资源不再计费,但存储费用仍正常收取。
  • KeepCharging:关机后继续计费。云桌面关机后,系统不回收资源,仍正常收取费用,避免因为库存不足导致无法启动。

默认为StopCharging。

返回数据

名称 类型 示例值 描述
RequestId String 1CBAFFAB-B697-4049-A9B1-67E1FC5FEB53

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=StopDesktops
&RegionId=cn-hangzhou
&DesktopId.1=ecd-7w78ozhjcwa3u****
&<公共请求参数>

正常返回示例

XML格式

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

JSON格式

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