首页 无影云桌面 API参考(云桌面管控) API目录 桌面 ModifyDesktopSpec - 变更云桌面配置

ModifyDesktopSpec - 变更云桌面配置

变更云桌面配置,包括修改vCPU和内存规格,以及扩容磁盘。

接口说明

变更桌面配置包括修改桌面规格和扩容磁盘。

  • 变更前,请先了解云桌面支持哪些规格和磁盘大小。更多信息,请参见桌面规格概述
  • 变更时,您至少要改动桌面规格、系统盘大小和数据盘大小中的一项配置,即至少要传入DesktopType、RootDiskSizeGib和UserDiskSizeGib中的一个参数。相关注意事项如下:
    • 桌面规格包含vCPU、内存和GPU的配置,变更时,需要同时变更,即:仅支持从一个规格变更到另一个规格,不能单独修改其中一个配置。
    • 变更规格时,通用办公型规格和非通用办公型规格之间不支持互相变更,图形型规格和非图形型规格之间不支持互相变更。
    • 系统盘和数据盘均支持扩容,但不支持缩容。
    • 如果云桌面的计费方式为包年包月,系统将根据变更前后的差异计算费用差价,您需要补差价或者接收差价退款。
    • 对于同一台云桌面,两次操作变更配置的时间建议间隔5分钟以上。
    • 云桌面的状态必须为已停止(Stopped)。
  • 变更后不会影响您的个人数据。

调试

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

调试

授权信息

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

请求参数

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

地域ID。

cn-hangzhou
DesktopIdstring

云桌面ID。

ecd-4543qyik164a4****
DesktopTypestring

目标云桌面规格。您可以调用DescribeDesktopTypes查询云桌面支持的规格ID。

eds.general.2c8g
RootDiskSizeGibinteger

目标系统盘容量,单位为GiB。取值范围:80~500 GiB,且必须为10的倍数。

80
UserDiskSizeGibinteger

目标数据盘容量,单位为GiB。

  • 桌面规格为非图形型时,取值范围为20~1020 GiB,且必须为10的倍数。
  • 桌面规格为图形型时,取值范围为40~1020 GiB,且必须为10的倍数。
100
AutoPayboolean

是否自动支付。取值范围:

  • true:自动支付。请确保账户余额充足,否则会产生异常订单。
  • false:只产生订单,不支付。您可以登录控制台,在用户中心的我的订单页面,根据返回的订单号进行支付。

默认值:true

false
UserDiskPerformanceLevelstring

数据盘性能等级。取值范围:

  • PL0
  • PL1
  • PL2
  • PL3

默认值:PL0。

PL0
PromotionIdstring

优惠活动ID。

500033080110596

返回参数

名称类型描述示例值
object

返回对象。

OrderIdstring

订单ID。

123456789
RequestIdstring

请求ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

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