文档

ModifyDesktopTimer - 创建或修改云电脑定时任务

更新时间:

创建或修改云电脑定时任务,例如定时开机、关机、重启、重置等。

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。可以调用 DescribeRegions 获取无影云电脑支持的地域列表。

cn-hangzhou
DesktopIdarray

云电脑 ID。

string

云电脑 ID。

ecd-asuk39x45qnjp****
DesktopTimersobject []

云电脑定时任务详情。

TimerTypestring

定时任务类型。

枚举值:
  • NoOperationDisconnect无操作断连
  • LogoutShutdown退登关机
  • NoConnect断连任务(需指定OperationType)
  • TimerBoot定时开机
  • TimerReset定时重置
  • LoginAutoConnect登录自动连接
  • NoOperationShutdown无操作关机
  • TimerShutdown定时关机
  • NoOperationReboot无操作重启
  • TimerReboot定时重启
TimerBoot
CronExpressionstring

定时任务 Cron 表达式。

注意 需要传入 UTC 标准时间,即北京时间每天 0 点应该传入 0 0 16 ? * 1,2,3,4,5,6,7

0 0 16 ? * 1,2,3,4,5,6,7
Intervalinteger

时间间隔,单位为分钟。

10
Enforceboolean

是否强制执行。

枚举值:
  • true忽略云电脑及连接状态检测,强制执行定时任务。
  • false不强制执行。
true
ResetTypestring

云电脑重置类型。

枚举值:
  • RESET_TYPE_SYSTEM重置系统盘
  • RESET_TYPE_BOTH重置数据和用户磁盘
RESET_TYPE_SYSTEM
AllowClientSettingboolean

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

true
OperationTypestring

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

枚举值:
  • Hibernate休眠
  • Shutdown关机
Shutdown
UseDesktopTimersboolean

是否使用DesktopTimers需要传入true

true

返回参数

名称类型描述示例值
object
DesktopIdsarray

设置成功的云电脑 ID 列表。

string

云电脑 ID 列表。

['ecd-c6u0eis7rnqfw****']
RequestIdstring

请求 ID。

4638719F-3CAB-5704-BD54-55617BFF****

示例

正常返回示例

JSON格式

{
  "DesktopIds": [
    "['ecd-c6u0eis7rnqfw****']"
  ],
  "RequestId": "4638719F-3CAB-5704-BD54-55617BFF****"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)
文档反馈