VPC 환경에서 이용 가능합니다.
Datafence는 분석자는 고객의 데이터를 자유롭게 분석하고, 데이터 관리자는 데이터 임의 반출을 제한할 수 있도록 지원하는 네이버 클라우드 플랫폼의 분석 환경 구축 서비스입니다. Datafence 서비스에서는 Datafence와 박스 생성, 데이터 반입 및 반출에 대한 심사를 수행하는 API를 RESTful 형태로 제공합니다.
Datafence 공통 설정
Datafence API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://datafence.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 | 응답 데이터의 다국어 처리
|
서브 계정에서 버킷 관련 Datafence 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 | 2600003 | - | Datafence (혹은 Box)의 소유자가 아님 |
400 | 2600005 | - | 요청한 외부망 설정이 현재와 동일한 상태 |
400 | 2600010 | - | Box 내 서버가 재부팅 상태 |
400 | 2600011 | - | Box 생성 한도 초과 |
400 | 2600013 | - | 유효하지 않은 비밀번호 |
400 | 2600023 | - | Datafence 내 Box가 최소 1개 필요 |
400 | 2600024 | - | Box가 수정 불가능한 상태 |
400 | 2600025 | - | Datafence가 사용 불가능한 상태 |
400 | 2600026 | - | 유효하지 않은 Action Type |
400 | 2600029 | - | 버킷이 존재하지 않음 |
400 | 2600031 | - | 요청한 서버 수가 허용된 범위를 벗어남 |
400 | 2600033 | - | 요청한 Hadoop 블록 스토리지가 허용된 크기를 벗어남 |
400 | 2600035 | - | 유효하지 않은 블록 스토리지 또는 NAS 인스턴스 번호 |
400 | 2600038 | - | 요청한 NAS가 허용된 크기를 벗어남 |
400 | 2600040 | - | 변경할 NAS의 크기가 기존과 동일함 |
400 | 2600041 | - | Box 내 서버가 존재하지 않음 |
400 | 2600047 | - | Box 스토리지가 존재하지 않음 |
400 | 2600053 | - | Datafence가 존재하지 않음 |
400 | 2600054 | - | Box가 존재하지 않음 |
400 | 2600072 | - | 유효하지 않은 스펙 코드 |
400 | 2600073 | - | 유효하지 않은 소프트웨어 코드 |
400 | 2610001 | - | 유효하지 않은 반출 신청 번호 |
400 | 2610002 | - | 요청한 파일 이름 중복 |
400 | 2610004 | - | 최대 요청 개수 초과 |
400 | 2610006 | - | 파일 크기 초과 |
400 | 2610008 | - | 유효하지 않은 파일 이름 |
400 | 2610010 | - | 이미 승인된 반출 신청 |
400 | 2610012 | - | 요청한 파일을 찾을 수 없음 |
403 | 10002 | - | 권한 없는 요청 |
404 | 10003 | - | 존재하지 않는 리소스 |
500 | 10007 | - | 서비스 내부 오류 |
네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
응답 예시
호출이 성공한 경우의 응답 예시는 각 API 명세에서 확인해 주십시오. 호출이 실패한 경우의 응답 예시는 다음과 같습니다.
{
"error": {
"errorCode": "200",
"message": "Authentication Failed",
"details": "Invalid authentication information."
}
}
Datafence API
Datafence 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
Datafence
Datafence에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-datafence | Datafence 목록 조회 |
get-datafence-infra-history | Datafence 인프라 이력 조회 |
get-datafence-infra-list | Datafence 인프라 목록 조회 |
get-fence-custom-image | Datafence 사용자 이미지 조회 |
change-datafence-infra | Datafence 인프라 설정 변경 |
change-fence-nas-volume | Datafence NAS 용량 변경 |
Box
Box에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-bucket-list | Datafence 반입 또는 반출 시 사용할 버킷 목록 조회 |
get-product-spec | Box 스펙 목록 조회 |
create-box | Datafence 내 Box 생성 |
get-box-custom-image | Box 내 사용자 이미지 조회 |
get-box-history | Datafence 내 Box 이력 조회 |
get-box-infra-history | Datafence 내 Box 인프라 이력 조회 |
get-box-infra-list | Datafence 내 Box 인프라 목록 조회 |
get-box-list | Datafence 내 Box 목록 조회 |
get-box-summary-info | Datafence 내 Box 요약 정보 조회 |
get-connect-info | Box 내 Connect 서버 정보 조회 |
get-hadoop-cluster-info | Box 내 Hadoop 클러스터 정보 조회 |
get-linux-info | Box 내 Linux 서버 정보 조회 |
get-windows-info | Box 내 Windows 서버 정보 조회 |
get-tensorflow-info | Box 내 Tensorflow 서버 정보 조회 |
change-box-block-external-network | Box 외부망 연결 허용 및 차단 설정 |
change-box-infra | Box 인프라 설정 변경 |
change-box-nas-volume | Box 내 NAS 용량 변경 |
return-box | Box 반납 |
Import
파일 반입에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
create-file-import | Box 내 파일 반입 신청 |
get-import-detail | Box 내 파일 반입 신청 상세 정보 조회 |
get-import-list | Box 내 파일 반입 신청 목록 조회 |
get-target-nas-list | Box 내 반입 파일을 저장할 NAS 목록 조회 |
Export
파일 반출에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
create-file-export | Box 내 파일 반출 신청 |
get-export-detail | Box 내 반출 신청 목록 상세 정보 조회 |
get-export-list | Box 내 파일 반출 신청 목록 조회 |
get-source-nas-list | Box 내 반출 신청 파일이 저장된 NAS 목록 조회 |
cancel-file-export | Box 내 파일 반출 신청 취소 |
Export Approval
파일 반출 심사에 대한 API는 다음과 같습니다.
API | 설명 |
---|---|
get-export-file-approve-detail | Box 내 파일 반출 심사 대상 상세 정보 조회 |
get-export-file-approve-list | Box 내 파일 반출 심사 대상 목록 조회 |
export-file-approve | Box 내 파일 반출 신청 승인 |
export-file-reject | Box 내 파일 반출 신청 반려 |
Datafence 연관 리소스
Datafence API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- Datafence API 사용 방법
- 서명(시그니처) 생성: 요청 헤더에 추가할 서명 생성 방법
- API Gateway 사용 가이드: 요청 헤더에 추가할 API Key 발급
- Sub Account 사용 가이드: 요청 헤더에 추가할 Access Key 발급 방법
- Ncloud 공통 응답 상태 코드: Datafence 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
- Datafence 서비스 사용 방법
- Datafence 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Datafence 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 환경 및 지원 여부에 관한 사용 가이드
- 요금 소개, 특징, 상세 기능: Datafence의 요금 체계, Datafence의 특징, 상세 기능 및 활용 예시 요약
- 서비스 최신 소식: Datafence 관련 최신 소식
- 자주 하는 질문: Datafence 사용자들이 자주 하는 질문
- 고객 지원: 사용 가이드를 통해서도 궁금증이 해결되지 않는 경우 직접 문의