修改定时任务
功能介绍
修改定时任务。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
PUT /v2/{project_id}/scheduled-tasks/{task_id}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
task_id |
是 |
String |
任务ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
scheduled_type |
否 |
String |
执行周期类型,可选值为:
|
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_name |
否 |
String |
任务名称。 |
force_execute |
否 |
Boolean |
是否强制执行 |
description |
否 |
String |
描述。 |
enable |
否 |
Boolean |
是否启用 |
extra_params |
否 |
String |
扩展参数,json格式。 |
apply_objects |
否 |
Array of ApplyObject objects |
定时任务应用的对象列表。 |
priority |
否 |
Integer |
优先级。触发式任务使用。 |
is_gray |
否 |
Boolean |
任务是否灰度执行,供远程脚本使用。 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
正常。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。