Data Flow 개요
- 인쇄
- PDF
Data Flow 개요
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Data Flow는 네이버 클라우드 플랫폼의 API Gateway를 통해 API를 제공합니다.
API 인증을 위해서 Access Key, Secret Key가 필요하며
API Key 생성 및 사용 방법은 API Gateway 사용 가이드 > API 호출하기를 참조해 주십시오.
Access Key와 Secret Key에 관해서는 공통 가이드 > API 개요를 참조해 주십시오.
Data Flow는 다양한 API를 제공하고 있으며 Swagger 페이지를 통해 API 스펙을 확인하고 간단한 테스트를 수행할 수 있습니다. Data Flow의 Swagger 문서는 아래 내용을 참고해 주십시오.
- 네이버 클라우드 플랫폼의 콘솔에 접속해 주십시오.
- Services > API Gateway 메뉴를 차례대로 클릭해 주십시오.
- Published APIs > Data Flow > Catalog를 차례대로 클릭해 주십시오.
- Data Flow 클릭 후 아래에 있는 API 설명서를 클릭해 주십시오.
이때 노출되는 화면이 AiTEMS의 Swagger 페이지이며 페이지 가장 위에 표시되어 있는 링크(https://dataflow.apigw.ntruss.com/api/v1
)가 AiTEMS의 API 주소입니다.
공통 설정
Data Flow API URL
https://dataflow.apigw.ntruss.com/api/v1
요청 헤더
헤더명 | 설명 |
---|---|
x-ncp-apigw-timestamp | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타내며 API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주x-ncp-apigw-timestamp:{Timestamp} |
x-ncp-iam-access-key | 네이버 클라우드 플랫폼 포털에서 발급받은 Access Key ID 값x-ncp-iam-access-key:{Sub Account Access Key} |
x-ncp-apigw-signature-v2 | Access Key ID 값과 Secret Key로 암호화한 서명x-ncp-apigw-signature-v2:{API Gateway Signature} |
Content-Type | Request body content type을 application/json으로 지정Content-Type: application/json |
오퍼레이션
Dashboard
API명 | 설명 |
---|---|
getExecutionResult | 총 작업 실행 수, 성공 및 실패 수 조회 |
getExecutionCount | 해당 기간 동안 작업 실행 수 조회 |
getExecutionTimes | 해당 기간 동안 작업 실행 시간 조회 |
Workflow
API명 | 설명 |
---|---|
getWorkflows | 워크플로 목록 조회 |
getWorkflowById | 워크플로 조회 |
createWorkflow | 워크플로 생성 |
updateWorkflow | 워크플로 수정 |
deleteWorkflow | 워크플로 삭제 |
getWorkflowExecutions | 워크플로 실행 목록 조회 |
Job
API명 | 설명 |
---|---|
getJobs | 작업 목록 조회 |
getJobById | 작업 조회 |
createJob | 작업 생성 |
updateJob | 작업 수정 |
deleteJob | 작업 삭제 |
verifyJob | 작업 요청 항목 검증 |
executeJob | 작업 실행 |
getJobExecutions | 작업 실행 목록 조회 |
getJobExecutionById | 작업 실행 상세 조회 |
updateJobExecuteConfig | 작업 실행 설정 수정 |
Trigger
API명 | 설명 |
---|---|
getTriggers | 트리거 목록 조회 |
getTriggerById | 트리거 조회 |
createTrigger | 트리거 생성 |
deleteTrigger | 트리거 삭제 |
에러 응답 형식
API 요청이 잘못되었거나 처리 도중 오류가 발생하면 HTTP 상태 코드로 성공/실패를 반환하고 JSON 형식으로 상세 메시지를 반환합니다.
응답 예시
{
"type": "about:blank",
"title": "Not Found",
"status": 404,
"detail": "{workflowId=aa}: 찾을 수 없습니다.",
"instance": "/dataflow/api/workflows/aa",
"errorType": "resource-not-found/WORKFLOW"
}
에러 응답
HTTP 상태 코드 | 에러 타입 | 메시지 | 설명 | 해결 방안 |
---|---|---|---|---|
400 | bad-parameter | 파라미터를 확인해 주세요. | 요청 파라미터 오류 | 요청 값 재확인 |
400 | bad-state | 상태를 확인해 주세요. | 요청 상태 오류 | 요청 대상의 상태 재확인 |
404 | resource-not-found/ | 항목을 찾을 수 없습니다. | 요청 리소스 ID 오류 | 요청 대상 재확인 |
400 | client-request-failed | 요청이 실패하였습니다. | 연동 상품의 요청 오류 | 연동 상품 확인 |
400 | client-resource-not-found | 리소스를 찾을 수 없습니다. | 연동 상품의 리소스 오류 | 연동 상품 리소스 확인 |
400 | client-unauthorized | 권한이 없습니다. | 연동 상품의 권한 오류 | 연동 상품 권한 확인 |
500 | unknown-resource-action/ | 예기치 않은 오류가 발생하였습니다. | 작업 실행 오류 | 고객 지원 > 문의하기로 문의 |
이 문서가 도움이 되었습니까?