Server 개요

Server는 클라우드 환경에서 서버를 생성하고 확장하며, 운영하고 관리할 수 있도록 돕는 네이버 클라우드 플랫폼의 서비스입니다. Server에서는 서버, 스토리지, 스냅샷, 공인 IP, Init Script, 네트워크 인터페이스(Network Interface), ACG(Access Control Group), Fabric Cluster 기능에 대한 API를 RESTful 형태로 제공합니다.

Server 공통 설정

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

요청

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

API URL

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

https://fin-ncloud.apigw.fin-ntruss.com/vserver/v2/

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드	필수 여부	설명
`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 Access Key 발급 및 확인: 인증키 생성 참조 서브 계정의 Access Key 발급 및 확인: 서브 계정 생성 참조
`x-ncp-apigw-signature-v2`	Required	네이버 클라우드 플랫폼에서 발급받은 Access Key에 맵핑되는 Secret Key 및 HMAC 암호화 알고리즘(HmacSHA256)으로 요청 정보를 암호화한 후 Base64로 인코딩한 서명 Secret Key 발급 및 확인: 인증키 생성 참조 서명 생성: 시그니처 생성 참조

응답

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

응답 바디

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

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

필드	타입	필수 여부	설명
`returnCode`	String	Required	오류 코드
`returnMessage`	String	Required	오류 메시지

응답 상태 코드

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

Server API

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

Login Key

인증키 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createLoginKey	인증키 생성
importLoginKey	사용자가 직접 생성한 공개키를 인증키로 가져오기
getLoginKeyList	인증키 목록 조회
deleteLoginKeys	인증키 삭제

ACG

ACG (Access Control Group) 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createAccessControlGroup	ACG 생성
getAccessControlGroupList	ACG 목록 조회
getAccessControlGroupDetail	ACG 상세 정보 조회
getAccessControlGroupRuleList	ACG의 규칙 목록 조회
addAccessControlGroupInboundRule	ACG에 인바운드 규칙 추가
removeAccessControlGroupInboundRule	ACG에서 인바운드 규칙 삭제
addAccessControlGroupOutboundRule	ACG에 아웃바운드 규칙 추가
removeAccessControlGroupOutboundRule	ACG에서 아웃바운드 규칙 삭제
deleteAccessControlGroup	ACG 삭제

Init Script

초기화 스크립트 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createInitScript	초기화 스크립트 생성
getInitScriptList	초기화 스크립트 목록 조회
getInitScriptDetail	초기화 스크립트 상세 정보 조회
deleteInitScripts	초기화 스크립트 삭제

Placement Group

물리 배치 그룹 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createPlacementGroup	서버 인스턴스가 소속되는 물리 배치 그룹 생성
getPlacementGroupList	물리 배치 그룹 목록 조회
getPlacementGroupDetail	물리 배치 그룹 상세 정보 조회
addPlacementGroupServerInstance	물리 배치 그룹에 서버 인스턴스 추가
removePlacementGroupServerInstance	물리 배치 그룹에서 서버 인스턴스 제거
deletePlacementGroup	물리 배치 그룹 삭제

Server Image

서버 이미지 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createServerImage	서버 인스턴스로 서버 이미지 생성
createServerImageFromSnapshot	스냅샷으로 서버 이미지 생성
getServerImageList	서버 이미지 목록 조회
getServerImageDetail	서버 이미지 상세 정보 조회
addServerImageSharingPermission	서버 이미지에 공유 권한 추가
removeServerImageSharingPermission	서버 이미지에서 공유 권한 삭제
deleteServerImage	서버 이미지 삭제
createMemberServerImageInstance	서버 인스턴스로 회원 서버 이미지 생성
getMemberServerImageInstanceList	회원 서버 이미지 목록 조회
getMemberServerImageInstanceDetail	회원 서버 이미지 상세 정보 조회
addMemberServerImageSharingPermission	회원 서버 이미지에 공유 권한 추가
setMemberServerImageSharingPermission	회원 서버 이미지의 공유 권한 설정
removeMemberServerImageSharingPermission	회원 서버 이미지에서 공유 권한 삭제
deleteMemberServerImageInstances	회원 서버 이미지 삭제

Server Instance

서버 인스턴스 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createServerInstances	서버 인스턴스 생성
getServerInstanceList	서버 인스턴스 목록 조회
getServerInstanceDetail	서버 인스턴스 상세 정보 조회
getRootPasswordServerInstanceList	서버 인스턴스의 인증키를 사용하여 관리자 비밀번호 목록 조회
getRootPassword	서버 인스턴스 관리자 비밀번호 조회
changeServerInstanceName	서버 인스턴스 이름 변경
changeServerInstanceSpec	서버 인스턴스의 스펙 변경
setProtectServerTermination	서버 인스턴스의 반납 보호 여부 설정
startServerInstances	정지 상태인 서버 인스턴스 시작
stopServerInstances	운영 중 상태인 서버 인스턴스 정지
rebootServerInstances	운영 중 상태인 서버 인스턴스 재시작
interruptServerInstance	서버 인스턴스의 상태를 분석하기 위해 진단 인터럽트 실행
terminateServerInstances	정지 상태인 서버 인스턴스 반납

Network Interface

네트워크 인터페이스 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createNetworkInterface	네트워크 인터페이스 생성
getNetworkInterfaceList	네트워크 인터페이스 목록 조회
getNetworkInterfaceDetail	네트워크 인터페이스 상세 정보 조회
attachNetworkInterface	네트워크 인터페이스를 서버 인스턴스에 할당
detachNetworkInterface	서버 인스턴스에 할당된 네트워크 인터페이스 해제
addNetworkInterfaceAccessControlGroup	네트워크 인터페이스에 ACG 추가
removeNetworkInterfaceAccessControlGroup	네트워크 인터페이스에서 ACG 삭제
assignSecondaryIps	네트워크 인터페이스에 보조 IP 할당
unassignSecondaryIps	네트워크 인터페이스에서 보조 IP 해제
enableFlowLog	Flow Log 활성화
getFlowLogConfigurationList	Flow Log 설정 정보 조회
disableFlowLog	Flow Log 비활성화
deleteNetworkInterface	네트워크 인터페이스 삭제

Public IP

공인 IP 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createPublicIpInstance	공인 IP 인스턴스 생성
getPublicIpInstanceList	공인 IP 인스턴스 목록 조회
getPublicIpInstanceDetail	공인 IP 인스턴스 상세 정보 조회
getPublicIpTargetServerInstanceList	공인 IP 인스턴스를 할당 가능한 서버 인스턴스 목록 조회
associatePublicIpWithServerInstance	공인 IP 인스턴스를 서버 인스턴스에 할당
disassociatePublicIpFromServerInstance	공인 IP 인스턴스를 서버 인스턴스에서 할당 해제
deletePublicIpInstance	공인 IP 인스턴스 삭제

Storage

스토리지 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createBlockStorageInstance	블록 스토리지 인스턴스 생성
getBlockStorageInstanceList	블록 스토리지 인스턴스 목록 조회
getBlockStorageInstanceDetail	블록 스토리지 인스턴스 상세 정보 조회
getBlockStorageVolumeTypeList	블록 스토리지 볼륨 유형 목록 조회
attachBlockStorageInstance	블록 스토리지 인스턴스를 서버 인스턴스에 할당
detachBlockStorageInstances	서버 인스턴스에 할당된 블록 스토리지 인스턴스 목록 해제
changeBlockStorageInstance	블록 스토리지 볼륨 크기 변경
changeBlockStorageVolumeSize	블록 스토리지 볼륨 크기 변경
setBlockStorageReturnProtection	블록 스토리지 반납 보호 여부 설정
deleteBlockStorageInstances	블록 스토리지 인스턴스 삭제

Snapshot

스냅샷 관련 API에 대한 설명은 다음과 같습니다.

API	설명
createBlockStorageSnapshotInstance	블록 스토리지 스냅샷 인스턴스 생성
getBlockStorageSnapshotInstanceList	블록 스토리지 스냅샷 인스턴스 목록 조회
getBlockStorageSnapshotInstanceDetail	블록 스토리지 스냅샷 인스턴스 상세 정보 조회
deleteBlockStorageSnapshotInstances	블록 스토리지 스냅샷 인스턴스 삭제

Common

리소스 생성 시 참조하는 공통 조회 API에 대한 설명은 다음과 같습니다.

API	설명
getRegionList	리전 목록 조회
getZoneList	존 목록 조회
getServerImageProductList	서버 이미지 상품 목록 조회
getServerProductList	서버 상품 목록 조회
getServerSpecList	서버 스펙 목록 조회
getServerSpecDetail	서버 스펙 상세 정보 조회
getHypervisorTypeList	하이퍼바이저 유형 목록 조회
getRaidList	RAID 목록 조회

Server 연관 리소스

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

Server API 사용 방법
- 서명(시그니처) 생성: 요청 헤더에 추가할 서명 생성 방법
- Sub Account 사용 가이드: 요청 헤더에 추가할 Access Key 발급 방법
- Ncloud 공통 응답 상태 코드: Server 서비스에서 사용하는 네이버 클라우드 플랫폼의 공통 응답 상태 코드 정보
Server 서비스 사용 방법
- Server 사용 가이드: 네이버 클라우드 플랫폼 콘솔에서 Server를 사용하는 방법
- 요금 소개, 특징, 상세 기능: Server의 요금 체계, 특징, 상세 기능 요약
- 서비스 최신 소식: Server 관련 최신 소식
- 자주 하는 질문: Server 사용자들이 자주 하는 질문
- 고객 지원: API 가이드를 통해서도 궁금증이 해결되지 않는 경우, 직접 문의

Documentation Index