RebuildDesktops - 重建云桌面

重建云桌面实例。

接口说明

变更镜像前,请了解以下限制:

  • 变更时可以选择操作系统不同的镜像,但以下地域不支持:中国(香港)、澳大利亚(悉尼)、新加坡、日本(东京)。
  • GPU镜像和非GPU镜像之间不支持互相变更,即桌面规格为图形型时,只能使用GPU镜像;桌面规格为非图形型时,只能使用非GPU镜像。

变更镜像后,系统将使用新的镜像来初始化云桌面的系统盘,相关影响如下:

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

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
DesktopIdarray

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

string

云桌面ID。

ecd-gx2x1dhsmucyy****
ImageIdstring

镜像ID,即变更后要使用的新镜像ID。

m-84mztzatmlnys****
OperateTypestring

操作数据盘类型。

说明对于云桌面有无数据盘,调用此接口默认都是不传入任何字段值。
  • 云桌面无数据盘
    传入任何字段都不会进行数据盘操作。
  • 云桌面包含数据盘
    1. 云桌面操作系统和目标镜像操作系统相同时,取值范围:
      • 传入字段为replace时,替换云桌面的数据盘。
      • 不传入任何字段时,保留云桌面原来的数据盘。
    2. 云桌面操作系统和目标镜像操作系统不同时,取值范围:
      • 传入字段为replace时,替换云桌面的数据盘。
      • 不传入任何字段时,清空云桌面数据盘。
replace

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

请求ID。

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

重建结果的集合。

object

重建结果。

Codestring

重建结果。返回success表示成功,否则将返回错误信息。

IncorrectDesktopStatus
Messagestring

错误信息。当Code为success时,不返回该参数。

The current status of the desktop does not support this operation.
DesktopIdstring

云桌面ID。

ecd-gx2x1dhsmucyy****

示例

正常返回示例

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****"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-25OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:OperateType
2021-08-19OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ImageId
阿里云首页 无影云桌面 相关技术圈