创建配置组。配置组中包含云电脑中心定时任务的配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecd:CreateConfigGroup |
list |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
否 |
地域 ID。该功能无地域属性,该字段固定填写 枚举值:
|
cn-shanghai |
| Name |
string |
是 |
配置组名称。 |
定时任务组 |
| Description |
string |
否 |
配置组描述信息。 |
定时任务描述内容 |
| Type |
string |
是 |
配置组类型。 枚举值:
|
Timer |
| ProductType |
string |
是 |
配置组使用的产品类型。 枚举值:
|
CLOUD_DESKTOP |
| ConfigTimers |
array<object> |
否 |
定时任务的配置信息,列表结构。 |
|
|
array<object> |
否 |
定时任务配置信息。 |
||
| TimerType |
string |
是 |
定时任务类型。 枚举值:
|
TIMER_BOOT |
| CronExpression |
string |
否 |
定时任务 Cron 表达式。 重要 需要传入 UTC 标准时间,即北京时间每天 0 点应该传入 0 0 16 ? * 1,2,3,4,5,6,7 |
0 0 16 ? * 1,2,3,4,5,6,7 |
| Interval |
integer |
否 |
时间间隔,单位为分钟。 |
10 |
| Enforce |
boolean |
否 |
是否强制执行。 |
true |
| ResetType |
string |
否 |
云电脑重置类型。 枚举值:
|
RESET_TYPE_SYSTEM |
| AllowClientSetting |
boolean |
否 |
是否允许终端用户自行配置定时任务。 |
true |
| OperationType |
string |
否 |
定时任务操作类型,目前仅断连定时任务支持。 枚举值:
|
Shutdown |
| TriggerType |
string |
否 |
无操作定时任务触发配置类型。 枚举值:
|
Standard |
| ProcessWhitelist |
array |
否 |
无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。 |
|
|
string |
否 |
进程名称。 |
chrome |
|
| NotificationTime |
integer |
否 |
定时任务执行前的通知提前时间。单位:秒。 |
300 |
| SegmentTimers |
array<object> |
否 |
分段定时器配置列表。 |
|
|
object |
否 |
|||
| OperationType |
string |
否 |
定时任务操作类型,目前仅断连定时任务支持。 |
Shutdown |
| StartCronExpression |
string |
否 |
定时任务开始执行的 Cron 表达式。 |
0 0 8 ? * 1-5 |
| EndCronExpression |
string |
否 |
定时任务结束执行的 Cron 表达式。 |
0 0 18 ? * 1-5 |
| Interval |
integer |
否 |
时间间隔,单位为分钟。 |
10 |
| TriggerType |
string |
否 |
无操作定时任务触发配置类型。 |
Standard |
| ProcessWhitelist |
array |
否 |
无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。 |
|
|
string |
否 |
进程白名单,名单内进程运行时定时任务不生效。 |
chrome.exe |
|
| NotificationTime |
integer |
否 |
定时任务执行前的通知提前时间。单位:秒。 |
300 |
| TimerOrder |
integer |
否 |
定时器的执行顺序号。 |
1 |
| Timezone |
string |
否 |
定时任务使用的时区。 |
Asia/Shanghai |
| Enforce |
boolean |
否 |
是否强制执行。为 true 表示忽略桌面及连接状态检测,强制执行定时任务。 |
|
| ResetType |
string |
否 |
重置类型,决定是否重置,以及要重置的磁盘范围。 |
1 |
| ImageId |
string |
否 |
镜像 ID。 |
m-4zfb6zj728hhr**** |
| LockScreenTime |
integer |
否 |
无操作锁屏功能使用,指定无操作后触发锁屏的时长。单位:分钟。仅 AD 云电脑支持。 |
5 |
| AppointmentTimer |
integer |
否 |
定点执行定时任务使用,指定后可以按照指定时间点执行定时任务 |
1764660600967 |
| PatchId |
string |
否 |
补丁 ID |
KB5082063 |
| CreateSnapshot |
boolean |
否 |
是否创建快照 |
|
| VerificationTime |
integer |
否 |
校验等待时长。单位:秒。 |
600 |
| VerificationNotificationTime |
integer |
否 |
执行校验前的通知提前时间。单位:秒。 |
300 |
| IpSegments |
array |
否 |
生效的 IP 网段列表。 |
|
|
string |
否 |
生效的 IP 网段列表。 |
192.168.1.0/24 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
创建结果 |
||
| RequestId |
string |
请求 ID。 |
EE9472BC-0B5D-5458-85CD-C52BDD****** |
| GroupId |
string |
配置组 ID。 |
ccg-0ctwi5zbswtql**** |
| Message |
string |
创建结果。 |
success |
示例
正常返回示例
JSON格式
{
"RequestId": "EE9472BC-0B5D-5458-85CD-C52BDD******",
"GroupId": "ccg-0ctwi5zbswtql****",
"Message": "success"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | TestCode%sTestCode%sTestCode%s | TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。