VPC 환경에서 이용 가능합니다.
Server는 클라우드 환경에서 서버를 생성하고 확장하며, 운영하고 관리할 수 있도록 돕는 네이버 클라우드 플랫폼의 서비스입니다. Server에서는 서버, 스토리지, 스냅샷, 공인 IP, Init Script, 네트워크 인터페이스(Network Interface), ACG(Access Control Group) 기능에 대한 API를 RESTful 형태로 제공합니다.
Server 공통 설정
Server API에서 공통으로 사용하는 요청 형식과 응답 형식을 설명합니다.
요청
공통 요청 형식을 설명합니다.
API URL
요청 API URL은 다음과 같습니다.
https://ncloud.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로 인코딩한 서명 |
응답
공통 응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
responseError
responseError는 API 호출 실패 정보를 정의합니다. responseError에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
returnCode |
String | Required | 오류 코드 |
returnMessage |
String | Required | 오류 메시지 |
응답 상태 코드
Server API는 네이버 클라우드 플랫폼의 공통 응답 상태 코드를 사용합니다. 네이버 클라우드 플랫폼에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud API 응답 상태 코드를 참조해 주십시오.
Server API
Server 서비스에서 제공하는 API에 대한 설명은 다음과 같습니다.
Login Key
Login Key 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createLoginKey | 인증키 생성 |
importLoginKey | 사용자가 직접 생성한 ssh-keygen 공개키로 인증키 생성 |
getLoginKeyList | 인증키 목록 조회 |
deleteLoginKeys | 인증키 삭제 |
Placement Group
Placement Group 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createPlacementGroup | 물리 배치 그룹 생성 |
getPlacementGroupDetail | 물리 배치 그룹 상세 조회 |
getPlacementGroupList | 물리 배치 그룹 목록 조회 |
addPlacementGroupServerInstance | 물리 배치 그룹에 서버 추가 |
removePlacementGroupServerInstance | 물리 배치 그룹에서 서버 제거 |
deletePlacementGroup | 물리 배치 그룹 삭제 |
Server Instance
Server Instance 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createServerInstances | 서버 인스턴스 생성 |
getRootPassword | 관리자 비밀번호 조회 |
getRootPasswordServerInstanceList | 관리자 비밀번호 목록 조회 |
getServerInstanceDetail | 서버 인스턴스 상세 조회 |
getServerInstanceList | 서버 인스턴스 목록 조회 |
changeServerInstanceSpec | 서버 인스턴스 스펙 변경 |
interruptServerInstance | 이상 동작하는 서버 인스턴스를 진단하기 위한 인터럽트 실행 |
rebootServerInstances | 서버 인스턴스 재시작 |
setProtectServerTermination | 서버 반납 보호 설정 |
startServerInstances | 서버 인스턴스 시작 |
stopServerInstances | 서버 인스턴스 정지 |
terminateServerInstances | 서버 인스턴스 반납 |
Server Image
Server Image 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createServerImage | 서버 이미지 생성 |
createServerImageFromSnapshot | 스냅샷으로 서버 이미지 생성 |
getServerImageDetail | 서버 이미지 상세 조회 |
getServerImageList | 서버 이미지 목록 조회 |
addServerImageSharingPermission | 서버 이미지 공유 권한 추가 |
removeServerImageSharingPermission | 서버 이미지 공유 권한 제거 |
deleteServerImageInstances | 서버 이미지 인스턴스 삭제 |
createMemberServerImageInstance | 내 서버 이미지 인스턴스 생성 |
getMemberServerImageInstanceDetail | 내 서버 이미지 인스턴스 상세 조회 |
getMemberServerImageInstanceList | 내 서버 이미지 인스턴스 목록 조회 |
addMemberServerImageSharingPermission | 내 서버 이미지 공유 권한 추가 |
setMemberServerImageSharingPermission | 내 서버 이미지 공유 권한 설정 |
removeMemberServerImageSharingPermission | 내 서버 이미지 공유 권한 삭제 |
deleteMemberServerImageInstances | 내 서버 이미지 인스턴스 삭제 |
Storage
Storage 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createBlockStorageInstance | 블록 스토리지 인스턴스 생성 |
getBlockStorageInstanceDetail | 블록 스토리지 인스턴스 상세 정보 조회 |
getBlockStorageInstanceList | 블록 스토리지 인스턴스 목록 조회 |
getBlockStorageVolumeTypeList | 블록 스토리지 볼륨 타입 목록 조회 |
attachBlockStorageInstance | 블록 스토리지 인스턴스를 서버 인스턴스에 할당 |
changeBlockStorageInstance | 블록 스토리지 인스턴스 속성 변경 |
changeBlockStorageVolumeSize | 블록 스토리지 볼륨 크기 변경 |
detachBlockStorageInstances | 블록 스토리지 인스턴스를 서버 인스턴스에서 할당 해제 |
setBlockStorageReturnProtection | 블록 스토리지 반납 보호 여부 설정 |
deleteBlockStorageInstances | 블록 스토리지 인스턴스 삭제 |
Snapshot
Snapshot 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createBlockStorageSnapshotInstance | 블록 스토리지 스냅샷 인스턴스 생성 |
getBlockStorageSnapshotInstanceDetail | 블록 스토리지 스냅샷 인스턴스 상세 정보 조회 |
getBlockStorageSnapshotInstanceList | 블록 스토리지 스냅샷 인스턴스 목록 조회 |
deleteBlockStorageSnapshotInstances | 블록 스토리지 스냅샷 인스턴스 삭제 |
Public IP
Public IP 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createPublicIpInstance | 공인 IP 인스턴스 생성 |
getPublicIpInstanceDetail | 공인 IP 인스턴스 상세 정보 조회 |
getPublicIpInstanceList | 공인 IP 인스턴스 목록 조회 |
getPublicIpTargetServerInstanceList | 공인 IP 인스턴스를 할당 가능한 서버 인스턴스 목록 조회 |
associatePublicIpWithServerInstance | 공인 IP 인스턴스를 서버 인스턴스에 할당 |
disassociatePublicIpFromServerInstance | 공인 IP 인스턴스를 서버 인스턴스에서 할당 해제 |
deletePublicIpInstance | 공인 IP 인스턴스 삭제 |
Init Script
Init Script 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createInitScript | 초기화 스크립트 생성 |
getInitScriptList | 초기화 스크립트 목록 조회 |
getInitScriptDetail | 초기화 스크립트 상세 정보 조회 |
deleteInitScripts | 초기화 스크립트 목록 삭제 |
Network Interface
Network Interface 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createNetworkInterface | 네트워크 인터페이스 생성 |
getNetworkInterfaceDetail | 네트워크 인터페이스 상세 정보 조회 |
getNetworkInterfaceList | 네트워크 인터페이스 목록 조회 |
attachNetworkInterface | 서버 인스턴스에 네트워크 인터페이스 할당 |
detachNetworkInterface | 서버 인스턴스에 할당된 네트워크 인터페이스 해제 |
deleteNetworkInterface | 네트워크 인터페이스 삭제 |
addNetworkInterfaceAccessControlGroup | 네트워크 인터페이스에 적용할 ACG 추가 |
removeNetworkInterfaceAccessControlGroup | 네트워크 인터페이스에 적용한 ACG 삭제 |
assignSecondaryIps | 네트워크 인터페이스에 보조 IP 할당 |
unassignSecondaryIps | 네트워크 인터페이스에 할당된 보조 IP 해제 |
getFlowLogConfigurationList | FlowLog 설정 정보 조회 |
disableFlowLog | FlowLog 비활성화 |
enableFlowLog | FlowLog 활성화 |
ACG
ACG 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
createAccessControlGroup | ACG 생성 |
getAccessControlGroupDetail | ACG 상세 정보 조회 |
getAccessControlGroupList | ACG 목록 조회 |
getAccessControlGroupRuleList | ACG 규칙 목록 조회 |
addAccessControlGroupInboundRule | ACG의 Inbound 규칙 추가 |
addAccessControlGroupOutboundRule | ACG의 Outbound 규칙 추가 |
removeAccessControlGroupInboundRule | ACG의 Inbound 규칙 삭제 |
removeAccessControlGroupOutboundRule | ACG의 Outbound 규칙 삭제 |
deleteAccessControlGroup | ACG 삭제 |
Common
Common 관련 API에 대한 설명은 다음과 같습니다.
API | 설명 |
---|---|
getFabricClusterPoolList | 사용 가능한 GPU Fabric Cluster Pool 조회 |
getHypervisorTypeList | 하이퍼바이저 타입 목록 조회 |
getRaidList | 사용 가능한 RAID 목록 조회 |
getRegionList | 리전 목록 조회 |
getServerImageProductList | 서버 이미지 상품 목록 조회 |
getServerProductList | 서버 스펙 상품 목록 조회 |
getServerSpecDetail | 서버 스펙 상세 조회 |
getServerSpecList | 서버 스펙 목록 조회 |
getZoneList | 존 목록 조회 |
Server 연관 리소스
Server API에 대한 사용자의 이해를 돕기 위해 다양한 연관 리소스를 제공하고 있습니다.
- Server API 사용 방법
- 서명(시그니처) 생성: 요청 헤더에 추가할 서명 생성 방법
- Sub Account 사용 가이드: 요청 헤더에 추가할 Access Key 발급 방법
- Ncloud 공통 응답 상태 코드: Server 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
- Server 서비스 사용 방법
- Server 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Server를 사용하는 방법
- Ncloud 사용 환경 가이드: VPC, Classic 플랫폼 및 지원 여부에 대한 가이드
- 요금 소개, 특징, 상세 기능: Server의 요금 체계, 특징, 상세 기능 요약
- 서비스 최신 소식: Server 관련 최신 소식
- 자주 하는 질문: Server 사용자들이 자주 하는 질문
- 고객 지원: API 가이드를 통해서도 궁금증이 해결되지 않는 경우, 직접 문의