getWorkflowExecutions
- Print
- PDF
getWorkflowExecutions
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get the list of workflow executions.
GET https://dataflow.apigw.ntruss.com/api/v1/workflows/{workflowId}/executions
Request
Request parameter
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| workflowId | Yes | String | Workflow ID | |
| filter | No | String | Workflow name | |
| page | No | Number | Page | |
| limit | No | Number |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| list[].jobId | String | Task ID | |
| list[].jobName | String | Job name | |
| list[].jobExecutionId | String | Job execution ID | |
| list[].triggerId | String | Trigger ID | |
| list[].triggerName | String | Trigger name | |
| list[].status | String | Job status | |
| list[].jobCondition.workerType | String | Worker type | |
| list[].jobCondition.numWorker | Number | Number of workers | |
| list[].jobCondition.timeout | Number | Execution timeout | |
| list[].jobCondition.nrn | String | Policy NRN | |
| list[].jobCondition.scriptPath | String | Executable script storage path | |
| list[].jobCondition.logPath | String | Execution log storage path | |
| list[].waitingTime | Number | Job wait time | |
| list[].runningTime | Number | Task execution time | |
| list[].executorNum | Number | Number of job workers | |
| list[].parsedParameters | Object | Converted parameter | |
| list[].createdDate | String | Job creation date | |
| list[].startDate | String | Job execution date | |
| list[].endDate | String | Job execution end date | |
| count | Number | Total count | |
| page | Number | Page | |
| limit | Number | Maximum number per page |
Response status
| HTTP Status | Desc |
|---|---|
| 200 | OK (Successfully searched) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal 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?