StopDesktops - 停止一台或者多台运行中的云电脑

更新时间:
复制为 MD 格式

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

接口说明

云电脑的状态必须为运行中(Running)。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:StopDesktops

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou

StoppedMode

string

关机后的计费模式。

枚举值:

  • StopCharging :

    关机后系统将自动回收计算资源,计算资源不再计费,但存储资源仍正常计费。[默认值]

  • KeepCharging :

    关机后系统不回收资源,避免因为库存不足导致无法启动,仍正常收取费用。

StopCharging

DesktopId

array

云电脑 ID。可设置 1~100 个。

ecd-7w78ozhjcwa3u****

string

云电脑 ID。

ecd-7w78ozhjcwa3u****

OsUpdate

boolean

在更新已就绪的前提下,是否执行补丁更新。为 true 表示执行补丁更新。

false

PatchId

string

KB5082063

CreateSnapshot

string

false

返回参数

名称

类型

描述

示例值

object

返回信息集合。

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情