Viewing a Job List

Function

This API is used to query a list of batch or real-time jobs. A maximum of 1,000 jobs can be returned for each query.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

• If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
• If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

• URI format

  GET /v1/{project_id}/jobs

• Parameter description

  Parameter	Mandatory	Type	Description
  project_id	Yes	String	Project ID. For details about how to obtain a project ID, see Project ID and Account ID.

  Table 1 Query parameters

  Parameter	Mandatory	Type	Description
  limit	No	Integer	Maximum number of records on each page The parameter value ranges from 1 to 1,000. Default value: 10
  offset	No	Integer	Page number of the pagination list. The default value is 0. The value must be greater than or equal to 0.
  jobType	No	String	Job type REAL_TIME: real-time processing BATCH: batch processing Default value: BATCH
  jobName	No	String	Job name.
  tags	No	String	List of job tags. Separate multiple tags with commas (,), for example, tag1,tag2,tag3.

Request Parameters

Response Parameters

Example Request

Query the job list.

GET /v1/ff6b627b9d7b45b48f773be511c1a2b8/jobs

Example Response

• Success response

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

• Failure response

  HTTP status code 400

  {
      "error_code":"DLF.3051",
      "error_msg":"The request parameter is invalid."
  }