ResetDesktops - Elastic Desktop Service - Alibaba Cloud Documentation Center

Resets cloud computers of a cloud computer share.

Operation description

Note You can call this operation to reset only cloud computers from a cloud computer share.

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:ResetDesktops	update	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 most recent region list.	cn-hangzhou
DesktopGroupId	string	No	The ID of the cloud computer share. If you specify `DesktopId`, ignore `DesktopGroupId`. If you leave `DesktopId` empty, the system obtains the IDs of all cloud computers within the share specified by `DesktopGroupId`.``	dg-07if7qsxoxkb6****
PayType	string	No	The billing method of the cloud computer share. Note This parameter takes effect when you reset a cloud computer share. If you leave this parameter empty, all cloud computers in that share are reset. Valid values: PostPaid: pay-as-you-go. PrePaid: subscription.	PrePaid
ResetType	string	Yes	The disk reset type. Valid values: 0: does not reset disks. 1: resets only the system disk. 2: resets only the user disk. 3: resets the system disk and the user disk.	1
ImageId	string	No	The ID of the image.	m-4zfb6zj728hhr****
DesktopId	array	No	The IDs of the cloud computers. You can specify the IDs of 1 to 100 cloud computers.
	string	No	The ID of the cloud computer.	ecd-07if7qsxoxkb3****
DesktopGroupIds	array	No	The IDs of the cloud computer shares.
	string	No	The ID of the cloud computer share.	dg-kadkdfaf****
ResetScope	string	No	The reset scope. You can configure this parameter to reset the image or cloud computer. Valid values: ALL (default): resets the image and cloud computer. IMAGE: resets only the image.	ALL

Response parameters

Parameter	Type	Description	Example
	object	The information that is returned.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-03-13	The request parameters of the API has changed	View Change Details