executeJob

Prev Next

Available in VPC

Run the task.

Request

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

Method URI
POST /api/v1/jobs/{jobId}/executions

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
jobId String Required Job ID

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
triggerId String Optional Trigger ID
workflowId String Optional Workflow ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
jobCondition Object Required Job execution option information
jobCondition.workerType String Optional Worker type
  • DATAFLOW (default)
jobCondition.numWorker Integer Optional Number of workers
  • 2 (default)
jobCondition.timeout Integer Optional Execution timeout (minute)
  • Time spent waiting for the results of a job when it is executed once
  • 0-1440 (default: 360)
jobCondition.nrn String Required NAVER Cloud Platform resource identification value for job
jobCondition.scriptPath String Required Job execution script storage path
jobCondition.logPath String Required Job execution history storage path
parameters Object Optional Job execution parameter

Request example

The request example is as follows:

curl --location --request POST 'https://dataflow.apigw.ntruss.com/api/v1/jobs/gqigvH******/executions' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "jobCondition": {
    "workerType": "DEFAULT",
    "numWorker": 2,
    "timeout": 360,
    "nrn": "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
    "scriptPath": "dataflow-2706412-****/scripts/",
    "logPath": "dataflow-2706412-****/sparkHistoryLogs/"
  },
  "parameters": {
    "$table_name": "test.sample_table2"
  }
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
jobExecutionId String - Job execution ID
jobId String - Job ID
jobCondition Object - Job execution option information
jobCondition.workerType String - Worker type
  • DATAFLOW (default)
jobCondition.numWorker Integer - Number of workers
  • 2 (default)
jobCondition.timeout Integer - Execution timeout (minute)
  • Time spent waiting for the results of a job when it is executed once
  • 0-1440 (default: 360)
jobCondition.nrn String - NAVER Cloud Platform resource identification value for job
jobCondition.scriptPath String - Job execution script storage path
jobCondition.logPath String - Job execution history storage path
status String - Last job execution status
  • READY | RUNNING | COMPLETED | FAILED | CANCELED
    • READY: pending
    • RUNNING: running
    • COMPLETED: completed
    • FAILED: failed
    • CANCELED: canceled
startDate String - Job execution date and time
  • ISO 8601 format (including UTC+9)
createdDate String - Job creation date and time
  • ISO 8601 format (including UTC+9)
runningTime Integer - Job execution time (minute)
parsedParameters Object - Parsed job execution parameter
type String - Job type
  • JOB (default)

Response status codes

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

Response example

The response example is as follows:

{
  "jobExecutionId" : "p4Y5Pk******",
  "jobId" : "gqigvH******",
  "jobCondition" : {
    "workerType" : "DEFAULT",
    "numWorker" : 2,
    "timeout" : 360,
    "nrn" : "nrn:PUB:IAM::*******:Role/********-0496-11f0-baf6-246e96591a38",
    "scriptPath" : "dataflow-2706412-****/scripts/",
    "logPath" : "dataflow-2706412-****/sparkHistoryLogs/"
  },
  "status" : "READY",
  "startDate" : "2025-03-20T17:27:17+09:00",
  "createdDate" : "2025-03-20T17:27:17+09:00",
  "runningTime" : 0,
  "parsedParameters" : [ ],
  "type" : "JOB"
}