RenewDesktopGroup - Elastic Desktop Service - Alibaba Cloud Documentation Center

Renews a shared cloud computer.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
ecd:RenewDesktopGroup	none	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the regions supported by Elastic Desktop Service (EDS).	cn-hangzhou
DesktopGroupId	string	Yes	The ID of the shared group.	dg-7724r1jitbjzc****
Period	integer	No	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, and 5 Default value: 1	1
PeriodUnit	string	Yes	The unit of the renewal duration specified by the `Period` parameter. Valid values: Month (default) Year	Month
AutoPay	boolean	No	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 make the payment manually. You can log on to the EDS console and complete the payment based on the order ID on the Orders page.	true
AutoRenew	boolean	No	Specifies whether to enable auto-renewal. Valid values: true false	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	E55E6732-2028-52FA-AB06-EA29C36B****
OrderId	array	The order IDs.
OrderIds	string	The order ID.	21455206303****

Examples

Sample success responses

JSONformat

{
  "RequestId": "E55E6732-2028-52FA-AB06-EA29C36B****",
  "OrderId": [
    "21455206303****"
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history