# 查询作业列表 - ListJobs
#### 功能介绍
查询批处理或实时作业列表，每次查询返回的作业数量上限是1000。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DGC/doc?api=ListJobs)中调试该接口，支持自动认证鉴权。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
- URI格式 GET /v1/{project_id}/jobs
  

- 参数说明
  
  | 参数名        | 是否必选 | 参数类型   | 说明                                                                                                    |
  |:---|:---|:---|:---|
  | project_id | 是    | String | 项目编号，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 |
     
  表1Query参数 
  | 参数      | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                 |
  |:---|:---|:---|:---|
  | limit   | 否    | Integer | 分页返回结果，指定每页最大记录数。范围\[1,1000\] 默认值：10                                                                                                                                                                                                                     |
  | offset  | 否    | Integer | 分页列表的页数，默认值为0。取值范围大于等于0。                                                                                                                                                                                                                                                                           |
  | jobType | 否    | String  | 作业类型： - REAL_TIME：实时处理  - BATCH：批处理   默认值：BATCH |
  | jobName | 否    | String  | 作业名称                                                                                                                                                                                                                                                                                               |
  | tags    | 否    | String  | 作业标签列表，如果有多个标签，以英文逗号分隔。例如：tag1,tag2,tag3。                                                                                                                                                                                                                                                          |
     
  
 
#### 请求参数
表2请求Header参数 
| 参数名       | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| workspace | 否    | String | 工作空间id。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 - 如果不设置该参数，默认查询default工作空间下的数据。  - 如果需要查询其他工作空间的数据，需要带上该消息头。 说明： - 多个DataArts Studio实例需要指定工作空间。  - 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。      |
   
#### 响应参数
表3参数说明 
| 参数名   | 是否必选 | 参数类型        | 说明                                                                               |
|:---|:---|:---|:---|
| total | 是    | Integer     | 作业数量。                                                                            |
| jobs  | 是    | List\<Job\> | 作业列表，参考[表4]。 |
   
 表4Job数据结构说明 
| 参数名                 | 是否必选 | 参数类型    | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| name                | 是    | String  | 作业名称。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| jobType             | 是    | String  | 作业类型。 - REAL_TIME：实时处理  - BATCH ：批处理                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| owner               | 否    | String  | 作业责任人，长度不能超过128个字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| priority            | 否    | int     | 作业优先级，取值范围\[0, 2\]，默认值是0。0代表高优先级，1代表中优先级，2代表低优先级。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| status              | 是    | String  | 作业状态。 当jobType为REAL_TIME时，有如下状态： - STARTING： 启动中  - NORMAL ：运行中  - EXCEPTION：启动或停止异常  - STOPPING ：停止中  - STOPPED： 已停止   当jobType为BATCH时，有如下状态： - SCHEDULING ：调度中  - STOPPED ：已停止调度  - PAUSED： 暂停调度   |
| createUser          | 是    | String  | 作业的创建者。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| createTime          | 是    | Long    | 作业的创建时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| startTime           | 否    | Long    | 作业的启动时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| endTime             | 否    | Long    | 作业配置的结束时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| lastInstanceStatus  | 否    | String  | 作业最近一次运行实例状态，当jobType为BATCH时才有本字段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| lastInstanceEndTime | 否    | Long    | 作业最近一次运行实例运行结束时间，当jobType为BATCH时才有本字段。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| lastUpdateTime      | 否    | Long    | 作业最后一次更新时间。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| lastUpdateUser      | 否    | String  | 作业最后一次更新用户。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| path                | 否    | String  | 作业的路径。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| singleNodeJobFlag   | 否    | boolean | 作业是否为单任务作业。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   
#### 请求示例
查询作业列表。
```
GET /v1/ff6b627b9d7b45b48f773be511c1a2b8/jobs
```
#### 响应示例
- 成功响应
  ```
  {
      "jobs": [
          {
              "createTime": 1680783636000,
              "createUser": "test_user",
              "jobType": "BATCH",
              "lastInstanceEndTime": 1682519407000,
              "lastInstanceStatus": "success",
              "lastUpdateUser": "test_user",
              "name": "myJob",
              "owner": "test_user",
              "path": "/",
              "priority": 0,
              "singleNodeJobFlag": false,
              "status": "SCHEDULING"
          }
      ],
      "total": 1
  }
  ```
  
- 失败响应 HTTP状态码 400
  ```
  {
      "error_code":"DLF.3051",
      "error_msg":"The request parameter is invalid."
  }
  ```