MENU
      getJobs

        getJobs


        Article summary

        Get the list of jobs.

        GET https://dataflow.apigw.ntruss.com/api/v1/jobs?page={page}&limit={limit}
        HTTP

        Request

        Request parameter

        Parameter nameRequiredTypeRestrictionsDescription
        nameNoStringJob name
        statusNoStringRUNNABLE, RUNNING, DELETED, UNKNOWN, DRAFT, STOPPED, EDITINGJob status
        pageNoNumberPage
        limitNoNumberMaximum number per page

        Response

        Field nameTypeDescriptionRemarks
        list[].jobIdStringTask ID
        list[].nameStringJob name
        list[].typeStringJob type
        list[].statusStringJob status
        list[].lastExecutionStatusStringLast execution status
        list[].createdDateStringJob creation date
        list[].updatedDateStringLast update
        list[].lastExecutionDateStringLast execution date
        list[].resourceIdStringResource ID (same as the job ID)
        list[].disabledBooleanWhether you have permission to view the resource
        countNumberTotal count
        pageNumberPage
        limitNumberMaximum number per page

        Response status

        HTTP StatusDesc
        200OK (Successfully searched)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Examples

        Request example

        GET /api/v1/jobs?page=0&limit=1000
        
        Host: dataflow.apigw.ntruss.com
        x-ncp-iam-access-key: {Access key}
        x-ncp-apigw-signature-v2: {API GW signature}
        x-ncp-apigw-timestamp: {timestamp}
        HTTP

        Response example

        {
          "list": [
            {
              "jobId": "5Yns7JgRt25f",
              "name": "data-flow",
              "type": "DATAFLOW",
              "status": "RUNNABLE",
              "lastExecutionStatus": "COMPLETED",
              "createdDate": "2023-10-20T13:45:15.000",
              "updatedDate": "2023-10-20T13:46:56.000",
              "lastExecutionStatus": "2023-10-20T13:46:56.000",
              "resourceId": "5Yns7JgRt25f",
              "disabled": false
            },
            {
              "jobId": "qOxHK8QR61ZB",
              "name": "test",
              "description": "",
              "type": "DATAFLOW",
              "status": "RUNNABLE",
              "lastExecutionStatus": "COMPLETED",
              "createdDate": "2023-09-18T17:45:03.000",
              "updatedDate": "2023-10-20T14:20:19.000",
              "lastExecutionStatus": "2023-10-20T13:46:56.000",
              "resourceId": "qOxHK8QR61ZB",
              "disabled": false
            }
          ],
          "count": 2,
          "page": 0,
          "limit": 1000
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.