云桌面 WORKSPACE-创建定时任务:请求参数

时间：2024-12-27 15:06:32

云桌面 WORKSPACE

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

表3 请求Body参数
参数	是否必选	参数类型	描述
scheduled_type	否	String	执行周期类型，可选值为： FIXED_TIME：指定时间。 DAY：按天。 WEEK：按周。 MONTH：按月。 LIFE_CYCLE：指定场景下触发。
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。
scheduled_date	否	String	周期指定时间时：表示指定的日期，格式为yyyy-MM-dd。
scheduled_time	否	String	指定的执行时间点，格式为HH:mm:ss。
expire_time	否	String	到期时间，格式为yyyy-MM-dd HH:mm:ss。
gray_count	否	Integer	灰度对象数量，优先级高于gray_desktop_ids。只支持脚本执行。
gray_desktop_ids	否	Array of strings	灰度执行的桌面id列表，优先级低于gray_count。只支持脚本执行。
gray_fail_threshold	否	Integer	灰度失败阈值，灰度执行失败次数达到该值时，不执行下一批任务。只支持脚本执行。
life_cycle_type	否	String	触发场景。POST_CREATE_DESKTOP_SUC CES S：创建桌面成功后，POST_REBUILD_DESKTOP_SUCCESS：重建桌面成功后，POST_REATTACH_DESKTOP_SUCCESS：触发重建的分配用户任务成功后，POST_DESKTOP_DISCONNECTED：桌面断开连接后。
time_zone	否	String	时区。
task_type	是	String	任务类型，可选值为： START：开机。 STOP：关机。 REBOOT：重启。 HIBERNATE：休眠。 REBUILD：重建系统盘。 EXECUTE_SCRIPT：执行脚本。 CREATE_SNAPSHOT：创建快照。
task_name	是	String	任务名称。
force_execute	否	Boolean	是否强制执行，true表示强制执行，false表示不强制执行。
description	否	String	描述。
extra_params	否	String	扩展参数，json格式。
apply_objects	否	Array of ApplyObject objects	定时任务应用的对象列表。
wait_time	否	Integer	触发式任务触发后，等待时长。

表4 ApplyObject
参数	是否必选	参数类型	描述
object_id	否	String	对象ID。
object_type	否	String	对象类型，可选值为： DESKTOP：桌面。 DESKTOP_POOL：桌面池。 ALL_DESKTOPS: 所有桌面，仅供触发式任务使用。 DESKTOP_TAG：桌面标签