Updated on 2022-09-15 GMT+08:00

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

Table 1 Request header parameter

Parameter

Mandatory

Type

Description

workspace

No

String

Workspace ID.

  • If this parameter is not set, data in the default workspace is queried by default.
  • To query data in other workspaces, this header must be carried.

Response

Table 2 Response parameters

Parameter

Mandatory

Type

Description

total

Yes

Integer

Number of jobs.

jobs

Yes

List<Job>

Job list. For details, see Table 3.

Table 3 Job data structure description

Parameter

Mandatory

Type

Description

name

Yes

String

Job name.

jobType

Yes

String

Job type.

  • REAL_TIME: real-time processing
  • BATCH: batch processing

status

Yes

String

Job status.

When jobType is set to REAL_TIME, the status is as follows:

  • STARTING
  • NORMAL
  • EXCEPTION
  • STOPPING
  • STOPPED

When jobType is set to BATCH, the status is as follows:

  • SCHEDULING
  • STOPPED
  • PAUSED

createUser

Yes

String

Job creator.

createTime

Yes

Long

Time when the job is created.

startTime

No

Long

Time when the job starts to run.

endTime

No

Long

Time when the job stops to run.

lastInstanceStatus

No

String

Most recent running status of the job instance. This parameter is available only when jobType is set to BATCH.

lastInstanceEndTime

No

Long

Time when the most recent job instance stops to run. This parameter is available only when jobType is set to BATCH.

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