VPC 환경에서 이용 가능합니다.
Data Box Frame은 분석자가 고객 데이터를 자유롭게 분석하고 데이터 관리자는 데이터 임의 반출을 제한할 수 있도록 지원하는 네이버 클라우드 플랫폼의 분석 환경 구축 서비스입니다. Data Box Frame 서비스에서는 박스 프레임과 데이터 박스 생성, 데이터 반입 및 반출에 대한 심사를 수행하는 API를 RESTful 형태로 제공합니다.
2025년 10월 23일 이후 Data Box Frame의 신규 이용 신청 및 각 Box별 분석 환경 추가/변경 기능이 제공되지 않을 예정입니다. 관련 내용은 공지사항에서 확인할 수 있습니다.
Data Box Frame 공통 설정
Data Box Frame API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://databoxframe.apigw.ntruss.com
요청 헤더
요청 헤더에 대한 설명은 다음과 같습니다.
헤더명 | 필수 여부 | 설명 |
---|---|---|
x-ncp-apigw-timestamp |
Required | 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간(밀리초)
|
x-ncp-iam-access-key |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key |
x-ncp-apigw-signature-v2 |
Required | 네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 |
x-ncp-lang |
Optional | 응답 데이터의 다국어 처리
|
서브 계정에서 버킷 관련 Data Box Frame API를 호출하는 경우, 서브 계정에 Object Storage 서비스에 대한 권한이 필요할 수 있습니다.
응답
공통 응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
error
error는 API 호출 실패 정보를 정의합니다. error에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
error |
Object | - | 오류 코드 및 메시지 |
error.errorCode |
String | Required | 오류 코드 |
error.message |
String | Required | 오류 메시지 |
error.details |
String | Required | 오류 메시지 상세 설명 |
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
HTTP 상태 코드 | 코드 | 메시지 | 설명 |
---|---|---|---|
200 | - | - | 성공 |
400 | 10001 | - | 요청 정보 및 파라미터 오류 |
400 | 130*** | - | 요청 정보 및 파라미터 오류 |
401 | - | - | 유효하지 않은 인증 정보 |
403 | 10002 | - | 권한 없는 요청 |
404 | 10009 | - | 존재하지 않는 리소스 또는 경로 |
500 | 130000 | - | 서비스 내부 오류 |
500 | 139999 | - | 연동 서비스 API 호출 오류 |
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.
{
"error": {
"errorCode": "200",
"message": "Authentication Failed",
"details": "Invalid authentication information."
}
}
Data Box Frame API
Data Box Frame 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
Data Box Frame
Data Box Frame에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-data-box-frame-list | Data Box Frame 목록 조회 |
get-data-box-frame-detail | Data Box Frame 상세 정보 조회 |
get-data-box-frame-infra-list | Data Box Frame 인프라 목록 조회 |
modify-data-box-frame-admin-infra | Data Box Frame 인프라 설정 변경 |
change-data-box-frame-nas-volume-size | Data Box Frame NAS 용량 변경 |
return-data-box-frame | Data Box Frame 반납 |
Data Box
Data Box에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-bucket-list | Data Box Frame 반입 또는 반출 시 사용할 버킷 목록 조회 |
create-data-box | Data Box Frame 내 Data Box 생성 |
get-data-box-list | Data Box Frame 내 Data Box 목록 조회 |
get-data-box-summary-info | Data Box Frame 내 Data Box 요약 정보 조회 |
get-data-box-infra-list | Data Box Frame 내 Data Box 인프라 목록 조회 |
get-hadoop-cluster-info | Data Box 내 Hadoop 클러스터 정보 조회 |
get-linux-info | Data Box 내 Linux 서버 정보 조회 |
get-tensor-flow-info | Data Box 내 Tensorflow 서버 정보 조회 |
change-data-box-nas-volume-size | Data Box 내 NAS 용량 변경 |
set-block-external-network | Data Box 외부망 연결 허용 및 차단 설정 |
modify-data-box | Data Box 인프라 설정 변경 |
return-data-box | Data Box 반납 |
Import
파일 반입에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-target-nas-list | Data Box 내 반입 파일을 저장할 NAS 목록 조회 |
apply-file-import | Data Box 내 파일 반입 신청 |
get-import-apply-list | Data Box 내 파일 반입 신청 목록 조회 |
get-import-apply-detail | Data Box 내 파일 반입 신청 상세 정보 조회 |
Export
파일 반출에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-ssl-vpn-account-list | Data Box에 등록된 SSL VPN 계정 목록 조회 |
get-source-nas-list | Data Box 내 반출 신청 파일이 저장된 NAS 목록 조회 |
apply-file-export | Data Box 내 파일 반출 신청 |
get-export-apply-list | Data Box 내 파일 반출 신청 목록 조회 |
get-export-apply-detail | Data Box 내 반출 신청 목록 상세 정보 조회 |
return-file-export-apply | Data Box 내 파일 반출 신청 취소 |
Approve
파일 반출 심사에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-export-file-approve-list | Data Box 내 파일 반출 심사 대상 목록 조회 |
get-export-file-approve-detail | Data Box 내 파일 반출 심사 대상 상세 정보 조회 |
export-file-approve | Data Box 내 파일 반출 신청 승인 |
export-file-reject | Data Box 내 파일 반출 신청 반려 |
Data Box Frame 연관 리소스
Data Box Frame API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- Data Box Frame API 사용 방법
- 서명(시그니처) 생성: 요청 헤더에 추가할 서명 생성 방법
- API Gateway 사용 가이드: 요청 헤더에 추가할 API Key 발급
- Sub Account 사용 가이드: 요청 헤더에 추가할 Access Key 발급 방법
- Ncloud 공통 응답 상태 코드: Data Box Frame 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
- Data Box Frame 서비스 사용 방법
- Data Box Frame 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Data Box Frame 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 관한 사용 가이드
- 요금 소개, 특징, 상세 기능: Data Box Frame의 요금 체계, Data Box Frame의 특징, 상세 기능 및 활용 예시 요약
- 서비스 최신 소식: Data Box Frame 관련 최신 소식
- 자주 하는 질문: Data Box Frame 사용자들이 자주 하는 질문
- 문의하기: 사용 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의