首页 无影云桌面 API参考(云桌面管控) API目录 桌面 StopDesktops - 停止一台或者多台运行中的云桌面

StopDesktops - 停止一台或者多台运行中的云桌面

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

接口说明

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
StoppedModestring

关机后的计费模式。

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

默认为StopCharging。

StopCharging
DesktopIdarray

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

string

云桌面ID。

ecd-7w78ozhjcwa3u****

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

阿里云首页 无影云桌面 相关技术圈