# 查询定时运维历史记录 - ListScheduledTaskHistory
#### 功能介绍
按照特定条件查询定时运维任务的历史执行记录。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/COC/doc?api=ListScheduledTaskHistory)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-coc/coc_api_06.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                       | 访问级别 | 资源类型（\*为必须） | 条件键                   | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | coc:schedule:getHistories | Read | schedule \* | g:EnterpriseProjectId | -  | -      |
     
#### URI
GET /v1/schedule/task/history
表1Query参数 
| 参数                  | 是否必选 | 参数类型    | 描述                                                                                                                                                              |
|:---|:---|:---|:---|
| task_id             | 是    | String  | **参数解释：** 定时任务ID。 **约束限制：** 真实存在的任意的任务。 **取值范围：** 以"ST"开头长度26的字符串。 **默认取值：** 不涉及。                                                                               |
| id                  | 否    | String  | **参数解释：** 定时任务关联的脚本工单ID或作业工单ID。 **约束限制：** 在"脚本管理"或"作业管理"中真实存在的工单ID。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                               |
| region              | 否    | String  | **参数解释：** 定时任务所属区域。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。                                                                                                |
| status              | 否    | String  | **参数解释：** 定时任务执行状态。 **约束限制：** 不涉及。 **取值范围：** - READY：待执行。 - PROCESSING：执行中。 - ABNORMAL：异常。 - PAUSED：已暂停。 - CANCELED：已取消。 - FINISHED：成功。 **默认取值：** 不涉及。          |
| 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  | **参数解释：** 排序字段名。 **约束限制：** 不涉及。 **取值范围：** - create_time：定时任务创建时间。 - update_time：定时任务修改时间。 - started_time：定时任务开始执行时间。 - finished_time：定时任务执行结束时间。 **默认取值：** 不涉及。 |
| sort_dir            | 否    | String  | **参数解释：** 排序方式，与sort_key搭配使用。 **约束限制：** 不涉及。 **取值范围：** - asc：升序。 - desc：降序。 **默认取值：** desc。                                                                     |
#### 请求参数
无
#### 响应参数
**状态码：200**
表2响应Body参数 
| 参数                          | 参数类型                                                                                                                           | 描述                                                                |
|:---|:---|:---|
| count                       | Long                                                                                                                           | **参数解释：** 定时任务历史执行记录总数量。 **取值范围：** 不涉及。                           |
| next_maker                  | String                                                                                                                         | **参数解释：** 分页标记。 **取值范围：** 不涉及。                                    |
| scheduled_task_history_list | Array of [ScheduledTaskHistory] objects | **参数解释：** 定时任务历史执行记录列表。 **取值范围：** 请参考ScheduledTaskHistory的具体取值约束。 |
   
 表3ScheduledTaskHistory 
| 参数                      | 参数类型   | 描述                                                                                                                       |
|:---|:---|:---|
| id                      | String | **参数解释：** 定时任务历史执行记录ID。 **取值范围：** 不涉及。                                                                                   |
| task_type               | String | **参数解释：** 定时任务关联的任务类型。 **取值范围：** - SCRIPT：脚本。 - RUNBOOK：作业。                                                              |
| execution_id            | String | **参数解释：** 定时任务关联的任务工单ID。 **取值范围：** 不涉及。                                                                                  |
| associated_task_name    | String | **参数解释：** 定时任务关联的任务名称。 **取值范围：** 不涉及。                                                                                    |
| associated_task_name_en | String | **参数解释：** 定时任务关联的任务名称（英文）。 **取值范围：** 不涉及。                                                                                |
| region                  | String | **参数解释：** 定时任务关联的实例资源所在的区域。 **取值范围：** 不涉及。                                                                               |
| created_by              | String | **参数解释：** 定时任务创建人的IAM用户ID。 **取值范围：** 不涉及。                                                                                |
| started_time            | Long   | **参数解释：** 定时任务开始执行时间戳。 **取值范围：** 不涉及。                                                                                    |
| finished_time           | Long   | **参数解释：** 定时任务结束执行时间戳。 **取值范围：** 不涉及。                                                                                    |
| status                  | String | **参数解释：** 定时任务的执行状态 **取值范围：** - READY：待执行。 - PROCESSING：执行中。 - ABNORMAL：异常。 - PAUSED：已暂停。 - CANCELED：已取消。 - FINISHED：成功。 |
| execution_msg           | String | **参数解释：** 定时任务执行结果描述。 **取值范围：** 不涉及。                                                                                     |
   
**状态码：400**
表4响应Body参数 
| 参数         | 参数类型   | 描述                             |
|:---|:---|:---|
| 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 | 服务器未能处理请求。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-coc/ErrorCode.html)。