Data Forest 개요

Prev Next

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

Data Forest는 빅데이터 분석에서 머신러닝까지 다양한 오픈 소스 애플리케이션을 제공하는 네이버 클라우드 플랫폼의 빅데이터 분석 플랫폼 서비스입니다. Data Forest 서비스에서는 Data Forest 계정, 앱 기능에 대한 API를 RESTful 형태로 제공합니다.

Data Forest 공통 설정

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

요청

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

API URL

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

https://df.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로 인코딩한 서명
Accept Optional 응답 데이터의 형식
  • application/json | application/xml | application/octet-stream
Content-type Optional 요청 데이터의 형식
  • application/json | application/xml

응답

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

응답 바디

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

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

필드 타입 필수 여부 설명
message String Required 오류 메시지
success Boolean Required API 처리 결과
  • false: 실패 (유효 값)

응답 상태 코드

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

HTTP 상태 코드 코드 메시지 설명
400 - exceeded limit on resource quota 생성 한도 초과
  • 네이버 클라우드 플랫폼 포털의 고객지원으로 문의
400 - invalid request parameters 파라미터 입력 오류
403 - not allowed to access 권한이 없는 요청
  • 해당 계정에 권한 추가 또는 적절한 인증 정보 사용
404 - no such element 존재하지 않는 리소스 또는 경로 조회
  • 입력 값 확인 후 올바른 리소스 또는 경로 입력
500 - unexpected error 알 수 없는 오류 발생
  • 네이버 클라우드 플랫폼 포털의 고객지원으로 문의
참고

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

응답 예시

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

  • JSON
    {
    "error": {
        "message": "string",
        "success": "false"
    }
}
  • XML
<ErrorResponse>
    <message>string</message>
    <success>false</success>
</ErrorResponse>

Data Forest API

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

Accounts

Data Forest 계정 관련 API에 대한 설명은 다음과 같습니다.

API 설명
checkAvailableName Data Forest 계정 이름 유효성 및 중복 여부 확인
create Data Forest 계정 생성
getList Data Forest 계정 목록 조회
getDetail Data Forest 계정 단건 상세 조회
checkHasResource Data Forest 계정 소유의 리소스 존재 여부 확인
getKerberosKeytab 커버로스 키탭 다운로드
resetKerberosKeytab 커버로스 키탭 초기화
resetPassword Data Forest 계정 비밀번호 초기화
setQuota Data Forest 계정 HDFS Quota 변경
delete Data Forest 계정 삭제

Apps

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

API 설명
checkAvailableName Data Forest 앱 이름 유효성 및 중복 여부 확인
getAppBasicSetting Data Forest 앱 타입 기본 설정 조회
getAppTypeIdList Data Forest 앱 타입 아이디 목록 조회
getAppTypeTemplate Data Forest 앱 타입 템플릿 정보 조회
create Data Forest 앱 생성
getList Data Forest 계정의 앱 목록 조회
getDetail Data Forest 앱 단건 상세 조회
setContainerCount Data Forest 앱 컴포넌트 컨테이너 개수 변경
setLifetime Data Forest 앱 구동 시간(Lifetime) 변경
killContainer Data Forest 앱 컴포넌트 컨테이너 재시작
killMaster Data Forest 앱 Application Master 재시작
start Data Forest 앱 시작
stop Data Forest 앱 정지
delete Data Forest 앱 삭제

Data Forest 연관 리소스

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