链接复制成功！
查询定时运维历史记录
功能介绍
按照特定条件查询定时运维任务的历史执行记录。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/schedule/task/history
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
任务ID。 取值范围：以“ST”开头长度26的字符串。 默认值：不涉及。 |
|
id |
否 |
String |
任务关联脚本工单ID或作业工单ID。 默认值：不涉及。 |
|
region |
否 |
String |
任务所属区域。 默认值：不涉及。 |
|
status |
否 |
String |
任务执行状态。 取值范围：
默认值：不涉及。 |
|
started_start_time |
否 |
Long |
任务开始执行时间参数的查询区间的开始时间戳。 取值范围：毫秒级UTC时间戳。 默认值：不涉及。 |
|
started_end_time |
否 |
Long |
任务开始执行时间参数的查询区间的结束时间戳。 取值范围：毫秒级UTC时间戳。 默认值：不涉及。 |
|
finished_start_time |
否 |
Long |
任务结束执行时间参数的查询区间的开始时间戳。 取值范围：毫秒级UTC时间戳。 默认值：不涉及。 |
|
finished_end_time |
否 |
Long |
任务结束执行时间参数的查询区间的结束时间戳。 取值范围：毫秒级UTC时间戳。 默认值：不涉及。 |
|
marker |
否 |
String |
用于分页查询，上一页数据的最后一条记录的ID。 默认值：不涉及。 |
|
offset |
否 |
Integer |
用于分页查询，偏移指针。 默认值：不涉及。 |
|
limit |
是 |
Integer |
用于分页查询，结果数量。 默认值：不涉及。 |
|
sort_key |
否 |
String |
排序字段名：支持started_time、finished_time。 默认值：不涉及。 |
|
sort_dir |
否 |
String |
排序方式，与sort_key搭配使用，asc升序、desc降序。 默认值：不涉及。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Long |
定时运维历史记录总数量。 |
|
next_maker |
String |
分页标记。 |
|
scheduled_task_history_list |
Array of ScheduledTaskHistory objects |
定时运维历史记录列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
历史记录ID。 |
|
task_type |
String |
引用任务类型。 |
|
execution_id |
String |
执行ID。 |
|
associated_task_name |
String |
引用任务名称。 |
|
associated_task_name_en |
String |
引用任务名称（英文）。 |
|
region |
String |
区域。 |
|
created_by |
String |
创建人。 |
|
started_time |
Long |
开始时间时间戳。 |
|
finished_time |
Long |
结束时间时间戳。 |
|
status |
String |
状态。 |
|
execution_msg |
String |
执行结果描述。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
根据任务ID查询前10次执行成功的历史记录，并按开始时间逆序显示。
GET /v1/schedule/task/history?task_id=ST****&limit=10&offset=0&sort_key=started_time&sort_dir=desc&status=FINISHED响应示例
状态码：200
请求成功。
{
"count" : 1,
"next_maker" : "****",
"scheduled_task_history_list" : [ {
"associated_task_name" : "****",
"created_by" : "****",
"execution_id" : "SC****",
"finished_time" : 1745659982000,
"id" : "****",
"region" : "cn-north-4",
"started_time" : 1745659970000,
"status" : "FINISHED",
"task_type" : "SCRIPT"
} ]
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求成功。 |
|
400 |
服务器未能处理请求。 |
错误码
请参见错误码。
