Creates a configuration group that contains settings for cloud desktop scheduled tasks.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
No |
The region ID. You must set this parameter to Valid values:
|
cn-shanghai |
| Name |
string |
Yes |
The name of the configuration group. |
Scheduled task group |
| Description |
string |
No |
The description of the configuration group. |
Scheduled task description content |
| Type |
string |
Yes |
The type of the configuration group. Valid values:
|
Timer |
| ProductType |
string |
Yes |
The product type for the configuration group. Valid values:
|
CLOUD_DESKTOP |
| ConfigTimers |
array<object> |
No |
The scheduled task configurations. This is a list. |
|
|
array<object> |
No |
The configuration of a scheduled task. |
||
| TimerType |
string |
Yes |
The type of the scheduled task. Valid values:
|
TIMER_BOOT |
| CronExpression |
string |
No |
The Cron expression for the scheduled task. Important The Cron expression is specified in UTC. For example, to run a task at 00:00 China Standard Time (UTC+8) every day, use the expression 0 0 16 ? * 1,2,3,4,5,6,7. |
0 0 16 ? * 1,2,3,4,5,6,7 |
| Interval |
integer |
No |
The time interval in minutes. |
10 |
| Enforce |
boolean |
No |
Specifies whether to force the scheduled task to run. |
true |
| ResetType |
string |
No |
The reset type for the cloud desktop. Valid values:
|
RESET_TYPE_SYSTEM |
| AllowClientSetting |
boolean |
No |
Specifies whether to allow an end user to configure scheduled tasks. |
true |
| OperationType |
string |
No |
The operation type for the scheduled task. This parameter applies only to disconnect tasks. Valid values:
|
Shutdown |
| TriggerType |
string |
No |
The trigger type for inactivity-based scheduled tasks. Valid values:
|
Standard |
| ProcessWhitelist |
array |
No |
The process whitelist for smart detection in inactivity-based scheduled tasks. The scheduled task is not triggered if a process in this whitelist is running. |
|
|
string |
No |
The name of the process. |
chrome |
|
| NotificationTime |
integer |
No |
||
| SegmentTimers |
array<object> |
No |
||
|
object |
No |
|||
| OperationType |
string |
No |
||
| StartCronExpression |
string |
No |
||
| EndCronExpression |
string |
No |
||
| Interval |
integer |
No |
||
| TriggerType |
string |
No |
||
| ProcessWhitelist |
array |
No |
||
|
string |
No |
|||
| NotificationTime |
integer |
No |
||
| TimerOrder |
integer |
No |
||
| Timezone |
string |
No |
||
| Enforce |
boolean |
No |
||
| ResetType |
string |
No |
||
| ImageId |
string |
No |
The image ID. This parameter is used for scheduled image update tasks. |
m-5b0vjqbiqu010XXXXXX |
| LockScreenTime |
integer |
No |
The inactivity period, in seconds, before the screen locks. This feature is available only for AD-joined desktops. |
1800 |
| AppointmentTimer |
integer |
No |
The timestamp for a one-time scheduled task. The task runs at the specified time. |
1764660600967 |
| PatchId |
string |
No |
KB5082063 |
|
| CreateSnapshot |
boolean |
No |
||
| VerificationTime |
integer |
No |
||
| VerificationNotificationTime |
integer |
No |
||
| IpSegments |
array |
No |
||
|
string |
No |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| RequestId |
string |
The request ID. |
EE9472BC-0B5D-5458-85CD-C52BDD****** |
| GroupId |
string |
The configuration group ID. |
ccg-0ctwi5zbswtql**** |
| Message |
string |
The result of the operation. |
无 |
Examples
Success response
JSON format
{
"RequestId": "EE9472BC-0B5D-5458-85CD-C52BDD******",
"GroupId": "ccg-0ctwi5zbswtql****",
"Message": "无"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | TestCode%sTestCode%sTestCode%s | TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.