查询作业列表 - ListJobs

功能介绍

查询批处理或实时作业列表，每次查询返回的作业数量上限是1000。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

• 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
• 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

• URI格式

  GET /v1/{project_id}/jobs

• 参数说明

  参数名	是否必选	参数类型	说明
  project_id	是	String	项目编号，获取方法请参见项目ID和账号ID。

  表1 Query参数

  参数	是否必选	参数类型	描述
  limit	否	Integer	分页返回结果，指定每页最大记录数。范围[1,1000] 默认值：10
  offset	否	Integer	分页列表的页数，默认值为0。取值范围大于等于0。
  jobType	否	String	作业类型： REAL_TIME：实时处理 BATCH：批处理 默认值：BATCH
  jobName	否	String	作业名称
  tags	否	String	作业标签列表，如果有多个标签，以英文逗号分隔。例如：tag1,tag2,tag3。

请求参数

响应参数

请求示例

查询作业列表。

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."
  }