Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

createJobExecution

Prev Next

VPC 환경에서 이용 가능합니다.

작업을 실행합니다. ## 요청 요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 URI
POST /api/v1/jobs/{jobId}/executions

요청 헤더

Data Flow API에서 공통으로 사용하는 헤더에 대한 정보는 Data Flow 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
jobId String Required 작업 아이디

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
triggerId String Optional 트리거 아이디
workflowId String Optional 워크플로 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
jobCondition Object Optional 작업 실행 옵션 정보
  • 생략 시 Job에 저장된 실행 설정 사용
jobCondition.numWorker Integer Optional 워커 수
  • 2~10
  • 신규 Job의 초기 설정값: 2
jobCondition.timeout Integer Optional 실행 타임아웃(분)
  • 작업을 한 번 실행할 때 작업 결과를 기다리는 시간
  • 1~1440
  • 신규 Job의 초기 설정값: 360
jobCondition.nrn String Optional 작업에 대한 네이버 클라우드 플랫폼 리소스 식별 값
jobCondition.scriptPath String Optional 작업 실행 스크립트 저장 경로
jobCondition.logPath String Optional 작업 실행 이력 저장 경로
parameters Object Optional 작업 실행 파라미터

요청 예시

요청 예시는 다음과 같습니다.

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": {
    "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"
  }
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
jobExecutionId String - 작업 실행 아이디
jobId String - 작업 아이디
jobCondition Object - 작업 실행 옵션 정보
jobCondition.numWorker Integer - 워커 수
  • 2~10
jobCondition.timeout Integer - 실행 타임아웃(분)
  • 1~1440
jobCondition.nrn String - 작업에 대한 네이버 클라우드 플랫폼 리소스 식별 값
jobCondition.scriptPath String - 작업 실행 스크립트 저장 경로
jobCondition.logPath String - 작업 실행 이력 저장 경로
status String - 마지막 작업 실행 상태
  • READY | RUNNING | COMPLETED | FAILED | CANCELED
    • READY: 대기 중
    • RUNNING: 실행 중
    • COMPLETED: 완료
    • FAILED: 실패
    • CANCELED: 취소
startDate String - 작업 실행 일시
  • ISO 8601 형식(UTC+9 포함)
createdDate String - 작업 생성 일시
  • ISO 8601 형식(UTC+9 포함)
runningTime Integer - 작업 실행 시간(분)
parsedParameters Object - 파싱된 작업 실행 파라미터
type String - 작업 유형
  • JOB (기본값)

응답 상태 코드

Data Flow API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Data Flow 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "jobExecutionId" : "p4Y5Pk******",
  "jobId" : "gqigvH******",
  "jobCondition" : {
    "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"
}