You can call this operation to renew one or more subscription cloud desktops.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes RenewDesktops

The operation that you want to perform. Set the value to RenewDesktops.

DesktopId.N RepeatList Yes ecd-ia2zw38bi6cm7****

The ID of cloud desktop N.

Only subscription cloud desktops can be renewed by calling this operation.

RegionId String Yes cn-hangzhou

The region ID of the cloud desktop.

Period Integer No 1

The renewal duration. The valid values of this parameter are determined by the PeriodUnit value.

  • If PeriodUnit is set to Month, the valid values of the Period parameter are 1, 2, 3, and 6.
  • If PeriodUnit is set to Year, the valid values of the Period parameter are 1, 2, 3, 4, and 5.

Default value: 1.

PeriodUnit String No Month

The unit of the renewal duration specified by the Period parameter. Valid values:

  • Month
  • Year

Default value: Month.

AutoPay Boolean No true

Specifies whether to enable automatic payment. Valid values:

  • true: enables automatic payment. Make sure that you have sufficient balance in your account. Otherwise, abnormal orders are generated.
  • false: generates the order with no payment made. You can log on to the EDS console and complete the payment based on the order number.

Default value: true.

Response parameters

Parameter Type Example Description
OrderId String 20844399755****

The ID of the order.

RequestId String 4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB

The ID of the request.

Examples

Sample requests

https://ecd.cn-hangzhou.aliyuncs.com/?Action=RenewDesktops
&DesktopId.1=ecd-ia2zw38bi6cm7****
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<RenewDesktopsResponse>
      <RequestId>4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB</RequestId>
      <OrderId>20844399755****</OrderId>
</RenewDesktopsResponse>

JSON format

{
    "RequestId": "4636DBE0-BBB4-4076-8B8E-94D21A9A3CFB",
    "OrderId": "20844399755****"
}

Error codes

For a list of error codes, visit the API Error Center.