All Products
Search
Document Center

Elastic Desktop Service:RenewDesktops

Last Updated:Nov 14, 2025

Renews monthly subscription cloud computers.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecd:RenewDesktopsnone
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service (EDS).

cn-hangzhou
PeriodintegerNo

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

  • Valid values if you set the PeriodUnit parameter to Month: 1, 2, 3, and 6
  • Valid values if you set the PeriodUnit parameter to Year: 1, 2, 3, 4, 5, and 6

Default value: 1.

1
PeriodUnitstringNo

The unit of the renewal duration specified by the Period parameter.

Default value: Month. Valid values:

  • Month

  • Year

Month
AutoPaybooleanNo

Specifies whether to enable the auto-payment feature.

Valid values:

  • true (default): enables the auto-payment feature. Make sure that your account balance is sufficient. Otherwise, an abnormal order is generated.
  • false: disables the auto-payment feature. In this case, an order is generated but you need to complete the payment. You can log on to the EDS console and complete the payment based on the order ID on the Orders page.
true
DesktopIdarrayYes

The cloud computer IDs. You can only renew monthly subscription cloud computers.

stringYes

The cloud computer ID. You can only renew monthly subscription cloud computers.

ecd-ia2zw38bi6cm7****
PromotionIdstringNo

The ID of the promotional activity.

500030980150146
ResourceTypestringNo
Note This field is not available for public use.
null
AutoRenewbooleanNo

Specifies whether to enable the auto-renewal feature.

false

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

OrderIdstring

The order ID.

20844399755****
RequestIdstring

The request ID.

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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-07-09The request parameters of the API has changedView Change Details
2024-06-17The request parameters of the API has changedView Change Details
2024-06-01The request parameters of the API has changedView Change Details
2024-04-29The request parameters of the API has changedView Change Details
2021-08-19The request parameters of the API has changedView Change Details