查询定时任务执行记录
功能介绍
查询定时任务执行记录。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/scheduled-tasks/{task_id}/records
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。 |
task_id |
是 |
String |
任务ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
用于分页查询,查询的起始记录序号,从0开始。 |
limit |
否 |
Integer |
用于分页查询,返回桌面数量限制。取值范围0-100,默认值是10。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
tasks_records |
Array of ScheduledTasksRecords objects |
定时任务执行记录列表。 |
total_count |
Integer |
总个数。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
任务执行记录id。 |
start_time |
String |
执行时间,格式为yyyy-MM-dd HH:mm:ss。 |
task_type |
String |
任务类型。START:开机,STOP:关机,REBOOT:重启,HIBERNATE:休眠,REBUILD:重建系统盘。 |
scheduled_type |
String |
执行周期类型。FIXED_TIME:指定时间,DAY:按天,WEEK:按周,MONTH:按月。 |
life_cycle_type |
String |
触发场景类型。 |
status |
String |
本次执行状态。 |
success_num |
Integer |
成功桌面个数。 |
failed_num |
Integer |
失败桌面个数。 |
skip_num |
Integer |
跳过桌面个数。 |
time_zone |
String |
时区。 |
execute_task_id |
String |
执行定时任务的任务id,只有定时执行脚本返回。 |
execute_object_type |
String |
执行定时任务的对象类型,只有定时执行脚本返回。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
error_detail |
String |
错误详情。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码,失败时返回。 |
error_msg |
String |
错误描述。 |
error_detail |
String |
错误详情。 |
encoded_authorization_message |
String |
加密后的详细拒绝原因,用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
无
响应示例
状态码:200
正常。
{ "tasks_records" : [ { "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx", "start_time" : "2022-12-31 09:00:00", "task_type" : "START", "scheduled_type" : "FIXED_TIME", "status" : "SUCCESS", "success_num" : 1, "failed_num" : 1, "skip_num" : 1, "time_zone" : "Asia/Shanghai", "execute_task_id" : "string", "execute_object_type" : "string" } ], "total_count" : 10 }
状态码
状态码 |
描述 |
---|---|
200 |
正常。 |
400 |
由于包含语法错误,当前请求无法被服务器理解。 |
500 |
服务内部错误,具体返回错误码请参见错误码说明。 |
错误码
请参见错误码。