Available in VPC
Server is a NAVER Cloud Platform service that helps you create, scale, operate, and manage servers in a cloud environment. Server provides APIs for servers, storage, snapshots, public IP, init scripts, network interfaces, and access control group (ACG) features in RESTful form.
Common Server settings
The following describes commonly used request and response formats in Server APIs.
Request
The following describes the common request format.
API URL
The request API URL is as follows:
https://ncloud.apigw.ntruss.com
Request headers
The following describes the request headers.
| Field | Required | Description |
|---|---|---|
x-ncp-apigw-timestamp |
Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
|
x-ncp-iam-access-key |
Required | Access key issued on NAVER Cloud Platform
|
x-ncp-apigw-signature-v2 |
Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256).
|
Response
The following describes the common response format.
Response body
The response body includes the following data:
responseError
responseError defines the API call failure information. The following describes responseError.
| Field | Type | Required | Description |
|---|---|---|---|
returnCode |
String | Required | Error code |
returnMessage |
String | Required | Error message |
Response status codes
Server APIs use NAVER Cloud Platform's common response status codes. For response status codes common to NAVER Cloud Platform, see Ncloud API response status codes.
Server API
The following describes the APIs provided by the Server service.
Login Key
The following describes the login key-related APIs.
| API | Description |
|---|---|
| createLoginKey | Create authentication key. |
| importLoginKey | Create an authentication key with the ssh-keygen public key the user generated themselves. |
| getLoginKeyList | Get authentication key list. |
| deleteLoginKeys | Delete authentication key. |
Placement Group
The following describes the placement group-related APIs.
| API | Description |
|---|---|
| createPlacementGroup | Create physical placement group. |
| getPlacementGroupDetail | Get physical placement group details. |
| getPlacementGroupList | Get physical placement group list. |
| addPlacementGroupServerInstance | Add a server to a physical placement group. |
| removePlacementGroupServerInstance | Delete a server from a physical placement group. |
| deletePlacementGroup | Delete physical placement group. |
Server Instance
The following describes the server instance-related APIs.
| API | Description |
|---|---|
| createServerInstances | Create a server instance. |
| getRootPassword | Get admin password. |
| getRootPasswordServerInstanceList | Get admin password list. |
| getServerInstanceDetail | Get server instance details. |
| getServerInstanceList | Get server instance list. |
| changeServerInstanceSpec | Change server instance specifications. |
| interruptServerInstance | Run an interrupt to diagnose a server instance with anomalies. |
| rebootServerInstances | Restart server instances. |
| setProtectServerTermination | Set server termination protection. |
| startServerInstances | Start server instances. |
| stopServerInstances | Stop server instances. |
| terminateServerInstances | Terminate server instances. |
Server Image
The following describes the server image-related APIs.
| API | Description |
|---|---|
| createServerImage | Create server image. |
| createServerImageFromSnapshot | Create a server image with a snapshot. |
| getServerImageDetail | Get server image details. |
| getServerImageList | Get server image list. |
| addServerImageSharingPermission | Add server image sharing permissions. |
| removeServerImageSharingPermission | Remove server image sharing permissions. |
| deleteServerImageInstances | Delete a server image instance. |
| createMemberServerImageInstance | Create a My server image instance. |
| getMemberServerImageInstanceDetail | Get My server image instance details. |
| getMemberServerImageInstanceList | Get the list of My server image instances. |
| addMemberServerImageSharingPermission | Add sharing permission for My server image. |
| setMemberServerImageSharingPermission | Set sharing permission for My server image. |
| removeMemberServerImageSharingPermission | Delete My server image sharing permissions. |
| deleteMemberServerImageInstances | Delete a My server image instance. |
Storage
The following describes the storage-related APIs.
| API | Description |
|---|---|
| createBlockStorageInstance | Create block storage instances. |
| getBlockStorageInstanceDetail | Get block storage instance details. |
| getBlockStorageInstanceList | Get the list of block storage instances. |
| getBlockStorageVolumeTypeList | Get the list of block storage volume types. |
| attachBlockStorageInstance | Assign block storage instances to server instances. |
| changeBlockStorageInstance | Change block storage instance properties. |
| changeBlockStorageVolumeSize | Change block storage volume size. |
| detachBlockStorageInstances | Unassign a block storage instance from a server instance. |
| setBlockStorageReturnProtection | Set block storage termination protection status. |
| deleteBlockStorageInstances | Delete a block storage instance. |
Snapshot
The following describes the snapshot-related APIs.
| API | Description |
|---|---|
| createBlockStorageSnapshotInstance | Create block storage snapshot instances. |
| getBlockStorageSnapshotInstanceDetail | Get block storage snapshot instance details. |
| getBlockStorageSnapshotInstanceList | Get the list of block storage snapshot instances. |
| deleteBlockStorageSnapshotInstances | Delete a block storage snapshot instance. |
Public IP
The following describes the public IP-related APIs.
| API | Description |
|---|---|
| createPublicIpInstance | Create public IP instances. |
| getPublicIpInstanceDetail | Get public IP instance details. |
| getPublicIpInstanceList | Get public IP instance list. |
| getPublicIpTargetServerInstanceList | Get the list of server instances to which public IP instances can be assigned. |
| associatePublicIpWithServerInstance | Assign public IP instance to a server instance. |
| disassociatePublicIpFromServerInstance | Remove public IP instance's assignment from a server instance. |
| deletePublicIpInstance | Delete public IP instance. |
Init Script
The following describes the init script-related APIs.
| API | Description |
|---|---|
| createInitScript | Create init script. |
| getInitScriptList | Get the list of init scripts. |
| getInitScriptDetail | Get init script details. |
| deleteInitScripts | Delete the list of init scripts. |
Network Interface
The following describes the APIs related to network interfaces.
| API | Description |
|---|---|
| createNetworkInterface | Create network interface. |
| getNetworkInterfaceDetail | Get network interface details. |
| getNetworkInterfaceList | Get the list of network interfaces. |
| attachNetworkInterface | Assign network interfaces to server instances. |
| detachNetworkInterface | Remove the network interface assigned to a server instance. |
| deleteNetworkInterface | Delete network interfaces. |
| addNetworkInterfaceAccessControlGroup | Add an ACG to be applied to a network interface. |
| removeNetworkInterfaceAccessControlGroup | Delete an ACG applied to a network interface. |
| assignSecondaryIps | Assign secondary IPs to network interfaces. |
| unassignSecondaryIps | Remove secondary IPs assigned to network interfaces. |
| getFlowLogConfigurationList | Get FlowLog configuration information. |
| disableFlowLog | Disable FlowLog. |
| enableFlowLog | Enable FlowLog. |
ACG
The following describes the APIs related to ACG.
| API | Description |
|---|---|
| createAccessControlGroup | Create ACG. |
| getAccessControlGroupDetail | Get ACG details. |
| getAccessControlGroupList | Get ACG list. |
| getAccessControlGroupRuleList | Get ACG rule list. |
| addAccessControlGroupInboundRule | Add an inbound rule of an ACG. |
| addAccessControlGroupOutboundRule | Add an outbound rule of an ACG. |
| removeAccessControlGroupInboundRule | Delete an inbound rule of an ACG. |
| removeAccessControlGroupOutboundRule | Delete an outbound rule of an ACG. |
| deleteAccessControlGroup | Delete ACG. |
Common
The following describes the common-related APIs.
| API | Description |
|---|---|
| getFabricClusterPoolList | Get available GPU Fabric cluster pools. |
| getHypervisorTypeList | Get hypervisor type list. |
| getRaidList | Get the list of available RAIDs. |
| getRegionList | Get Region list |
| getServerImageProductList | Get server image product list. |
| getServerProductList | Get server specification product list. |
| getServerSpecDetail | Get server specification details. |
| getServerSpecList | Get server specification list. |
| getZoneList | Get zone list. |
Server related resources
NAVER Cloud Platform provides a variety of related resources to help users better understand Server APIs.
- Server API guides
- Create signature: how to create a signature to add to the request header
- Sub Account User Guides: how to issue the access key to be added to the request header
- Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Server service
- Server service guides
- Server User Guides: how to use Server in the NAVER Cloud Platform console
- Ncloud use environment guide: guide on VPC and Classic platforms and supported features
- Introduction to pricing, characteristics, and detailed features: Summary of Server's pricing system, as well as the characteristics and detailed features
- Latest service news: the latest updates on Server
- FAQ: frequently asked questions from Server users
- Support: Send direct inquiries for unresolved questions that aren't answered by the API guide.