getWorkflowExecutions
    • PDF

    getWorkflowExecutions

    • PDF

    Article summary

    Get the list of workflow executions.

    GET https://dataflow.apigw.ntruss.com/api/v1/workflows/{workflowId}/executions
    

    Request

    Request parameter

    Parameter nameRequiredTypeRestrictionsDescription
    workflowIdYesStringWorkflow ID
    filterNoStringWorkflow name
    pageNoNumberPage
    limitNoNumber

    Response

    Field nameTypeDescriptionRemarks
    list[].jobIdStringTask ID
    list[].jobNameStringJob name
    list[].jobExecutionIdStringJob execution ID
    list[].triggerIdStringTrigger ID
    list[].triggerNameStringTrigger name
    list[].statusStringJob status
    list[].jobCondition.workerTypeStringWorker type
    list[].jobCondition.numWorkerNumberNumber of workers
    list[].jobCondition.timeoutNumberExecution timeout
    list[].jobCondition.nrnStringPolicy NRN
    list[].jobCondition.scriptPathStringExecutable script storage path
    list[].jobCondition.logPathStringExecution log storage path
    list[].waitingTimeNumberJob wait time
    list[].runningTimeNumberTask execution time
    list[].executorNumNumberNumber of job workers
    list[].parsedParametersObjectConverted parameter
    list[].createdDateStringJob creation date
    list[].startDateStringJob execution date
    list[].endDateStringJob execution end date
    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/workflows/aetZc1voJw7Q/executions?page=0&limit=4
    
    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}
    
    

    Response example

    {
      "list": [
        {
        "jobExecutionId": "4Yz7GaZjhqBq",
        "jobId": "5Yns7JgRt25f",
        "jobName": "dataflow1",
        "triggerId": "T63391JxQHNj",
        "triggerName": "trigger1",
        "jobCondition": {
            "workerType": "DEFAULT",
            "numWorker": 2,
            "numRetry": 3,
            "timeout": 2880,
            "parameters": {},
            "nrn": "",
            "scriptPath": "dataflow-172686404/scripts/",
            "logPath": "dataflow-172686404/sparkHistoryLogs/"
        },
        "retryNum" : 0,
        "waitingTime" : 21,
        "executorNum" : 2,
        "runningTime" : 44,
        "status": "COMPLETED",
        "startDate": "2023-10-05T16:18:35.000",
        "endDate": "2023-10-05T16:19:14.000",
        "createdDate": "2023-10-05T16:18:30.000",
        }
      ],
      "count": 1,
      "page": 0,
      "limit": 1
    }
    

    Was this article helpful?

    What's Next
    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.