更新时间:2024-03-21 GMT+08:00
分享

创建定时任务

功能介绍

创建定时任务。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/scheduled-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表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_SUCCESS:创建桌面成功后,POST_REBUILD_DESKTOP_SUCCESS:重建桌面成功后,POST_REATTACH_DESKTOP_SUCCESS:触发重建的分配用户任务成功后。

time_zone

String

时区。

task_type

String

任务类型,可选值为:

  • START:开机。

  • STOP:关机。

  • REBOOT:重启。

  • HIBERNATE:休眠。

  • REBUILD:重建系统盘。

  • EXECUTE_SCRIPT:执行脚本。

task_name

String

任务名称。

force_execute

Boolean

是否强制执行,true表示强制执行,false表示不强制执行。

description

String

描述。

extra_params

String

扩展参数,json格式。

apply_objects

Array of ApplyObject objects

定时任务应用的对象列表。

表4 ApplyObject

参数

是否必选

参数类型

描述

object_id

String

对象ID。

object_type

String

对象类型,可选值为:

  • DESKTOP:桌面。

  • DESKTOP_POOL:桌面池。

  • ALL_DESKTOPS: 所有桌面,仅供触发式任务使用。

object_name

String

对象名称。

响应参数

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

请求示例

响应示例

状态码

状态码

描述

200

正常。

400

由于包含语法错误,当前请求无法被服务器理解。

500

服务内部错误,具体返回错误码请参见错误码说明。

错误码

请参见错误码

相关文档