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, access control group (ACG), and Fabric cluster 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 information about the HTTP 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 authentication key-related APIs.
| API | Description |
|---|---|
| createLoginKey | Create authentication key. |
| importLoginKey | Import a public key generated by the user as an authentication key. |
| getLoginKeyList | Get authentication key list. |
| deleteLoginKeys | Delete authentication key. |
ACG
The following describes the APIs related to the access control group (ACG).
| API | Description |
|---|---|
| createAccessControlGroup | Create ACG. |
| getAccessControlGroupList | Get ACG list. |
| getAccessControlGroupDetail | Get ACG details. |
| getAccessControlGroupRuleList | Get the list of ACG rules. |
| addAccessControlGroupInboundRule | Add an inbound rule to ACG. |
| removeAccessControlGroupInboundRule | Delete an inbound rule from ACG. |
| addAccessControlGroupOutboundRule | Add an outbound rule to ACG. |
| removeAccessControlGroupOutboundRule | Delete an outbound rule from ACG. |
| deleteAccessControlGroup | Delete ACG. |
Init Script
The following describes the APIs related to init scripts.
| API | Description |
|---|---|
| createInitScript | Create init script. |
| getInitScriptList | Get the list of init scripts. |
| getInitScriptDetail | Get init script details. |
| deleteInitScripts | Delete initialization script. |
Placement Group
The following describes the APIs related to physical placement groups.
| API | Description |
|---|---|
| createPlacementGroup | Create a physical placement group where the server instance belongs. |
| getPlacementGroupList | Get physical placement group list. |
| getPlacementGroupDetail | Get details of physical placement group |
| addPlacementGroupServerInstance | Add server instance to a physical placement group. |
| removePlacementGroupServerInstance | Remove server instance from a physical placement group. |
| deletePlacementGroup | Delete physical placement group. |
Server Image
The following describes the APIs related to server images.
| API | Description |
|---|---|
| createServerImage | Create a server image with a server instance. |
| createServerImageFromSnapshot | Create a server image with a snapshot. |
| getServerImageList | Get server image list. |
| getServerImageDetail | Get detailed information about server image. |
| addServerImageSharingPermission | Add sharing permissions to a server image. |
| removeServerImageSharingPermission | Delete sharing permissions from a server image. |
| deleteServerImage | Delete server image |
| createMemberServerImageInstance | Create a member server image with a server instance. |
| getMemberServerImageInstanceList | Get member server image list. |
| getMemberServerImageInstanceDetail | Get member server image details. |
| addMemberServerImageSharingPermission | Add sharing permission to a member server image. |
| setMemberServerImageSharingPermission | Set sharing permissions for a member server image. |
| removeMemberServerImageSharingPermission | Delete sharing permissions from a member server image. |
| deleteMemberServerImageInstances | Delete a member server image. |
Server Instance
The following describes the server instance-related APIs.
| API | Description |
|---|---|
| createServerInstances | Create a server instance. |
| getServerInstanceList | Get server instance list. |
| getServerInstanceDetail | Get server instance details. |
| getRootPasswordServerInstanceList | Get the admin password list using the authentication key of a server instance. |
| getRootPassword | Get the admin password using the authentication key of a server instance. |
| changeServerInstanceName | Change the server instance name. |
| changeServerInstanceSpec | Change the server instance specifications. |
| setProtectServerTermination | Set server instance termination protection status. |
| startServerInstances | Start server instance in the Stopped status. |
| stopServerInstances | Stop server instance in the Running status. |
| rebootServerInstances | Restart server instance in the Running status. |
| interruptServerInstance | Run a diagnostic interrupt to analyze the status of a server instance. |
| terminateServerInstances | Terminate a server instance in the Stopped status. |
Network Interface
The following describes the network interface-related APIs.
| API | Description |
|---|---|
| createNetworkInterface | Create network interfaces. |
| getNetworkInterfaceList | Get the list of network interfaces. |
| getNetworkInterfaceDetail | Get network interface details. |
| attachNetworkInterface | Assign a network interface to a server instance. |
| detachNetworkInterface | Remove the network interface assigned to a server instance. |
| addNetworkInterfaceAccessControlGroup | Add an ACG to a network interface. |
| removeNetworkInterfaceAccessControlGroup | Delete an ACG from a network interface. |
| assignSecondaryIps | Assign secondary IPs to network interfaces. |
| unassignSecondaryIps | Remove a secondary IP assigned to a network interface. |
| enableFlowLog | Enable Flow Log. |
| getFlowLogConfigurationList | Get Flow Log configuration information. |
| disableFlowLog | Disable Flow Log. |
| deleteNetworkInterface | Delete network interfaces. |
Public IP
The following describes the public IP-related APIs.
| API | Description |
|---|---|
| createPublicIpInstance | Create public IP instance. |
| getPublicIpInstanceList | Get public IP instance list. |
| getPublicIpInstanceDetail | Get public IP instance details. |
| 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. |
Storage
The following describes the storage-related APIs.
| API | Description |
|---|---|
| createBlockStorageInstance | Create block storage instance. |
| getBlockStorageInstanceList | Get the list of block storage instances. |
| getBlockStorageInstanceDetail | Get block storage instance details. |
| getBlockStorageVolumeTypeList | Get the list of block storage volume types. |
| attachBlockStorageInstance | Assign block storage instance to a server instance. |
| detachBlockStorageInstances | Remove the list of block storage instances assigned to a server instance. |
| changeBlockStorageInstance | Change block storage volume size. |
| changeBlockStorageVolumeSize | Change block storage volume size. |
| 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 instance. |
| getBlockStorageSnapshotInstanceList | Get the list of block storage snapshot instances. |
| getBlockStorageSnapshotInstanceDetail | Get block storage snapshot instance details. |
| deleteBlockStorageSnapshotInstances | Delete a block storage snapshot instance. |
Fabric Cluster
The following describes the APIs related to Fabric cluster.
| API | Description |
|---|---|
| createFabricCluster | Create Fabric cluster. |
| getFabricClusterPoolList | Get the Fabric cluster pool list. |
| getFabricClusterList | Get Fabric cluster list. |
| getFabricClusterDetail | Get Fabric cluster details. |
| changeFabricClusterName | Change Fabric cluster name. |
| changeFabricClusterDescription | Change Fabric cluster description. |
| changeFabricClusterServerInstances | Change the list of server instances in Fabric cluster. |
| deleteFabricCluster | Delete Fabric cluster. |
Common
The following describes the common query APIs referenced when creating resources.
| API | Description |
|---|---|
| getRegionList | Get Region list. |
| getZoneList | Get zone list. |
| getServerImageProductList | Get server image product list. |
| getServerProductList | Get the server product list. |
| getServerSpecList | Get server specification list. |
| getServerSpecDetail | Get server specification details. |
| getHypervisorTypeList | Get the hypervisor type list. |
| getRaidList | Get RAID 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 guide: 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 guide: How to use Server in the NAVER Cloud Platform console
- Ncloud user environment guide: Explore VPC and Classic environments and supported services.
- Pricing and features: View pricing details and key capabilities.
- Latest announcements: Stay informed about service updates and news.
- FAQs: Get answers to common Server questions.
- Contact Support: Get help if you can't find what you need in the API guide.