getJobs

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in VPC

Get the list of jobs.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
GET	/api/v1/jobs

Request headers

For information about the headers common to all Data Flow APIs, see Data Flow request headers.

Request query parameters

You can use the following query parameters with your request:

Field	Type	Required	Description
`name`	String	Optional	Job name
`status`	String	Optional	Job status `RUNNABLE` \| `RUNNING` \| `DELETED` \| `UNKNOWN` \| `DRAFT` \| `STOPPED` \| `EDITING` `RUNNABLE`: job execution available `RUNNING`: job execution in progress `DELETED`: job being deleted or deletion completed `UNKNOWN`: other `DRAFT`: job edit incomplete `STOPPED`: job being stopped `EDITING`: job being edited (validation required)
`page`	Integer	Optional	Page number 0-N (default: 0)
`limit`	Integer	Optional	Page output count 0-N (default: 1000)

Request example

The request example is as follows:

curl --location --request GET 'https://dataflow.apigw.ntruss.com/api/v1/jobs?page=0&limit=1000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`list`	Array	-	Job list: list
`count`	Integer	-	Number of response results
`page`	Integer	-	Page number
`limit`	Integer	-	Page output count

`list`

The following describes list.

Field	Type	Required	Description
`jobId`	String	-	Job ID
`name`	String	-	Job name
`type`	String	-	Job type `DATAFLOW` (default)
`status`	String	-	Job status `RUNNABLE` \| `RUNNING` \| `DELETED`\| `DRAFT` \| `EDITING`\| `STOPPED` `RUNNABLE`: executable `RUNNING`: running `DELETED`: being deleted or deletion completed `DRAFT`: edit incomplete `EDITING`: being edited (validation required) `STOPPED`: being stopped or stopped
`lastExecutionStatus`	String	-	Last job execution status `COMPLETED` \| `FAILED` \| `CANCELED` `COMPLETED`: completed `FAILED`: failed `CANCELED`: canceled
`createdDate`	String	-	Job creation date and time ISO 8601 format (including UTC+9)
`updatedDate`	String	-	Job modification date and time ISO 8601 format (including UTC+9)
`lastExecutionDate`	String	-	Last job execution date and time ISO 8601 format (including UTC+9)
`resourceId`	String	-	Resource ID Same as the job ID (`jobId`)
`disabled`	Boolean	-	Resource query permission status

Response status codes

For response status codes common to all Data Flow APIs, see Data Flow response status codes.

Response example

The response example is as follows:

{
    "list": [
        {
            "jobId": "fAjvc*******",
            "name": "job002",
            "type": "DATAFLOW",
            "status": "RUNNABLE",
            "lastExecutionStatus": "COMPLETED",
            "createdDate": "2025-03-20T08:54:03+09:00",
            "updatedDate": "2025-03-20T14:01:23+09:00",
            "lastExecutionDate": "2025-03-20T14:00:09+09:00",
            "resourceId": "fAjvc*******",
            "disabled": false
        },
        {
            "jobId": "gqigvH******",
            "name": "job001",
            "type": "DATAFLOW",
            "status": "RUNNABLE",
            "lastExecutionStatus": "COMPLETED",
            "createdDate": "2025-03-19T15:03:42+09:00",
            "updatedDate": "2025-03-20T13:07:34+09:00",
            "lastExecutionDate": "2025-03-20T13:06:05+09:00",
            "resourceId": "gqigvH******",
            "disabled": false
        }
    ],
    "count": 2,
    "page": 0,
    "limit": 1000
}

Documentation Index