VPC 환경에서 이용 가능합니다.
개요
네이버 클라우드 플랫폼은 NAVER의 최신 컴퓨팅 기술과 운영 노하우가 축적된 클라우드 서비스입니다.
네이버 클라우드 플랫폼에서 제공하는 서비스와 솔루션을 활용할 수 있도록 지원하는 응용 프로그램 인터페이스(API)를 네이버 클라우드 플랫폼 API라고 합니다.
네이버 클라우드 플랫폼 API는 RESTful 형태로 제공됩니다.
HTTP 방식의 GET/POST 메서드 호출을 통해서 이루어집니다.
공통 설정
API URL
GET or POST
https://ncloud.apigw.gov-ntruss.com/vserver/v2/
요청 헤더
| 헤더명 | 설명 |
|---|---|
| x-ncp-apigw-timestamp | 1970 년 1 월 1 일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 표시. API Gateway 서버와 시간 차가 5 분 이상 나는 경우 유효하지 않은 요청으로 간주 |
| x-ncp-iam-access-key | 네이버 클라우드 플랫폼에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKey |
| x-ncp-apigw-signature-v2 | 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명 HMAC 암호화 알고리즘은 HmacSHA256 사용 |
오퍼레이션
Common
| API명 | 설명 |
|---|---|
| getRegionList | 리전 리스트 조회 |
| getZoneList | ZONE 리스트 조회 |
| getServerImageProductList | 네이버 클라우드 플랫폼에서 제공하는 서버 이미지 상품 리스트 조회 |
| getServerProductList | 서버 이미지 상품 코드를 이용하여 네이버 클라우드 플랫폼에서 제공하는 서버 스펙 상품 리스트 조회 |
| getRaidList | 사용 가능한 RAID 리스트 조회 |
Login Key
| API명 | 설명 |
|---|---|
| getLoginKeyList | 서버 인스턴스(VM)에 접속 시 로그인 키를 이용하여 비밀번호를 암호화하고 복호화하는 키 조회 |
| createLoginKey | 서버 인스턴스(VM)에 접속 시 로그인 키를 이용하여 비밀번호를 암호화하고 복호화하는 키 생성 |
| deleteLoginKeys | 서버 인스턴스(VM)에 접속 시 로그인 키를 이용하여 비밀번호를 암호화하고 복호화하는 키 삭제 |
| importLoginKey | 서버 인스턴스(VM)에 접속 시 로그인 키를 이용하여 비밀번호를 암호화하고 복호화하는 키 생성. 사용자가 직접 ssh-keygen으로 생성한 public key를 import 함 |
Placement Group
| API명 | 설명 |
|---|---|
| getPlacementGroupList | 서버 인스턴스(VM)가 소속되는 물리 배치 그룹 리스트 조회 |
| getPlacementGroupDetail | 물리 배치 그룹 번호를 이용하여 물리 배치 그룹 상세 정보 조회 |
| createPlacementGroup | 서버 인스턴스(VM)가 소속되는 물리 배치 그룹 생성 |
| deletePlacementGroup | 물리 배치 그룹 삭제 |
| addPlacementGroupServerInstance | 물리 배치 그룹에 서버 인스턴스 추가 |
| removePlacementGroupServerInstance | 물리 배치 그룹에서 서버 인스턴스 제거 |
Server
| API명 | 설명 |
|---|---|
| getServerInstanceList | 서버 인스턴스(VM) 리스트 조회 |
| getServerInstanceDetail | 서버 인스턴스 번호를 이용하여 서버 인스턴스 상세 정보 조회 |
| createServerInstances | 서버 인스턴스(VM) 생성 |
| startServerInstances | 정지 상태의 서버 인스턴스(VM) 시작 |
| stopServerInstances | 운영 중 상태의 서버 인스턴스(VM) 정지 |
| rebootServerInstances | 운영 중 상태의 서버 인스턴스(VM) 재시작 |
| terminateServerInstances | 정지 상태의 서버 인스턴스(VM) 반납 |
| changeServerInstanceSpec | 정지 상태의 서버 인스턴스(VM) 스펙 변경 |
| getRootPassword | 서버 인스턴스(VM)의 로그인 키를 이용하여 root 계정의 비밀번호 조회. privateKey를 입력하지 않으면 해당 서버 인스턴스의 암호화된 비밀번호 조회 |
| getRootPasswordServerInstanceList | 서버 인스턴스(VM)의 로그인 키를 이용하여 root 계정의 비밀번호를 리스트 형태로 조회. privateKey를 입력하지 않으면 해당 서버 인스턴스의 암호화된 비밀번호 조회 |
| setProtectServerTermination | 서버 반납 보호 여부를 설정 |
Server Image
| API명 | 설명 |
|---|---|
| getMemberServerImageInstanceList | 회원 서버 이미지 인스턴스 리스트 조회 |
| getMemberServerImageInstanceDetail | 회원 서버 이미지 인스턴스 번호를 이용하여 회원 서버 이미지 인스턴스 상세 정보 조회 |
| createMemberServerImageInstance | 정지/운영 중 상태의 서버 인스턴스로부터 회원 서버 이미지 인스턴스 생성 |
| deleteMemberServerImageInstances | 회원 서버 이미지 인스턴스 리스트 삭제 |
| setMemberServerImageSharingPermission | 회원 서버 이미지 공유 권한 설정 |
| addMemberServerImageSharingPermission | 회원 서버 이미지 공유 권한 추가 |
| removeMemberServerImageSharingPermission | 회원 서버 이미지 공유 권한 제거 |
Storage
| API명 | 설명 |
|---|---|
| getBlockStorageInstanceList | 블록 스토리지 인스턴스 리스트 조회 |
| getBlockStorageInstanceDetail | 블록 스토리지 인스턴스 번호를 이용하여 블록 스토리지 인스턴스 상세 정보 조회 |
| createBlockStorageInstance | 블록 스토리지 인스턴스 생성 |
| deleteBlockStorageInstances | 블록 스토리지 인스턴스 리스트 삭제 |
| attachBlockStorageInstance | 블록 스토리지 인스턴스를 서버 인스턴스 할당 |
| detachBlockStorageInstances | 블록 스토리지 인스턴스 리스트를 서버 인스턴스에서 할당 해제 |
| changeBlockStorageVolumeSize | 블록 스토리지 볼륨 사이즈 변경 |
| setBlockStorageReturnProtection | 블록 스토리지 반납 보호 여부를 설정합니다. |
Snapshot
| API명 | 설명 |
|---|---|
| getBlockStorageSnapshotInstanceList | 블록 스토리지 스냅샷 인스턴스 리스트 조회 |
| getBlockStorageSnapshotInstanceDetail | 블록 스토리지 스냅샷 인스턴스 번호를 이용하여 블록 스토리지 스냅샷 인스턴스 상세 정보 조회 |
| createBlockStorageSnapshotInstance | 블록 스토리지 스냅샷 인스턴스 생성 |
| deleteBlockStorageSnapshotInstances | 블록 스토리지 스냅샷 인스턴스 리스트 삭제 |
Public IP
| API명 | 설명 |
|---|---|
| getPublicIpInstanceList | 공인 IP 인스턴스 리스트 조회 |
| getPublicIpInstanceDetail | 공인 IP 인스턴스 번호를 이용하여 공인 IP 인스턴스 상세 정보 조회 |
| createPublicIpInstance | 공인 IP 인스턴스 생성 |
| deletePublicIpInstance | 공인 IP 인스턴스 삭제 |
| getPublicIpTargetServerInstanceList | 공인 IP 인스턴스를 할당 가능한 서버 인스턴스 리스트 조회 |
| associatePublicIpWithServerInstance | 공인 IP 인스턴스를 서버 인스턴스 할당 |
| disassociatePublicIpFromServerInstance | 공인 IP 인스턴스를 서버 인스턴스에서 할당 해제 |
Init Script
| API명 | 설명 |
|---|---|
| getInitScriptList | 사용자가 생성한 초기화 스크립트 리스트 조회 |
| getInitScriptDetail | 초기화 스크립트 번호를 이용하여 초기화 스크립트 상세 정보 조회 |
| createInitScript | 초기화 스크립트 생성 |
| deleteInitScripts | 초기화 스크립트 리스트 삭제 |
Network Interface
| API명 | 설명 |
|---|---|
| getNetworkInterfaceList | 네트워크 인터페이스 리스트 조회 |
| getNetworkInterfaceDetail | 네트워크 인터페이스 번호를 이용하여 네트워크 인터페이스 상세 정보 조회 |
| createNetworkInterface | 네트워크 인터페이스 생성 |
| deleteNetworkInterface | 네트워크 인터페이스 삭제 |
| attachNetworkInterface | 서버 인스턴스에 네트워크 인터페이스 할당. 서버 인스턴스의 기본 네트워크 인터페이스를 포함하여 최대 3개의 네트워크 인터페이스 할당할 수 있음 |
| detachNetworkInterface | 서버 인스턴스에 할당된 네트워크 인터페이스 해제. 서버 인스턴스의 기본 네트워크 인터페이스는 해제할 수 없음 |
| addNetworkInterfaceAccessControlGroup | 네트워크 인터페이스에 적용될 ACG 리스트 추가. 네트워크 인터페이스당 최대 3개의 ACG를 적용할 수 있음 |
| removeNetworkInterfaceAccessControlGroup | 네트워크 인터페이스에 적용된 ACG 리스트 제거. 네트워크 인터페이스당 최소 1개의 ACG가 적용되어야 함 |
| assignSecondaryIps | 네트워크 인터페이스에 보조 IP 할당 |
| unassignSecondaryIps | 네트워크 인터페이스에 할당된 보조 IP 해제 |
| enableFlowLog | FlowLog 활성화 |
| disableFlowLog | FlowLog 비활성화 |
| getFlowLogConfigurationList | FlowLog 설정 정보 조회 |
ACG
| API명 | 설명 |
|---|---|
| getAccessControlGroupList | ACG 리스트 조회. ACG는 네트워크 인터페이스에 설정하여 접근 제어 기능을 할 수 있음 |
| getAccessControlGroupDetail | ACG 번호를 이용하여 ACG 상세 정보 조회 |
| createAccessControlGroup | ACG 생성 |
| deleteAccessControlGroup | ACG 삭제 |
| getAccessControlGroupRuleList | ACG 번호를 이용하여 ACG의 Rule 리스트 조회 |
| addAccessControlGroupInboundRule | ACG의 Inbound Rule 리스트 추가 |
| addAccessControlGroupOutboundRule | ACG의 Outbound Rule 리스트 추가 |
| removeAccessControlGroupInboundRule | ACG의 Inbound Rule 리스트 제거 |
| removeAccessControlGroupOutboundRule | ACG의 Outbound Rule 리스트 제거 |