Automate Cloud PC Startup and Shutdown Schedules - Elastic Desktop Service - Alibaba Cloud - Elastic Desktop Service

Creates or modifies scheduled tasks on cloud computers, such as starting, stopping, restarting, and resetting cloud computers on schedule.

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:ModifyDesktopTimer

update

*All Resource

*

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
DesktopId	array	Yes	The IDs of the cloud computers.
	string	No	The ID of a cloud computer.	ecd-asuk39x45qnjp****
DesktopTimers	array<object>	No	The details of the scheduled task on cloud computers.
	object	No
TimerType	string	No	The type of the scheduled task. Valid values: NoOperationDisconnect: Disconnects the cloud computers without performing operations on the cloud computers. LogoutShutdown: Stops the cloud computers when end users log out Alibaba Cloud Workspace clients. NoConnect: Disconnects the cloud computers when end users perform one of the actions that is specified by the OperationType parameter. TimerBoot: Starts the cloud computers on schedule. TimerReset: Resets the cloud computers on schedule. LoginAutoConnect: automatically connects to the cloud computers when end users log on to Alibaba Cloud Workspace clients. NoOperationShutdown: Stops the cloud computers without performing operations on the cloud computers. TimerShutdown: Stops the cloud computers on schedule. NoOperationReboot: Restarts the cloud computers without performing operations on the cloud computers. TimerReboot: Restarts the cloud computers on schedule. Valid values: NoOperationDisconnect : LogoutShutdown : NoConnect : TimerBoot : TimerReset : LoginAutoConnect : NoOperationShutdown : TimerShutdown : NoOperationReboot : TimerReboot :	TimerBoot
CronExpression	string	No	The cron expression of the schedule. Note The time must be in UTC. For example, for 24:00 (UTC+8), you must set the value to 0 0 16 ? * 1,2,3,4,5,6,7	0 0 16 ? * 1,2,3,4,5,6,7
Interval	integer	No	The interval at which the scheduled task is executed. Unit: minutes.	10
Enforce	boolean	No	Specifies whether to forcibly execute the scheduled task. Valid values: true: forcibly executes the scheduled task regardless of the status and connection of the cloud computers. false: does not forcibly execute the scheduled task. Valid values: true : false :	true
ResetType	string	No	The reset type of the cloud computers. Valid values: RESET_TYPE_SYSTE: resets the system disk. RESET_TYPE_BOTH: resets data and user disks. Valid values: RESET_TYPE_SYSTEM : RESET_TYPE_BOTH :	RESET_TYPE_SYSTEM
AllowClientSetting	boolean	No	Specifies whether to allow end users to configure the scheduled task.	true
OperationType	string	No	The operations that scheduled tasks support. This parameter is valid only when TimerType is set to NoConnect. Valid values: Hibernate: hibernates the cloud computers. Shutdown: stops the cloud computers. Valid values: Hibernate : Shutdown :	Shutdown
UseDesktopTimers	boolean	No	Specifies whether to use the `DesktopTimers` parameter. Set the value to `true`.	true

Response elements

Element	Type	Description	Example
	object
DesktopIds	array	The IDs of the cloud computers for which you successfully configure the scheduled task.
	string	The ID of the cloud computer for which you successfully configure the scheduled task.	['ecd-c6u0eis7rnqfw****']
RequestId	string	The request ID.	4638719F-3CAB-5704-BD54-55617BFF****

Examples

Success response

JSON format

{
  "DesktopIds": [
    "['ecd-c6u0eis7rnqfw****']"
  ],
  "RequestId": "4638719F-3CAB-5704-BD54-55617BFF****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.