Data Forest 개요
    • PDF

    Data Forest 개요

    • PDF

    기사 요약

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

    개요

    네이버 클라우드 플랫폼은 NAVER의 최신 컴퓨팅 기술과 운영 노하우가 축적된 클라우드 서비스입니다.
    네이버 클라우드 플랫폼에서 제공하는 서비스와 솔루션을 활용할 수 있도록 지원하는 응용 프로그램 인터페이스(API)를 네이버 클라우드 플랫폼 API라고 합니다.

    공통 설정

    API URL

    https://df.apigw.ntruss.com/api/v2/
    

    요청 헤더

    헤더명설명
    x-ncp-apigw-timestamp- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
    - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
    x-ncp-iam-access-keyNAVER Cloud Platform에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey
    x-ncp-apigw-signature-v2- 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명
    - HMAC 암호화 알고리즘은 HmacSHA256 사용

    오퍼레이션

    Accounts

    API명설명
    checkAvailableNameData Forest 계정 생성 시, 생성 가능한 계정 이름 확인
    checkHasResourceData Forest 계정 삭제 전, 계정 소유로 생성된 리소스가 있는지 확인
    createData Forest 계정 생성
    getListData Forest 모든 계정 목록을 조회
    getDetailData Forest 계정 상세정보를 조회
    getKerberosKeytabData Forest 계정의 커버로스 키탭 다운로드
    resetKerberosKeytabData Forest 계정의 커버로스 키탭 초기화
    resetPasswordData Forest 계정 패스워드 초기화
    setQuotaData Forest 계정의 HDFS Quota 변경
    deleteData Forest 계정 삭제

    Notebooks

    API명설명
    getVpclistNotebook 생성 시, 생성 가능한 VPC를 조회
    getVpcDetailNotebook 생성 시, 생성 가능한 VPC의 상세정보를 확인
    getSubnetListNotebook 생성 시, 생성 가능한 Subnet을 조회
    getSubnetDetailNotebook 생성 시, 생성 가능한 Subnet의 상세정보를 확인
    getTypeListNotebook 생성 시, 생성 가능한 노트북 타입을 조회
    getServerTypeList노트북 생성시, 생성 가능한 서버 타입을 확인
    getList생성한 Notebook의 목록을 조회
    getDetail생성한 Notebook의 상세 정보를 확인
    getUserConfigurationSpecList노트북 구성에 필요한 사용자 설정을 확인
    checkAvailableNameNotebook 생성 시, 생성 가능한 이름을 확인
    getLoginKeyListLoginKey 목록을 확인
    restart생성한 Notebook을 재시작
    deleteNotebook을 삭제
    createNotebook을 생성
    setUserConfigurationList사용자가 구성한 Notebook Spec을 설정

    Apps

    API명설명
    checkAvailableNameData Forest 앱 생성 시, 생성 가능한 앱 이름 확인
    getAppTypeIdListData Forest 앱 타입 아이디 목록을 조회
    getAppBasicSettingData Forest 지정 앱 타입의 기본 생성 설정 조회
    getAppTypeTemplateData Forest 지정 앱 타입의 템플릿 정보 조회
    createData Forest 앱 생성
    getListData Forest 계정의 모든 앱 목록 조회
    getDetailData Forest 앱의 상세정보 조회
    killContainerData Forest 앱의 컴포넌트 컨테이너 재시작
    killMasterData Forest 앱의 애플리케이션 Master를 재시작
    setContainerCountData Forest 앱의 컴포넌트 컨테이너 수 변경
    setLifetimeData Forest 앱의 Lifetime을 변경
    startData Forest 앱 시작
    stopData Forest 앱 정지
    deleteData Forest 앱 삭제

    AI Workspaces

    API명설명
    checkAvailableNameAI 워크스페이스의 이름 생성 가능 여부 확인
    getDockerImageListAI 워크스페이스의 Docker 이미지 목록을 조회
    createAI 워크스페이스 생성
    getListAI 워크스페이스의 모든 목록 조회
    getDetailAI 워크스페이스의 상세정보 조회
    getConfigurationListAI 워크스페이스 설정 조회
    setConfigurationAI 워크스페이스의 설정 변경
    deleteAI 워크스페이스 삭제

    AI Apps

    API명설명
    submitAI 앱 실행
    getListAI 앱의 모든 목록 조회
    getDetailAI 앱의 상세정보 조회
    killAI 앱 정지

    에러 코드

    API 요청이 잘못되었거나 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON/XML 형식으로 상세 메시지를 반환합니다.

    응답 예시

    출력형식이 json인 경우

    {
      "error": {
        "message": "리턴-메시지",
        "success": "false"
      }
    }
    

    출력형식이 xml인 경우

    <ErrorResponse>
    	<message>리턴-메시지</message>
    	<success>false</success>
    </ErrorResponse>
    

    에러 응답

    HTTP Code리턴 메시지설명해결방안
    400exceeded limit on resource quota생성한도 초과고객지원 > 문의하기로 문의
    403not allowed to access권한이 없는 요청해당 계정에 권한 추가 또는 적절한 인증 정보 사용
    404no such element존재하지 않는 resource 또는 경로 조회입력 값 확인
    500unexpected error알 수 없는 오류 발생고객지원 > 문의하기로 문의

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.