CreateConfigGroup - Elastic Desktop Service - Alibaba Cloud Documentation Center

Creates a configuration group. A configuration group stores the setup details for scheduled tasks on cloud computers.

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:CreateConfigGroup	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region. Set the value to `cn-shanghai`.	cn-hangzhou
Name	string	Yes	The name of the configuration group.	ScheduledTask
Description	string	No	The description of the configuration group.	ScheduledTask
Type	string	Yes	The group type. Valid value: Timer: a scheduled task group.	Timer
ProductType	string	Yes	The service type of the configuration group. Valid value: CLOUD_DESKTOP: the cloud computer service.	CLOUD_DESKTOP
ConfigTimers	array<object>	No	The scheduled task groups.
	object	No	The scheduled task group.
TimerType	string	Yes	The scheduled task type. Valid values: NoOperationDisconnect: scheduled disconnection upon inactivity. NoConnect: scheduled disconnection upon specified operation (OperationType). TimerBoot: scheduled start. TimerReset: scheduled reset. NoOperationShutdown: scheduled shutdown upon inactivity. NoOperationHibernate: scheduled hibernation upon inactivity. TimerShutdown: scheduled shutdown. NoOperationReboot: scheduled restart upon inactivity. TimerReboot: scheduled restart.	TIMER_BOOT
CronExpression	string	No	The cron expression specified in the scheduled task. 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 forcefully execute the scheduled task.	true
ResetType	string	No	The reset option. Valid values: RESET_TYPE_SYSTEM: resets only the system disk. RESET_TYPE_USER_DISK: resets only the data disk. RESET_TYPE_BOTH: resets the system and data disks.	RESET_TYPE_SYSTEM
AllowClientSetting	boolean	No	Specifies whether to allow end users to configure the scheduled task.	true
OperationType	string	No	The type of the scheduled operation. If you set TimerType to NoConnect, you can specify this parameter. Valid values: Hibernate: scheduled hibernation. Shutdown: scheduled shutdown.	Shutdown
TriggerType	string	No	The method to trigger the scheduled task upon inactivity. Valid values: Advanced: intelligent detection. Standard: standard detection.	Standard
ProcessWhitelist	array	No	The process whitelist. If whitelisted processes are running, the scheduled task does not take effect.
	string	No	The process name.	chrome

Response parameters

Parameter	Type	Description	Example
	object	The object that is returned.
RequestId	string	The ID of the request.	EE9472BC-0B5D-5458-85CD-C52BDD******
GroupId	string	The ID of the configuration group.	ccg-0ctwi5zbswtql****
Message	string	The creation result of the configuration group.	success

Examples

Sample success responses

JSONformat

{
  "RequestId": "EE9472BC-0B5D-5458-85CD-C52BDD******",
  "GroupId": "ccg-0ctwi5zbswtql****",
  "Message": "success"
}

Error codes

HTTP status code	Error code	Error message
400	TestCode%sTestCode%sTestCode%s	TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s.

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

Change history

Change time	Summary of changes	Operation
2025-03-27	The Error code has changed	View Change Details