CreateConfigGroup - 创建配置组

更新时间:
复制 MD 格式

创建配置组。配置组中包含云电脑中心定时任务的配置信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

RegionId

string

地域 ID。该功能无地域属性,该字段固定填写cn-shanghai

枚举值:

  • cn-shanghai :

    cn-shanghai

cn-shanghai

Name

string

配置组名称。

Scheduled task group

Description

string

配置组描述信息。

Scheduled task description content

Type

string

配置组类型。

枚举值:

  • Timer :

    定时任务

Timer

ProductType

string

配置组使用的产品类型。

枚举值:

  • CLOUD_DESKTOP :

    云电脑

CLOUD_DESKTOP

ConfigTimers

array<object>

定时任务的配置信息,列表结构。

array<object>

定时任务配置信息。

TimerType

string

定时任务类型。

枚举值:

  • NoOperationDisconnect :

    无操作断连

  • NoConnect :

    断连任务(需指定 OperationType)

  • TimerBoot :

    定时开机

  • TimerReset :

    定时重置

  • NoOperationShutdown :

    无操作关机

  • NoOperationHibernate :

    无操作休眠

  • TimerShutdown :

    定时关机

  • NoOperationReboot :

    无操作重启

  • TimerReboot :

    定时重启

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 :

    只重置系统盘

  • RESET_TYPE_USER_DISK :

    只重置数据盘

  • RESET_TYPE_BOTH :

    同时重置系统盘和数据盘

RESET_TYPE_SYSTEM

AllowClientSetting

boolean

是否允许终端用户自行配置定时任务。

true

OperationType

string

定时任务操作类型,目前仅断连定时任务支持。

枚举值:

  • Hibernate :

    休眠

  • Shutdown :

    关机

Shutdown

TriggerType

string

无操作定时任务触发配置类型。

枚举值:

  • Advanced :

    智能判断

  • Standard :

    标准判断

Standard

ProcessWhitelist

array

无操作定时任务智能判断的进程白名单,如果指定的进程正在运行则不支持无操作定时任务。

string

进程名称。

chrome

NotificationTime

integer

SegmentTimers

array<object>

object

OperationType

string

StartCronExpression

string

EndCronExpression

string

Interval

integer

TriggerType

string

ProcessWhitelist

array

string

NotificationTime

integer

TimerOrder

integer

Timezone

string

Enforce

boolean

ResetType

string

ImageId

string

变更镜像定时任务使用,指定需要变更的镜像 ID

m-5b0vjqbiqu010XXXXXX

LockScreenTime

integer

无操作锁屏功能使用,指定锁屏时间点,非 AD 桌面不能使用

1800

AppointmentTimer

integer

定点执行定时任务使用,指定后可以按照指定时间点执行定时任务

1764660600967

PatchId

string

KB5082063

CreateSnapshot

boolean

VerificationTime

integer

VerificationNotificationTime

integer

IpSegments

array

string

返回参数

名称

类型

描述

示例值

object

创建结果

RequestId

string

请求 ID。

EE9472BC-0B5D-5458-85CD-C52BDD******

GroupId

string

配置组 ID。

ccg-0ctwi5zbswtql****

Message

string

创建结果。

示例

正常返回示例

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.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情