ResetDesktops-阿里云帮助中心

Resets cloud desktops in a shared cloud computer group.

Operation description

Note

This operation applies only to shared cloud computers. It does not support resetting standard cloud desktops.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. Call DescribeRegions to list regions that support WUYING Workspace.	cn-hangzhou
DesktopGroupId	string	No	The ID of the shared cloud computer. If you specify `DesktopId`, the system ignores `DesktopGroupId`. If `DesktopId` is empty, the system uses `DesktopGroupId` to retrieve the `DesktopId` of all cloud desktops in the shared cloud computer group.	dg-07if7qsxoxkb6****
PayType	string	No	The billing method. Note This parameter applies only when resetting shared cloud computers. If you leave it empty, the system resets all cloud desktops in the shared cloud computer group, regardless of their billing method. Valid values: PostPaid : pay-as-you-go PrePaid : subscription	PrePaid
ResetType	string	Yes	The reset type. This determines whether to reset and which disks to reset. Valid values: 0 : No reset 1 : Reset only the system disk 2 : Reset only the user disk 3 : Reset both the system disk and the user disk	1
ImageId	string	No	The image ID.	m-4zfb6zj728hhr****
DesktopId	array	No	A list of cloud desktop IDs. You can specify 1 to 100 IDs.
	string	No	A cloud desktop ID.	ecd-07if7qsxoxkb3****
DesktopGroupIds	array	No	A list of shared cloud computer group IDs.
	string	No	The ID of the shared cloud computer.	dg-kadkdfaf****
ResetScope	string	No	The scope of the reset operation. Set this parameter to reset either the image or the cloud desktop. Valid values: ALL : Reset both the image and the cloud desktop. This is the default value. IMAGE : Reset only the image.	ALL
LastRetryTime	integer	No

Response elements

Element	Type	Description	Example
	object	Returns a collection of information.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.