文档首页/ 云桌面 Workspace/ API参考/ 云应用API/ 定时任务/ 查询定时任务执行列表
更新时间：2025-07-09 GMT+08:00
查看PDF
分享

查询定时任务执行列表

功能介绍

查询定时任务执行列表。

调试

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

URI

GET /v1/{project_id}/schedule-task/{task_id}/execute-history

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识。

task_id

是

String

定时任务唯一标识。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

查询的偏移量，默认值0。

limit

否

Integer

查询的数量，值区间[1-100]，默认值10。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。

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

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

count

Integer

总数。

items

Array of ScheduleTaskExecuteHistory objects

定时任务执行记录列表，返回列表条目数量上限为分页的最大上限值。
表5 ScheduleTaskExecuteHistory

参数

参数类型

描述

id

String

定时任务执行记录主键id。

task_id

String

定时任务主键id。

task_type

String

定时任务类型：

  • RESTART_SERVER - 定时重启服务器

  • START_SERVER - 定时开机

  • STOP_SERVER - 定时关机

  • REINSTALL_OS - 定时重装操作系统

status

String

job状态：

  • WAITING - 等待

  • RUNNING - 运行中

  • SUCCESS - 完成

  • FAILED - 失败

scheduled_type

String

执行周期：

  • FIXED_TIME - 指定时间

  • DAY - 按天

  • WEEK - 按周

  • MONTH - 按月

total_count

Integer

总子任务数。

success_count

Integer

成功的子任务数。

failed_count

Integer

失败的子任务数。

excuting_count

Integer

正在执行的子任务数。

time_zone

String

时区。

begin_time

DateTime

任务开始时间。

end_time

DateTime

任务结束时间。

create_time

DateTime

创建时间。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：405

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：500

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

状态码：503

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码，失败时返回。

error_msg

String

错误描述。

请求示例

无

响应示例

状态码：200

成功响应。

{
  "count" : 0,
  "items" : [ {
    "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b",
    "task_id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b",
    "task_type" : "RESTART_SERVER",
    "status" : "WAITING",
    "scheduled_type" : "day",
    "total_count" : 10,
    "success_count" : 5,
    "failed_count" : 4,
    "excuting_count" : 4,
    "time_zone" : "Asia/Shanghai",
    "begin_time" : "2022-03-07T10:40:43.858Z",
    "end_time" : "2022-03-07T10:40:43.858Z",
    "create_time" : "2022-03-07T10:40:43.858Z"
  } ]
}

状态码

状态码

描述

200

成功响应。

400

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

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

405

请求中指定的方法不被允许。

500

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

503

服务不可用。

错误码

请参见错误码。

父主题： 定时任务

相关文档