创建配置组。配置组中包含云电脑中心定时任务的配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 地域 ID。该功能无地域属性,该字段固定填写 | cn-shanghai |
Name | string | 是 | 配置组名称。 | 定时任务组 |
Description | string | 否 | 配置组描述信息。 | 定时任务描述内容 |
Type | string | 是 | 配置组类型。 枚举值:
| Timer |
ProductType | string | 是 | 配置组使用的产品类型。 枚举值:
| CLOUD_DESKTOP |
ConfigTimers | array<object> | 否 | 定时任务的配置信息,列表结构。 | |
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 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "EE9472BC-0B5D-5458-85CD-C52BDD******",
"GroupId": "ccg-0ctwi5zbswtql****",
"Message": "无"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | TestCode%sTestCode%sTestCode%s | TestCodeMsg.%s,TestCodeMsg.%s.TestCodeMsg,%s. | 中文.%s,中文.%s.中文,%s |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2025-03-27 | OpenAPI 错误码发生变更 | 查看变更详情 |