Server (VPC) overview
- Print
- PDF
Server (VPC) overview
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Overview
NAVER Cloud Platform is a cloud service built on the latest in NAVER’s computing technologies and operational know-how.
The application program interfaces (APIs) that enable you to fully utilize the services and solutions provided by NAVER Cloud Platform are collectively referred to as NAVER Cloud Platform APIs.
NAVER Cloud Platform APIs are provided in RESTful form, and calls are made via HTTP request methods such as GET and POST.
Common settings
API URL
GET or POST
https://ncloud.apigw.ntruss.com/vserver/v2/
Request headers
| Header name | Description |
|---|---|
| x-ncp-apigw-timestamp | It indicates the time elapsed in milliseconds since January 1, 1970, 00:00:00 UTC. Request is considered invalid if the time difference with the API Gateway server is greater than 5 minutes. |
| x-ncp-iam-access-key | API Key issued from NAVER Cloud Platform or AccessKey issued from IAM |
| x-ncp-apigw-signature-v2 | A signature that encrypts the Body of the example above with the SecretKey mapped to AccessKey HmacSHA256 is used as the HMAC encryption algorithm. |
Operation
Common
| API name | Description |
|---|---|
| getRegionList | Searches for the Region list |
| getZoneList | Searches for the zone list |
| getServerImageProductList | Searches for the list of server image products provided by NAVER Cloud Platform |
| getServerProductList | Searches for the list of server spec products provided by NAVER Cloud Platform using server image product codes |
| getRaidList | Searches for the list of available RAID |
Login Key
| API name | Description |
|---|---|
| getLoginKeyList | Queries key for encrypting/decrypting passwords using the login key when connecting to a server instance (VM) |
| createLoginKey | Creates key for encrypting/decrypting passwords using the login key when connecting to a server instance (VM) |
| deleteLoginKeys | Deletes key for encrypting/decrypting passwords using the login key when connecting to a server instance (VM) |
| importLoginKey | Creates key for encrypting/decrypting passwords using the login key when connecting to a server instance (VM) Imports public key created by the user via ssh-keygen |
Placement Group
| API name | Description |
|---|---|
| getPlacementGroupList | Queries list of physical placement groups to which a server instance (VM) belongs |
| getPlacementGroupDetail | Queries physical placement group details using physical placement group number |
| createPlacementGroup | Creates physical placement group to which a server instance (VM) is assigned |
| deletePlacementGroup | Deletes physical placement group |
| addPlacementGroupServerInstance | Adds server instance to physical placement group |
| removePlacementGroupServerInstance | Removes server instance from physical placement group |
Server
| API name | Description |
|---|---|
| getServerInstanceList | Queries list of server instances (VM) |
| getServerInstanceDetail | Queries server instance details using server instance number |
| createServerInstances | Creates server instance (VM) |
| startServerInstances | Starts server instance (VM) currently in stopped state |
| stopServerInstances | Stops server instance (VM) currently in running state |
| rebootServerInstances | Reboots server instance (VM) currently in running state |
| terminateServerInstances | Terminates server instance (VM) currently in stopped state |
| changeServerInstanceSpec | Changes specifications of server instance (VM) currently in stopped state |
| getRootPassword | Queries password of root account using the login key of a server instance (VM) An encrypted password of the server instance is retrieved unless privateKey is entered. |
| getRootPasswordServerInstanceList | Queries password of root account in the form of a list using the login key of a server instance (VM) An encrypted password of the server instance is retrieved unless privateKey is entered |
| setProtectServerTermination | Sets server termination protection status |
Server Image
| API name | Description |
|---|---|
| getMemberServerImageInstanceList | Queries the list of a member’s server image instances |
| getMemberServerImageInstanceDetail | Queries a member’s server image instance details using the member’s server image instance number |
| createMemberServerImageInstance | Creates a member server image instance from a server instance in stopped or running state |
| deleteMemberServerImageInstances | Deletes the list of a member’s server image instances |
| setMemberServerImageSharingPermission | Sets sharing permission for a member’s server image |
| addMemberServerImageSharingPermission | Adds sharing permission for a member’s server image |
| removeMemberServerImageSharingPermission | Removes sharing permission for a member’s server image |
Storage
| API name | Description |
|---|---|
| getBlockStorageInstanceList | Queries list of block storage instances |
| getBlockStorageInstanceDetail | Queries block storage instance details using block storage instance number |
| createBlockStorageInstance | Creates block storage instance |
| deleteBlockStorageInstances | Deletes list of block storage instances |
| attachBlockStorageInstance | Attaches block storage instance to server instance |
| detachBlockStorageInstances | Detaches list of block storage instances from server instance |
| changeBlockStorageVolumeSize | Resizes block storage volume |
| setBlockStorageReturnProtection | Sets block storage termination protection status |
Snapshot
| API name | Description |
|---|---|
| getBlockStorageSnapshotInstanceList | Queries list of block storage snapshot instances |
| getBlockStorageSnapshotInstanceDetail | Queries block storage snapshot instance details using block storage snapshot instance number |
| createBlockStorageSnapshotInstance | Creates block storage snapshot instance |
| deleteBlockStorageSnapshotInstances | Deletes list of block storage snapshot instances |
Public IP
| API name | Description |
|---|---|
| getPublicIpInstanceList | Queries list of public IP instances |
| getPublicIpInstanceDetail | Queries public IP instance details using public IP instance number |
| createPublicIpInstance | Creates public IP instance |
| deletePublicIpInstance | Deletes public IP instance |
| getPublicIpTargetServerInstanceList | Queries list of server instances to which public IP instances can be assigned |
| associatePublicIpWithServerInstance | Associates public IP instance to server instance |
| disassociatePublicIpFromServerInstance | Disassociates public IP instance from server instance |
Init Script
| API name | Description |
|---|---|
| getInitScriptList | Queries list of user-created initialization scripts |
| getInitScriptDetail | Queries initialization script details using initialization script number |
| createInitScript | Creates initialization script |
| deleteInitScripts | Deletes list of initialization scripts |
Network Interface
| API name | Description |
|---|---|
| getNetworkInterfaceList | Queries list of network interfaces |
| getNetworkInterfaceDetail | Queries network interface details using network interface number |
| createNetworkInterface | Creates network interface |
| deleteNetworkInterface | Deletes network interface |
| attachNetworkInterface | Attaches network interface to server instance Up to 3 network interfaces can be attached, including the server instance's primary network interface. |
| detachNetworkInterface | Detaches network interface attached to server instance The primary network interface of a server instance cannot be detached. |
| addNetworkInterfaceAccessControlGroup | - Adds list of ACGs to be applied to a network interface - Up to 3 ACGs can be applied per network interface |
| removeNetworkInterfaceAccessControlGroup | - Removes list of ACGs applied to network interface - At least 1 ACG must be applied per network interface |
| assignSecondaryIps | Assigns secondary IP to network interface |
| unassignSecondaryIps | Unassigns secondary IP assigned to network interface |
| enableFlowLog | Enable FlowLog |
| disableFlowLog | Disable FlowLog |
| getFlowLogConfigurationList | Queries FlowLog setting information |
ACG
| API name | Description |
|---|---|
| getAccessControlGroupList | Queries ACG list An ACG can be set on a network interface to control access |
| getAccessControlGroupDetail | Queries ACG details using ACG number |
| createAccessControlGroup | Creates ACG |
| deleteAccessControlGroup | Deletes ACG |
| getAccessControlGroupRuleList | Queries ACG rule list using ACG number |
| addAccessControlGroupInboundRule | Adds inbound rule list to ACG |
| addAccessControlGroupOutboundRule | Adds outbound rule list to ACG |
| removeAccessControlGroupInboundRule | Removes inbound rule list from ACG |
| removeAccessControlGroupOutboundRule | Removes outbound rule list from ACG |
Was this article helpful?