
# 镜像子任务查询 - ListImageSubJobs
#### 功能介绍
该接口用于查询异步子任务执行情况,sub_job_ids非空时offset和limit不会生效。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/WorkspaceApp/doc?api=ListImageSubJobs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-workspace/workspace_09_0128.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                                    | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | workspace:imageServer:listImageSubJobs | List | -           | -   | -  | -      |
     
  
 
#### URI
GET /v1/{project_id}/image-server-sub-jobs
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述      |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目唯一标识。 |
   
表2Query参数 
| 参数       | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| status   | 否    | String  | job详情的状态： - *WAITING* - 等待   - *RUNNING* - 运行中   - *SUCCESS* - 成功   - *FAILED* - 失败   - *ABNORMAL* - 异常   - *ROLLBACK* - 回滚中   - *ABORTING* - 取消    |
| job_type | 是    | String  | job类型： - *CREATE_SERVER* - 创建镜像实例   - *CREATE_SERVER_IMAGE* - 构建镜像   - *DELETE_SERVER* - 删除镜像实例                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| offset   | 否    | Integer | 查询的偏移量，默认值0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| limit    | 否    | Integer | 查询的数量，值区间\[1-100\]，默认值10。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| job_id   | 否    | String  | 任务ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
#### 请求参数
表3请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                            |
|:---|:---|:---|:---|
| X-Auth-Token | 否    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数    | 参数类型                                                                                  | 描述                            |
|:---|:---|:---|
| count | Integer                                                                               | 总数。                           |
| items | Array of [ImageJobDetailInfo] objects | 任务明细信息列表，返回列表条目数量上限为分页的最大上限值。 |
   
 表5ImageJobDetailInfo 
| 参数                | 参数类型                                                                            | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| id                | String                                                                          | 子任务ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| job_type          | String                                                                          | job类型。 - *CREATE_SERVER* - 创建镜像实例   - *CREATE_SERVER_IMAGE* - 构建镜像   - *DELETE_SERVER* - 删除镜像实例                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| job_resource_info | [ImageJobResourceInfo] object | 任务结果对应的资源信息，根据任务类型区分： - *镜像实例* - 镜像实例信息   - *镜像* - 镜像信息                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| begin_time        | String                                                                          | 任务创建时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| end_time          | String                                                                          | 任务结束时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| status            | String                                                                          | job详情的状态 - *WAITING* - 等待   - *RUNNING* - 运行中   - *SUCCESS* - 成功   - *FAILED* - 失败   - *ABNORMAL* - 异常   - *ROLLBACK* - 回滚中   - *ABORTING* - 终止中    |
| job_execute_info  | [ImageJobExecuteInfo] object   | 任务执行失败信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| project_id        | String                                                                          | 项目ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| job_id            | String                                                                          | 任务ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
   
 表6ImageJobResourceInfo 
| 参数            | 参数类型   | 描述              |
|:---|:---|:---|
| resource_id   | String | 资源ID。           |
| resource_name | String | 产物名称，或者被操作资源名称。 |
   
 表7ImageJobExecuteInfo 
| 参数            | 参数类型   | 描述           |
|:---|:---|:---|
| error_code    | String | 任务执行失败时的错误码。 |
| error_message | String | 任务失败原因。      |
   
**状态码：400**
表8响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：401**
表9响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：403**
表10响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：404**
表11响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：405**
表12响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：500**
表13响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
**状态码：503**
表14响应Body参数 
| 参数         | 参数类型   | 描述         |
|:---|:---|:---|
| error_code | String | 错误码，失败时返回。 |
| error_msg  | String | 错误描述。      |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
成功响应。
```
{
  "count" : 0,
  "items" : [ {
    "id" : "1",
    "job_type" : "CREATE_SERVER",
    "job_resource_info" : {
      "resource_id" : "a1a1245-xxxx123d-1425af14",
      "resource_name" : "镜像测试"
    },
    "begin_time" : "2022-03-07T10:40:43.858Z",
    "end_time" : "2022-03-07T10:40:43.858Z",
    "status" : "WAITING",
    "job_execute_info" : {
      "error_code" : "WKS.00129901",
      "error_message" : "The service is now unavailable to process the request."
    },
    "project_id" : "325f2346-xxxx123d-1425af14",
    "job_id" : "1"
  } ]
}
```
#### 状态码
| 状态码 | 描述                      |
|:---|:---|
| 200 | 成功响应。                   |
| 400 | 由于包含语法错误，当前请求无法被服务器理解。  |
| 401 | 鉴权失败。                   |
| 403 | 没有操作权限。                 |
| 404 | 找不到资源。                  |
| 405 | 请求中指定的方法不被允许。           |
| 500 | 服务内部错误，具体返回错误码请参见错误码说明。 |
| 503 | 服务不可用。                  |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-workspace/ErrorCode_0.html)。
