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-key | NAVER Cloud Platform에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey |
x-ncp-apigw-signature-v2 | - 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용 |
오퍼레이션
Accounts
API명 | 설명 |
---|---|
checkAvailableName | Data Forest 계정 생성 시, 생성 가능한 계정 이름 확인 |
checkHasResource | Data Forest 계정 삭제 전, 계정 소유로 생성된 리소스가 있는지 확인 |
create | Data Forest 계정 생성 |
getList | Data Forest 모든 계정 목록을 조회 |
getDetail | Data Forest 계정 상세정보를 조회 |
getKerberosKeytab | Data Forest 계정의 커버로스 키탭 다운로드 |
resetKerberosKeytab | Data Forest 계정의 커버로스 키탭 초기화 |
resetPassword | Data Forest 계정 패스워드 초기화 |
setQuota | Data Forest 계정의 HDFS Quota 변경 |
delete | Data Forest 계정 삭제 |
Notebooks
API명 | 설명 |
---|---|
getVpclist | Notebook 생성 시, 생성 가능한 VPC를 조회 |
getVpcDetail | Notebook 생성 시, 생성 가능한 VPC의 상세정보를 확인 |
getSubnetList | Notebook 생성 시, 생성 가능한 Subnet을 조회 |
getSubnetDetail | Notebook 생성 시, 생성 가능한 Subnet의 상세정보를 확인 |
getTypeList | Notebook 생성 시, 생성 가능한 노트북 타입을 조회 |
getServerTypeList | 노트북 생성시, 생성 가능한 서버 타입을 확인 |
getList | 생성한 Notebook의 목록을 조회 |
getDetail | 생성한 Notebook의 상세 정보를 확인 |
getUserConfigurationSpecList | 노트북 구성에 필요한 사용자 설정을 확인 |
checkAvailableName | Notebook 생성 시, 생성 가능한 이름을 확인 |
getLoginKeyList | LoginKey 목록을 확인 |
restart | 생성한 Notebook을 재시작 |
delete | Notebook을 삭제 |
create | Notebook을 생성 |
setUserConfigurationList | 사용자가 구성한 Notebook Spec을 설정 |
Apps
API명 | 설명 |
---|---|
checkAvailableName | Data Forest 앱 생성 시, 생성 가능한 앱 이름 확인 |
getAppTypeIdList | Data Forest 앱 타입 아이디 목록을 조회 |
getAppBasicSetting | Data Forest 지정 앱 타입의 기본 생성 설정 조회 |
getAppTypeTemplate | Data Forest 지정 앱 타입의 템플릿 정보 조회 |
create | Data Forest 앱 생성 |
getList | Data Forest 계정의 모든 앱 목록 조회 |
getDetail | Data Forest 앱의 상세정보 조회 |
killContainer | Data Forest 앱의 컴포넌트 컨테이너 재시작 |
killMaster | Data Forest 앱의 애플리케이션 Master를 재시작 |
setContainerCount | Data Forest 앱의 컴포넌트 컨테이너 수 변경 |
setLifetime | Data Forest 앱의 Lifetime을 변경 |
start | Data Forest 앱 시작 |
stop | Data Forest 앱 정지 |
delete | Data Forest 앱 삭제 |
AI Workspaces
API명 | 설명 |
---|---|
checkAvailableName | AI 워크스페이스의 이름 생성 가능 여부 확인 |
getDockerImageList | AI 워크스페이스의 Docker 이미지 목록을 조회 |
create | AI 워크스페이스 생성 |
getList | AI 워크스페이스의 모든 목록 조회 |
getDetail | AI 워크스페이스의 상세정보 조회 |
getConfigurationList | AI 워크스페이스 설정 조회 |
setConfiguration | AI 워크스페이스의 설정 변경 |
delete | AI 워크스페이스 삭제 |
AI Apps
API명 | 설명 |
---|---|
submit | AI 앱 실행 |
getList | AI 앱의 모든 목록 조회 |
getDetail | AI 앱의 상세정보 조회 |
kill | AI 앱 정지 |
에러 코드
API 요청이 잘못되었거나 처리 도중 오류가 발생하면 HTTP 상태코드로 성공/실패를 반환하고 JSON/XML 형식으로 상세 메시지를 반환합니다.
응답 예시
출력형식이 json인 경우
{
"error": {
"message": "리턴-메시지",
"success": "false"
}
}
출력형식이 xml인 경우
<ErrorResponse>
<message>리턴-메시지</message>
<success>false</success>
</ErrorResponse>
에러 응답
HTTP Code | 리턴 메시지 | 설명 | 해결방안 |
---|---|---|---|
400 | exceeded limit on resource quota | 생성한도 초과 | 고객지원 > 문의하기로 문의 |
403 | not allowed to access | 권한이 없는 요청 | 해당 계정에 권한 추가 또는 적절한 인증 정보 사용 |
404 | no such element | 존재하지 않는 resource 또는 경로 조회 | 입력 값 확인 |
500 | unexpected error | 알 수 없는 오류 발생 | 고객지원 > 문의하기로 문의 |
이 문서가 도움이 되었습니까?