executeJob
- Print
- PDF
executeJob
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Run the task.
POST https://dataflow.apigw.ntruss.com/api/v1/jobs/{jobId}/executions
Request
Request parameter
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| jobId | Yes | String | Task ID | |
| workflowId | No | String | Workflow ID | |
| triggerId | No | String | Trigger ID |
Request body
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| jobCondition.workerType | No | String | DEFAULT | Worker type |
| jobCondition.numWorker | No | Number | 2 - 10 | Number of workers |
| jobCondition.timeout | No | Number | Default: 360 minutes, maximum: 1440 minutes (24 hours) | Execution timeout |
| jobCondition.nrn | Yes | String | Policy NRN | |
| jobCondition.scriptPath | Yes | String | Executable script storage path | |
| jobCondition.logPath | Yes | String | Execution log storage path | |
| parameters | No | Object | Execution parameters |
Response
| Field name | Type | Description | Remarks |
|---|---|---|---|
| jobId | String | Task ID | |
| jobExecutionId | String | Job execution ID | |
| status | String | Job status | |
| jobCondition.workerType | String | Worker type | |
| jobCondition.numWorker | Number | Number of workers | |
| jobCondition.timeout | Number | Execution timeout | |
| jobCondition.nrn | String | Policy NRN | |
| jobCondition.scriptPath | String | Executable script storage path | |
| jobCondition.logPath | String | Execution log storage path | |
| createdDate | String | Job creation date |
Response status
| HTTP Status | Desc |
|---|---|
| 200 | OK (execution completed) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Examples
Request example
POST /api/v1/jobs/5Yns7JgRt25f/executions
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}
{
"jobCondition": {
"workerType": "DEFAULT",
"numWorker": 2,
"timeout": 360,
"nrn": "nrn:PUB:IAM::0000:Role/000000-b123-11aa-b1b1-053256a72429",
"scriptPath": "dataflow-172686404/scripts/",
"logPath": "dataflow-172686404/sparkHistoryLogs/"
},
"parameters": {
"$table_name": "test.sample_table2"
}
}
Response example
{
"jobExecutionId": "4Yz7GaZjhqBq",
"jobId": "5Yns7JgRt25f",
"jobCondition": {
"workerType": "DEFAULT",
"numWorker": 2,
"timeout": 360,
"nrn": "nrn:PUB:IAM::0000:Role/000000-b123-11aa-b1b1-053256a72429",
"scriptPath": "dataflow-172686404/scripts/",
"logPath": "dataflow-172686404/sparkHistoryLogs/"
},
"status": "READY",
"createdDate": "2023-10-23T12:25:24.459"
}
Was this article helpful?