调用RebuildDesktops变更云桌面的镜像。
接口说明
变更镜像前,请了解以下限制:
- 变更时可以选择操作系统不同的镜像,但以下地域不支持:中国(香港)、澳大利亚(悉尼)、新加坡、日本(东京)。
- GPU镜像和非GPU镜像之间不支持互相变更,即桌面规格为图形型时,只能使用GPU镜像;桌面规格为非图形型时,只能使用非GPU镜像。
变更镜像后,系统将使用新的镜像来初始化云桌面的系统盘,相关影响如下:
- 原桌面系统盘中的数据将被清除。基于原桌面系统盘创建的快照将无法使用,系统将自动删除相关快照。
- 如果变更了镜像的操作系统,则原桌面数据盘中的数据将被清除,基于原桌面数据盘创建的快照将无法使用,系统将自动删除相关快照;如果没有变更镜像的操作系统,则保留原桌面数据盘中的数据,且相关快照仍可使用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | RebuildDesktops |
系统规定参数。取值:RebuildDesktops。 |
RegionId | String | 是 | cn-hangzhou |
地域ID。 |
ImageId | String | 否 | m-84mztzatmlnys**** |
镜像ID,即变更后要使用的新镜像ID。 |
DesktopId.N | String | 是 | ecd-gx2x1dhsmucyy**** |
云桌面ID。可设置一个或多个,N的取值范围:1~20。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 484256DA-D816-44D2-9D86-B6EE4D5BA78C |
请求ID。 |
RebuildResults | Array of RebuildResult |
重建结果的集合。 |
|
Code | String | IncorrectDesktopStatus |
重建结果。返回success表示成功,否则将返回错误信息。 |
Message | String | The current status of the desktop does not support this operation. |
错误信息。当Code为success时,不返回该参数。 |
DesktopId | String | ecd-gx2x1dhsmucyy**** |
云桌面ID。 |
示例
请求示例
https://ecd.cn-hangzhou.aliyuncs.com/?Action=RebuildDesktops
&DesktopId.1=ecd-gx2x1dhsmucyy****
&RegionId=cn-hangzhou
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<RebuildDesktopsResponse>
<RebuildResults>
<Message>The current status of the desktop does not support this operation.</Message>
<DesktopId>ecd-gx2x1dhsmucyy****</DesktopId>
<Code>IncorrectDesktopStatus</Code>
</RebuildResults>
<RequestId>484256DA-D816-44D2-9D86-B6EE4D5BA78C</RequestId>
</RebuildDesktopsResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RebuildResults" : [ {
"Message" : "The current status of the desktop does not support this operation.",
"DesktopId" : "ecd-gx2x1dhsmucyy****",
"Code" : "IncorrectDesktopStatus"
} ],
"RequestId" : "484256DA-D816-44D2-9D86-B6EE4D5BA78C"
}