ncloud-server

Installation

For Node.js

npm

npm install ncloud-server --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var Server = require('ncloud-server');

var client = new Server.ApiClient({
  accessKey: 'your access key',
  secretKey: 'your secret key',
});

var apiInstance = new Server.V2Api(client)

var addNasVolumeAccessControlRequest = new Server.AddNasVolumeAccessControlRequest(); // {AddNasVolumeAccessControlRequest} addNasVolumeAccessControlRequest


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addNasVolumeAccessControl(addNasVolumeAccessControlRequest, callback);

Documentation for API Endpoints

All URIs are relative to https://ncloud.apigw.ntruss.com/server/v2

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- Server.V2Api | addNasVolumeAccessControl | POST /addNasVolumeAccessControl | Server.V2Api | addPortForwardingRules | POST /addPortForwardingRules | Server.V2Api | associatePublicIpWithServerInstance | POST /associatePublicIpWithServerInstance | Server.V2Api | attachBlockStorageInstance | POST /attachBlockStorageInstance | Server.V2Api | attachNetworkInterface | POST /attachNetworkInterface | Server.V2Api | changeBlockStorageVolumeSize | POST /changeBlockStorageVolumeSize | Server.V2Api | changeNasVolumeSize | POST /changeNasVolumeSize | Server.V2Api | changeServerInstanceSpec | POST /changeServerInstanceSpec | Server.V2Api | createBlockStorageInstance | POST /createBlockStorageInstance | Server.V2Api | createBlockStorageSnapshotInstance | POST /createBlockStorageSnapshotInstance | Server.V2Api | createInstanceTags | POST /createInstanceTags | Server.V2Api | createLoginKey | POST /createLoginKey | Server.V2Api | createMemberServerImage | POST /createMemberServerImage | Server.V2Api | createNasVolumeInstance | POST /createNasVolumeInstance | Server.V2Api | createNetworkInterface | POST /createNetworkInterface | Server.V2Api | createPublicIpInstance | POST /createPublicIpInstance | Server.V2Api | createServerInstances | POST /createServerInstances | Server.V2Api | deleteBlockStorageInstances | POST /deleteBlockStorageInstances | Server.V2Api | deleteBlockStorageSnapshotInstances | POST /deleteBlockStorageSnapshotInstances | Server.V2Api | deleteInstanceTags | POST /deleteInstanceTags | Server.V2Api | deleteLoginKey | POST /deleteLoginKey | Server.V2Api | deleteMemberServerImages | POST /deleteMemberServerImages | Server.V2Api | deleteNasVolumeInstance | POST /deleteNasVolumeInstance | Server.V2Api | deleteNetworkInterface | POST /deleteNetworkInterface | Server.V2Api | deletePortForwardingRules | POST /deletePortForwardingRules | Server.V2Api | deletePublicIpInstances | POST /deletePublicIpInstances | Server.V2Api | detachBlockStorageInstances | POST /detachBlockStorageInstances | Server.V2Api | detachNetworkInterface | POST /detachNetworkInterface | Server.V2Api | disassociatePublicIpFromServerInstance | POST /disassociatePublicIpFromServerInstance | Server.V2Api | getAccessControlGroupList | POST /getAccessControlGroupList | Server.V2Api | getAccessControlGroupServerInstanceList | POST /getAccessControlGroupServerInstanceList | Server.V2Api | getAccessControlRuleList | POST /getAccessControlRuleList | Server.V2Api | getBlockStorageInstanceList | POST /getBlockStorageInstanceList | Server.V2Api | getBlockStorageSnapshotInstanceList | POST /getBlockStorageSnapshotInstanceList | Server.V2Api | getInitScriptList | POST /getInitScriptList | Server.V2Api | getInstanceTagList | POST /getInstanceTagList | Server.V2Api | getLoginKeyList | POST /getLoginKeyList | Server.V2Api | getMemberServerImageList | POST /getMemberServerImageList | Server.V2Api | getNasVolumeInstanceList | POST /getNasVolumeInstanceList | Server.V2Api | getNasVolumeInstanceRatingList | POST /getNasVolumeInstanceRatingList | Server.V2Api | getNetworkInterfaceList | POST /getNetworkInterfaceList | Server.V2Api | getPortForwardingRuleList | POST /getPortForwardingRuleList | Server.V2Api | getPrivateSubnetInstanceList | POST /getPrivateSubnetInstanceList | Server.V2Api | getPublicIpInstanceList | POST /getPublicIpInstanceList | Server.V2Api | getPublicIpTargetServerInstanceList | POST /getPublicIpTargetServerInstanceList | Server.V2Api | getRaidList | POST /getRaidList | Server.V2Api | getRegionList | POST /getRegionList | Server.V2Api | getRootPassword | POST /getRootPassword | Server.V2Api | getRootPasswordServerInstanceList | POST /getRootPasswordServerInstanceList | Server.V2Api | getServerImageProductList | POST /getServerImageProductList | Server.V2Api | getServerInstanceList | POST /getServerInstanceList | Server.V2Api | getServerProductList | POST /getServerProductList | Server.V2Api | getZoneList | POST /getZoneList | Server.V2Api | importLoginKey | POST /importLoginKey | Server.V2Api | rebootServerInstances | POST /rebootServerInstances | Server.V2Api | recreateServerInstance | POST /recreateServerInstance | Server.V2Api | removeNasVolumeAccessControl | POST /removeNasVolumeAccessControl | Server.V2Api | replaceServerInstanceAssociatedWithPublicIp | POST /replaceServerInstanceAssociatedWithPublicIp | Server.V2Api | setNasVolumeAccessControl | POST /setNasVolumeAccessControl | Server.V2Api | startServerInstances | POST /startServerInstances | Server.V2Api | stopServerInstances | POST /stopServerInstances | Server.V2Api | terminateServerInstances | POST /terminateServerInstances |

