
# 查询批量处理作业列表 - ListBatchJob
#### 功能介绍
查询批量处理作业列表
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/IEF/doc?api=ListBatchJob)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ief/ief_02_1003.html)。
#### URI
GET /v2/{project_id}/productmgr/jobs
表1路径参数 
| 参数         | 是否必选 | 参数类型   | 描述   |
|:---|:---|:---|:---|
| project_id | 是    | String | 项目ID |
表2Query参数 
| 参数       | 是否必选 | 参数类型    | 描述                                                                                       |
|:---|:---|:---|:---|
| job_type | 否    | String  | 批量处理作业类型，支持以下选项： - node_upgrade： 节点升级 - deployment_deploy：应用部署 - deployment_upgrade：应用升级 |
| limit    | 否    | Integer | 查询返回记录的数量限制                                                                              |
| offset   | 否    | Integer | 偏移量，表示查询该偏移量后面的记录                                                                        |
| sort     | 否    | String  | 查询结果排序，如按照创建时间降序排序为created_at:desc，升序排序为created_at:asc                                   |
#### 请求参数
表3请求Header参数 
| 参数              | 是否必选 | 参数类型   | 描述                                                        |
|:---|:---|:---|:---|
| X-Auth-Token    | 是    | String | 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
| ief-instance-id | 否    | String | 企业版实例ID，专业版实例为空值。                                         |
| Content-Type    | 是    | String | 消息体的类型（格式），默认取值为"application/json"。                       |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数        | 参数类型                                                                        | 描述       |
|:---|:---|:---|
| job_count | Integer                                                                     | 数目       |
| jobs      | Array of [BatchJobForList] objects | 批量处理作业详情 |
   
 表5BatchJobForList 
| 参数                     | 参数类型    | 描述                                                                                                                                             |
|:---|:---|:---|
| job_id                 | String  | 批量处理作业ID                                                                                                                                       |
| job_name               | String  | 批量处理作业名称                                                                                                                                       |
| job_type               | String  | 批量处理作业类型，支持以下选项： - node_upgrade： 节点升级 - deployment_deploy：应用部署 - deployment_upgrade：应用升级                                                       |
| created_at             | Integer | 创建时间戳                                                                                                                                          |
| status                 | String  | 执行状态，支持 - Running：运行中 - Successful：运行成功 - Partially_successful：部分运行成功 - Failed：运行失败 - Stopping：已暂停 - Stopped：已终止 - Waiting：等待中 - Timed_out：已超时 |
| task_total_count       | Integer | 任务总数                                                                                                                                           |
| task_success_count     | Integer | 任务项执行成功数                                                                                                                                       |
| task_failed_count      | Integer | 任务项执行失败数                                                                                                                                       |
| status_last_updated_at | Integer | 状态更新时间戳                                                                                                                                        |
| description            | String  | 任务描述                                                                                                                                           |
   
#### 请求示例
无
#### 响应示例
**状态码：200**
查询成功
```
{
  "job_count" : 2,
  "jobs" : [ {
    "job_name" : "aaa",
    "job_type" : "deployment_deploy",
    "job_id" : "66273c66-f72e-4607-8769-3663d255fb83",
    "status" : "Successful",
    "created_at" : 1667218308,
    "status_last_updated_at" : 1667218329,
    "task_total_count" : 2,
    "task_failed_count" : 0,
    "task_success_count" : 2,
    "description" : ""
  }, {
    "job_name" : "test0929-pm",
    "job_type" : "deployment_deploy",
    "job_id" : "0a95c8df-eab5-4a8b-a63b-df9f208ad0ce",
    "status" : "Successful",
    "created_at" : 1664444410,
    "status_last_updated_at" : 1664444411,
    "task_total_count" : 1,
    "task_failed_count" : 0,
    "task_success_count" : 1,
    "description" : ""
  } ]
}
```
#### 状态码
| 状态码 | 描述   |
|:---|:---|
| 200 | 查询成功 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-ief/ErrorCode.html)。
