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

更新时间:
复制为 MD 格式

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

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ecd:ModifyDesktopTimer

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

RegionId

string

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

cn-hangzhou

DesktopId

array

云电脑 ID。

string

云电脑 ID。

ecd-asuk39x45qnjp****

DesktopTimers

array<object>

云电脑定时任务详情。

object

云电脑定时任务。

TimerType

string

定时任务类型。

枚举值:

  • NoOperationDisconnect :

    无操作断连

  • LogoutShutdown :

    退登关机

  • NoConnect :

    断连任务(需指定 OperationType)

  • TimerBoot :

    定时开机

  • TimerReset :

    定时重置

  • LoginAutoConnect :

    登录自动连接

  • NoOperationShutdown :

    无操作关机

  • TimerShutdown :

    定时关机

  • NoOperationReboot :

    无操作重启

  • TimerReboot :

    定时重启

TimerBoot

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 :

    忽略云电脑及连接状态检测,强制执行定时任务。

  • false :

    不强制执行。

true

ResetType

string

云电脑重置类型。

枚举值:

  • RESET_TYPE_SYSTEM :

    重置系统盘

  • RESET_TYPE_BOTH :

    重置数据和用户磁盘

RESET_TYPE_SYSTEM

AllowClientSetting

boolean

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

true

OperationType

string

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

枚举值:

  • Hibernate :

    休眠

  • Shutdown :

    关机

Shutdown

UseDesktopTimers

boolean

是否使用DesktopTimers需要传入true

true

返回参数

名称

类型

描述

示例值

object

DesktopIds

array

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

string

云电脑 ID 列表。

['ecd-c6u0eis7rnqfw****']

RequestId

string

请求 ID。

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

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情