StopDesktops-阿里云帮助中心

Operation description

The cloud desktops must be in the Running state.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecd:StopDesktops

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to get a list of regions that Elastic Desktop Service supports.	cn-hangzhou
StoppedMode	string	No	Specifies the billing mode for the cloud desktops after they are stopped. Valid values: StopCharging : Releases compute resources after the cloud desktops are stopped. This stops charges for compute resources, but billing for storage resources continues. (Default) KeepCharging : Retains all resources after the cloud desktops are stopped. This ensures that the cloud desktops can be restarted and avoids startup failures due to insufficient resources. Billing for all resources continues.	StopCharging
DesktopId	array	Yes	An array of 1 to 100 cloud desktop IDs.	ecd-7w78ozhjcwa3u****
	string	No	A cloud desktop ID.	ecd-7w78ozhjcwa3u****
OsUpdate	boolean	No	Specifies whether to apply pending patch updates.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.