云桌面 WORKSPACE-新增定时任务:请求参数

时间:2025-04-23 16:45:48

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

scheduled_type

String

执行周期:

  • FIXED_TIME - 指定时间

  • DAY - 按天

  • WEEK - 按周

  • MONTH - 按月

day_interval

Integer

周期按天时:按x天间隔执行。

week_list

String

周期按周时:取值1~7,英文逗号分隔,如1,2,7。

month_list

String

周期按月时:取值1~12,英文逗号分隔,如1,3,12。

date_list

String

周期按月时:取值1~31及L(代表当月最后一天),英文逗号分隔,如1,2,28,L。

time_zone

String

时区。

scheduled_date

String

周期指定时间时:表示指定的日期,格式为yyyy-MM-dd。

scheduled_time

String

指定的执行时间点,格式为HH:mm:ss。

expire_time

String

到期时间。

task_name

String

任务名称,名称需满足如下规则:

  1. 由中文,英文大小写,数字,_-组成,不能有空格。

  1. 长度范围1~64个字符。

task_type

String

定时任务类型:

  • RESTART_SERVER - 定时重启服务器

  • START_SERVER - 定时开机

  • STOP_SERVER - 定时关机

  • REINSTALL_OS - 定时重装操作系统

schedule_task_policy

ScheduleTaskPolicy object

定时任务策略。

description

String

任务描述。

target_infos

Array of TargetInfo objects

定时任务对象列表。

表4 ScheduleTaskPolicy

参数

是否必选

参数类型

描述

enforcement_enable

Boolean

当存在会话的时候,是否强制执行,强制执行开关。取值为:

  • false:表示关闭。

  • true:表示开启。

表5 TargetInfo

参数

是否必选

参数类型

描述

target_type

String

定时任务对象类型:

  • SERVER - 服务器

  • SERVER_GROUP - 服务器组

target_id

String

对象id。

support.huaweicloud.com/api-workspace/CreateScheduleTask.html