调用ModifyDesktopChargeType转换云桌面的计费方式,目前仅支持由按量付费转换为包年包月。

接口说明

  • 调用该接口前,请确保您已充分了解云桌面的计费方式。更多信息,请参见计费概述
  • 调用该接口时,请确保目标云桌面的状态为运行中或者已关机,且当前没有产生欠费。
  • 订单支付完成后系统将开始转换云桌面的计费方式,转换期间桌面处于变配状态,此时,云桌面不支持进行其它操作,例如开机、关机、变更配置等。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ModifyDesktopChargeType

系统规定参数。取值:ModifyDesktopChargeType。

DesktopId.N RepeatList ecd-gx2x1dhsmucyy****

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

RegionId String cn-hangzhou

地域ID。

ChargeType String PrePaid

云桌面要转换成的计费方式。目前仅支持由按量付费转换为包年包月,取值为PrePaid。

Period Integer 1

转换成包年包月计费方式时,云桌面的购买时长。单位由PeriodUnit指定。当参数ChargeType取值为PrePaid时才生效,且为必选值。

  • 如果PeriodUnit为Week,该参数的取值范围为{“1”}。
  • 如果PeriodUnit为Month,该参数的取值范围为{“1”, “2”, “3”, “6”}。
  • 如果PeriodUnit为Year,该参数的取值范围为{“1”, “2”, “3”, “4”, “5”}。
PeriodUnit String Month

转换成包年包月计费方式时,包年包月计费的时长单位。取值范围:

  • Week:周
  • Month:月
  • Year:年

默认值:Month。

AutoPay Boolean false

转换成包年包月计费方式时,是否自动支付订单费用。取值范围:

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

默认值:true。

返回数据

名称 类型 示例值 描述
DesktopId List ["ecd-gx2x1dhsmucyy****"]

云桌面ID。返回集合信息。如果一次调用创建了多个云桌面,将返回多个云桌面ID。

OrderId String 123456789

订单ID。

RequestId String 3EB7FCEE-D731-4948-85A3-4B2C341CA983

请求ID。

示例

请求示例

https://ecd.cn-hangzhou.aliyuncs.com/?Action=ModifyDesktopChargeType
&DesktopId.1=ecd-gx2x1dhsmucyy****
&RegionId=cn-hangzhou
&ChargeType=PrePaid
&Period=1
&<公共请求参数>

正常返回示例

XML格式

<ModifyDesktopChargeTypeResponse>
      <RequestId>3EB7FCEE-D731-4948-85A3-4B2C341CA983</RequestId>
      <DesktopId>["ecd-gx2x1dhsmucyy****"]</DesktopId>
      <OrderId>123456789</OrderId>
</ModifyDesktopChargeTypeResponse>

JSON格式

{
    "RequestId": "3EB7FCEE-D731-4948-85A3-4B2C341CA983",
    "DesktopId": "[\"ecd-gx2x1dhsmucyy****\"]",
    "OrderId": "123456789"
}