
# 查询定时任务执行列表 - ListTaskExecuteHistory
#### 功能介绍
查询定时任务执行列表。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=ListTaskExecuteHistory)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                  | 访问级别 | 资源类型（\*为必须）      | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:scheduledTasks:listRecords | List | scheduledTask \* | -   | -  | -      |
     
  
 
#### URI
GET /v1/{project_id}/schedule-task/{task_id}/execute-history
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述        |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目唯一标识。   |
| task_id    | 是    | String | 定时任务唯一标识。 |
   
表2Query参数 
| 参数     | 是否必选 | 参数类型    | 描述                        |
|:---|:---|:---|:---|
| 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 | 定时任务执行记录列表，返回列表条目数量上限为分页的最大上限值。 |
   
 表5ScheduleTaskExecuteHistory 
| 参数             | 参数类型    | 描述            |
|:---|:---|:---|
| id             | String  | 定时任务执行记录主键id。 |
| task_id        | String  | 定时任务主键id。     |
| task_type      | String  | 任务类型。         |
| status         | String  | 定时任务状态。       |
| scheduled_type | String  | 定时任务状态。       |
| total_count    | Integer | 总子任务数。        |
| success_count  | Integer | 成功的子任务数。      |
| failed_count   | Integer | 失败的子任务数。      |
| excuting_count | Integer | 正在执行的子任务数。    |
| time_zone      | String  | 时区。           |
| begin_time     | String  | 任务开始时间。       |
| end_time       | String  | 任务结束时间。       |
| create_time    | String  | 创建时间。         |
   
**状态码：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 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。
