调用RebuildDesktops API变更云电脑镜像-无影云电脑企业版-阿里云-无影云电脑企业版-阿里云帮助中心

接口说明

变更镜像操作有以下限制：

中国香港和海外地域的云电脑不支持变更为另一种操作系统的镜像（例如从 Windows 镜像变更为 Linux 镜像）。
GPU 镜像和非 GPU 镜像之间不支持互相变更，即图形型云电脑只能使用 GPU 镜像，非图形型云电脑只能使用非 GPU 镜像。

变更镜像后，系统将使用新的镜像来初始化云电脑的系统盘，相关影响如下：

原云电脑系统盘中的数据将被清除。基于原云电脑系统盘创建的快照将无法使用，系统将自动删除相关快照。
如果变更了镜像的操作系统，则原云电脑数据盘中的数据将被清除，基于原云电脑数据盘创建的快照将无法使用，系统将自动删除相关快照；如果没有变更镜像的操作系统，则保留原云电脑数据盘中的数据，且相关快照仍可使用。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:RebuildDesktops

update

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。	cn-hangzhou
DesktopId	array	是	云电脑 ID。可设置 1~20 个。	ecd-gx2x1dhsmucyy****
	string	否	云电脑 ID。	ecd-gx2x1dhsmucyy****
ImageId	string	否	变更后要使用的新镜像 ID。	m-84mztzatmlnys****
OperateType	string	否	操作数据盘类型。说明不论云电脑是否有数据盘，调用此接口默认都是不传入任何字段值。若云电脑无数据盘：传入任何字段都不会进行数据盘操作。若云电脑包含数据盘：当云电脑操作系统和目标镜像操作系统相同时：传入字段为`replace`时，替换云电脑的数据盘。不传入任何字段时，保留云电脑原来的数据盘。当云电脑操作系统和目标镜像操作系统不同时：传入字段为`replace`时，替换云电脑的数据盘。不传入任何字段时，清空云电脑数据盘。	replace
Language	string	否	操作系统语言。目前只支持系统镜像，并且 Linux 电脑仅支持选择英文。枚举值： en-US : 英文 zh-HK : 繁体中文（香港） zh-CN : 简体中文 ja-JP : 日文	en-US
AfterStatus	string	否

返回参数

名称	类型	描述	示例值
	object	返回信息集合。
RequestId	string	请求 ID。	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
RebuildResults	array<object>	重建结果的集合。
	object	重建结果。
Code	string	重建结果。返回`success`表示成功，否则将返回错误信息。	IncorrectDesktopStatus
Message	string	错误信息。当`Code`为`success`时，不返回该参数。	The current status of the desktop does not support this operation.
DesktopId	string	云电脑 ID。	ecd-gx2x1dhsmucyy****

若返回的状态码为200，RebuildResults中是各台云电脑是否开始重建，Code为Success的代表云电脑开始重建，否则代表云电脑重建失败的错误码。
若返回的状态码为4xx，代表参数不符合预期，所有云电脑都没有开始重建。

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "RebuildResults": [
    {
      "Code": "IncorrectDesktopStatus",
      "Message": "The current status of the desktop does not support this operation.",
      "DesktopId": "ecd-gx2x1dhsmucyy****"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。