Viewing a Job List

Function

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

URI

• URI format

  GET /v1/{project_id}/jobs?jobType={jobType}&offset={offset}&limit={limit}&jobName={jobName}

• 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.
  jobType	No	String	Job type. REAL_TIME: real-time processing BATCH: batch processing Default value: BATCH
  offset	No	Integer	Start page of the paging list. Default value: 0 The value must be greater than or equal to 0.
  limit	No	Integer	The maximum number of records on each page. Value range: 1 to 100 Default value: 10
  jobName	No	String	Job name.

Request

Response

Example

View a batch or real-time job list.

• Request

GET /v1/ff6b627b9d7b45b48f773be511c1a2b8/jobs?jobType=REAL_TIME

• Response

{
    "jobs": [
        {
            "createTime": 1551668561000,
            "createUser": "dlf_l00341563",
            "jobType": "REAL_TIME",
            "lastInstanceEndTime": 1551692047000,
            "lastInstanceStatus": "success",
            "name": "wangwei_stream",
            "startTime": 1551692037000
        },
        {
            "createTime": 1551109987000,
            "createUser": "dlf_l00341563",
            "jobType": "REAL_TIME",
            "lastInstanceEndTime": 1551112382000,
            "lastInstanceStatus": "success",
            "name": "job_1795",
            "startTime": 1551112367000
        }
    ],
    "total": 55
}

• Failure response

  HTTP status code 400

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