Documentation for Models

• Server.AccessControlGroup
• Server.AccessControlRule
• Server.AddNasVolumeAccessControlRequest
• Server.AddNasVolumeAccessControlResponse
• Server.AddPortForwardingRulesRequest
• Server.AddPortForwardingRulesResponse
• Server.AssociatePublicIpWithServerInstanceRequest
• Server.AssociatePublicIpWithServerInstanceResponse
• Server.AttachBlockStorageInstanceRequest
• Server.AttachBlockStorageInstanceResponse
• Server.AttachNetworkInterfaceRequest
• Server.AttachNetworkInterfaceResponse
• Server.BlockStorageInstance
• Server.BlockStorageSnapshotInstance
• Server.ChangeBlockStorageVolumeSizeRequest
• Server.ChangeBlockStorageVolumeSizeResponse
• Server.ChangeNasVolumeSizeRequest
• Server.ChangeNasVolumeSizeResponse
• Server.ChangeServerInstanceSpecRequest
• Server.ChangeServerInstanceSpecResponse
• Server.CommonCode
• Server.CreateBlockStorageInstanceRequest
• Server.CreateBlockStorageInstanceResponse
• Server.CreateBlockStorageSnapshotInstanceRequest
• Server.CreateBlockStorageSnapshotInstanceResponse
• Server.CreateInstanceTagsRequest
• Server.CreateInstanceTagsResponse
• Server.CreateLoginKeyRequest
• Server.CreateLoginKeyResponse
• Server.CreateMemberServerImageRequest
• Server.CreateMemberServerImageResponse
• Server.CreateNasVolumeInstanceRequest
• Server.CreateNasVolumeInstanceResponse
• Server.CreateNetworkInterfaceRequest
• Server.CreateNetworkInterfaceResponse
• Server.CreatePublicIpInstanceRequest
• Server.CreatePublicIpInstanceResponse
• Server.CreateServerInstancesRequest
• Server.CreateServerInstancesResponse
• Server.DeleteBlockStorageInstancesRequest
• Server.DeleteBlockStorageInstancesResponse
• Server.DeleteBlockStorageSnapshotInstancesRequest
• Server.DeleteBlockStorageSnapshotInstancesResponse
• Server.DeleteInstanceTagsRequest
• Server.DeleteInstanceTagsResponse
• Server.DeleteLoginKeyRequest
• Server.DeleteLoginKeyResponse
• Server.DeleteMemberServerImagesRequest
• Server.DeleteMemberServerImagesResponse
• Server.DeleteNasVolumeInstanceRequest
• Server.DeleteNasVolumeInstanceResponse
• Server.DeleteNetworkInterfaceRequest
• Server.DeleteNetworkInterfaceResponse
• Server.DeletePortForwardingRulesRequest
• Server.DeletePortForwardingRulesResponse
• Server.DeletePublicIpInstancesRequest
• Server.DeletePublicIpInstancesResponse
• Server.DetachBlockStorageInstancesRequest
• Server.DetachBlockStorageInstancesResponse
• Server.DetachNetworkInterfaceRequest
• Server.DetachNetworkInterfaceResponse
• Server.DisassociatePublicIpFromServerInstanceRequest
• Server.DisassociatePublicIpFromServerInstanceResponse
• Server.GetAccessControlGroupListRequest
• Server.GetAccessControlGroupListResponse
• Server.GetAccessControlGroupServerInstanceListRequest
• Server.GetAccessControlGroupServerInstanceListResponse
• Server.GetAccessControlRuleListRequest
• Server.GetAccessControlRuleListResponse
• Server.GetBlockStorageInstanceListRequest
• Server.GetBlockStorageInstanceListResponse
• Server.GetBlockStorageSnapshotInstanceListRequest
• Server.GetBlockStorageSnapshotInstanceListResponse
• Server.GetInitScriptListRequest
• Server.GetInitScriptListResponse
• Server.GetInstanceTagListRequest
• Server.GetInstanceTagListResponse
• Server.GetLoginKeyListRequest
• Server.GetLoginKeyListResponse
• Server.GetMemberServerImageListRequest
• Server.GetMemberServerImageListResponse
• Server.GetNasVolumeInstanceListRequest
• Server.GetNasVolumeInstanceListResponse
• Server.GetNasVolumeInstanceRatingListRequest
• Server.GetNasVolumeInstanceRatingListResponse
• Server.GetNetworkInterfaceListRequest
• Server.GetNetworkInterfaceListResponse
• Server.GetPortForwardingRuleListRequest
• Server.GetPortForwardingRuleListResponse
• Server.GetPrivateSubnetInstanceListRequest
• Server.GetPrivateSubnetInstanceListResponse
• Server.GetPublicIpInstanceListRequest
• Server.GetPublicIpInstanceListResponse
• Server.GetPublicIpTargetServerInstanceListRequest
• Server.GetPublicIpTargetServerInstanceListResponse
• Server.GetRaidListRequest
• Server.GetRaidListResponse
• Server.GetRegionListRequest
• Server.GetRegionListResponse
• Server.GetRootPasswordRequest
• Server.GetRootPasswordResponse
• Server.GetRootPasswordServerInstanceListRequest
• Server.GetRootPasswordServerInstanceListResponse
• Server.GetServerImageProductListRequest
• Server.GetServerImageProductListResponse
• Server.GetServerInstanceListRequest
• Server.GetServerInstanceListResponse
• Server.GetServerProductListRequest
• Server.GetServerProductListResponse
• Server.GetZoneListRequest
• Server.GetZoneListResponse
• Server.ImportLoginKeyRequest
• Server.ImportLoginKeyResponse
• Server.InitScript
• Server.InstanceTag
• Server.InstanceTagParameter
• Server.LoginKey
• Server.MemberServerImage
• Server.NasVolumeInstance
• Server.NasVolumeInstanceCustomIp
• Server.NasVolumeInstanceRating
• Server.NetworkInterface
• Server.PortForwardingRule
• Server.PortForwardingRuleParameter
• Server.PrivateSubnetInstance
• Server.Product
• Server.PublicIpInstance
• Server.Raid
• Server.RebootServerInstancesRequest
• Server.RebootServerInstancesResponse
• Server.RecreateServerInstanceRequest
• Server.RecreateServerInstanceResponse
• Server.Region
• Server.RemoveNasVolumeAccessControlRequest
• Server.RemoveNasVolumeAccessControlResponse
• Server.ReplaceServerInstanceAssociatedWithPublicIpRequest
• Server.ReplaceServerInstanceAssociatedWithPublicIpResponse
• Server.RootPasswordServerInstance
• Server.RootPasswordServerInstanceParameter
• Server.ServerInstance
• Server.SetNasVolumeAccessControlRequest
• Server.SetNasVolumeAccessControlResponse
• Server.StartServerInstancesRequest
• Server.StartServerInstancesResponse
• Server.StopServerInstancesRequest
• Server.StopServerInstancesResponse
• Server.TerminateServerInstancesRequest
• Server.TerminateServerInstancesResponse
• Server.Zone

License

Copyright 2018 NAVER BUSINESS PLATFORM Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.