更新时间:2024-12-12 GMT+08:00

查询定时任务详情

功能介绍

查询定时任务详情。

调试

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

URI

GET /v2/{project_id}/scheduled-tasks/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

task_id

String

任务ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

id

String

任务id

task_type

String

任务类型。START:开机,STOP:关机,REBOOT:重启,HIBERNATE:休眠,REBUILD:重建系统盘,EXECUTE_SCRIPT:执行脚本。scheduled_type为LIFE_CYCLE时,不支持START、REBUILD。

task_name

String

任务名称。

force_execute

Boolean

是否强制执行。

scheduled_type

String

执行周期类型。FIXED_TIME:指定时间,DAY:按天,WEEK:按周,MONTH:按月,LIFE_CYCLE:指定场景下触发。

life_cycle_type

String

触发场景类型。仅当scheduled_type为LIFE_CYCLE时,生效。POST_CREATE_DESKTOP_SUCCESS:创建桌面成功后,POST_REBUILD_DESKTOP_SUCCESS:重建桌面成功后,POST_REATTACH_DESKTOP_SUCCESS:触发重建的分配用户任务成功后。

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。

description

String

描述。

extra_params

String

扩展参数,json格式。

apply_objects

Array of ApplyObject objects

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

gray_count

Integer

灰度对象数量,优先级高于gray_desktop_ids。

gray_desktop_ids

Array of strings

灰度执行的桌面id列表,优先级低于gray_count。

gray_fail_threshold

Integer

灰度失败阈值,灰度执行失败次数达到该值时,不执行下一批任务。

time_zone

String

时区。

wait_time

Integer

触发式任务触发后,等待时长。

表4 ApplyObject

参数

参数类型

描述

object_id

String

对象ID。

object_type

String

对象类型,可选值为:

  • DESKTOP:桌面。

  • DESKTOP_POOL:桌面池。

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

  • DESKTOP_TAG:桌面标签

object_name

String

对象名称。

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码: 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码,失败时返回。

error_msg

String

错误描述。

encoded_authorization_message

String

加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

响应示例

状态码

状态码

描述

200

正常。

400

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

500

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

错误码

请参见错误码