Data Flow 개요

Prev Next

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

Data Flow는 대규모의 데이터를 추출, 변환, 적재하기 위한 복잡한 워크플로를 구성하고 실행하며, 모니터링할 수 있는 네이버 클라우드 플랫폼의 완전 관리형 데이터 통합 서비스입니다. Data Flow 서비스에서는 Workflow, Job, Trigger 기능에 대한 API를 RESTful 형태로 제공합니다.

Data Flow 공통 설정

Data Flow API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.

요청

공통 요청 형식을 설명합니다.

API URL

요청 API URL은 다음과 같습니다.

https://dataflow.apigw.ntruss.com

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
x-ncp-apigw-timestamp Required 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
  • API Gateway 서버와 5분 이상 시간 차 발생 시 유효하지 않은 요청으로 간주
  • Unix Timestamp 형식
x-ncp-iam-access-key Required 네이버 클라우드 플랫폼에서 발급받은 Access Key
x-ncp-apigw-signature-v2 Required 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명

응답

공통 응답 형식을 설명합니다.

응답 바디

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

ErrorResponse
ErrorResponse는 API 호출 실패 정보를 정의합니다. ErrorResponse에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
error Object - 오류 코드 및 메시지
error.errorCode String Required 오류 코드
error.message String Required 오류 메시지
error.details String Required 오류 메시지 상세 설명

응답 상태 코드

응답 상태 코드에 대한 설명은 다음과 같습니다.

HTTP 상태 코드 코드 메시지 설명 해결 방법
200 - OK 요청 처리 성공 -
201 - Created 생성 완료 -
202 - Request is accepted but not completed yet. 요청은 수락되었으나 아직 완료되지 않음 -
204 - No Content 요청 처리 성공, 콘텐츠를 반환하지 않음 -
400 - Bad Request 잘못된 요청 요청 구문 확인
400 - bad-parameter 요청 파라미터 오류 요청 값 확인
400 - bad-state 요청 상태 오류 요청 대상의 상태 확인
400 - client-request-failed 연동 서비스의 요청 오류 연동 서비스 확인
400 - client-resource-not-found 연동 서비스의 리소스 오류 연동 서비스 리소스 확인
400 - client-unauthorized 연동 서비스의 권한 오류 연동 서비스 권한 확인
400 - No valid member exists of given member number. 잘못된 요청 요청 파라미터, 헤더 재확인
401 - Unauthorized 인증 실패 작업의 생성자와 요청자의 권한 확인
403 - Forbidden 서버 작업 거부 요청 기능에 대한 사용 권한 소유 여부 확인
404 - resource-not-found 요청 리소스 아이디 오류 요청 대상 확인
500 - unknown-resource-action 작업 실행 오류 네이버 클라우드 플랫폼 포털의 문의하기로 문의
500 - Internal Server Error 서버 내부 오류 잠시 후 다시 시도
참고

네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.

응답 예시

호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.

{
    "error": {
        "errorCode": "200",
        "message": "Authentication Failed",
        "details": "Invalid authentication information."
    }
}

Data Flow API

Data Flow 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.

Dashboard

Dashboard 관련 API에 대한 설명은 다음과 같습니다.

API 설명
getExecutionInterval 작업의 실행 수 조회
getExecutionResult 작업의 실행 수, 성공 수, 실패 수 조회
getExecutionTimes 작업의 실행 시간 조회

Workflow

워크플로 관련 API에 대한 설명은 다음과 같습니다.

API 설명
createWorkflow 워크플로 생성
getWorkflows 워크플로 목록 조회
getWorkflowById 워크플로 상세 정보 조회
getWorkflowExecutions 워크플로 실행 목록 조회
updateWorkflow 워크플로 수정
deleteWorkflow 워크플로 삭제

Job

작업 관련 API에 대한 설명은 다음과 같습니다.

API 설명
createJob 작업 생성
getJobs 작업 목록 조회
getJobById 작업 상세 정보 조회
updateJob 작업 수정
verifyJob 작업 실행 요청 항목 검증
executeJob 작업 실행
getJobExecutions 작업 실행 목록 조회
getJobExecutionById 작업 실행 상세 정보 조회
updateJobExecuteConfig 작업 실행 옵션 수정
deleteJob 작업 삭제

Trigger

트리거 관련 API에 대한 설명은 다음과 같습니다.

API 설명
createTrigger 트리거 생성
getTriggers 트리거 목록 조회
getTriggerById 트리거 단건 상세 조회
deleteTrigger 트리거 삭제

Data Flow 연관 리소스

Data Flow API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.