查询定时任务列表
功能介绍
查询定时任务列表。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/scheduled-tasks
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
是 |
Integer |
用于分页查询,查询的起始记录序号,从0开始。 |
limit |
是 |
Integer |
用于分页查询,每页返回的个数,取值范围0~50。 |
task_name |
否 |
String |
任务名称。 |
task_type |
否 |
String |
任务类型。START:开机,STOP:关机,REBOOT:重启,HIBERNATE:休眠,REBUILD:重建系统盘,EXECUTE_SCRIPT:执行脚本,CREATE_SNAPSHOT:创建EVS镜像。 |
scheduled_type |
否 |
String |
执行周期类型。FIXED_TIME:指定时间,DAY:按天,WEEK:按周,MONTH:按月,LIFE_CYCLE:触发式。指定LIFE_CYCLE时,才返回触发式任务。 |
life_cycle_type |
否 |
String |
触发场景类型。POST_CREATE_DESKTOP_SUCCESS:创建桌面成功后,POST_REBUILD_DESKTOP_SUCCESS:重建桌面成功后,POST_REATTACH_DESKTOP_SUCCESS:触发重建的分配用户任务成功后,POST_DESKTOP_DISCONNECTED:桌面断开连接后。 |
last_status |
否 |
String |
最近一次执行状态。SUCCESS:成功,SKIP:跳过,FAIL:失败。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
scheduled_tasks |
Array of ScheduledTask objects |
定时任务列表。 |
total_count |
Integer |
总个数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务id。 |
task_name |
String |
任务名称。 |
task_type |
String |
任务类型。START:开机,STOP:关机,REBOOT:重启,HIBERNATE:休眠,REBUILD:重建系统盘,EXECUTE_SCRIPT:执行脚本,CREATE_SNAPSHOT:创建快照。 |
scheduled_type |
String |
执行周期。FIXED_TIME:指定时间,DAY:按天,WEEK:按周,MONTH:按月。 |
life_cycle_type |
String |
触发场景类型。 |
last_status |
String |
最近一次执行状态。SUCCESS:成功,SKIP:跳过,FAIL:失败。 |
next_execution_time |
String |
下一次执行时间。格式为yyyy-MM-dd HH:mm:ss。 |
enable |
Boolean |
是否启用。 |
description |
String |
描述。 |
priority |
Integer |
优先级。触发式任务使用。 |
time_zone |
String |
时区 |
wait_time |
Integer |
触发式任务触发后,等待时长。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
无
响应示例
无
状态码
状态码 |
描述 |
---|---|
200 |
查询定时任务列表响应。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。