Skip to content

Latest commit

 

History

History
503 lines (464 loc) · 41.3 KB

README.md

File metadata and controls

503 lines (464 loc) · 41.3 KB
Raw

vserver

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
	<groupId>com.ncloud</groupId>
	<artifactId>vserver</artifactId>
	<version>1.1.2</version>
	<scope>compile</scope>
</dependency>

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/vserver-1.1.2.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and create a credentials properties file.

type=iam
apiKey=your-api-key
accessKey=your-access-key
secretKey=your-secret-key

And execute the following Java code:

import java.io.InputStream;
import java.util.List;
import java.util.Map;

import com.ncloud.ApiClient;
import com.ncloud.ApiResponse;
import com.ncloud.auth.PropertiesFileCredentialsProvider;
import com.ncloud.exception.ApiException;
import com.ncloud.exception.SdkException;
import com.ncloud.marshaller.FormMarshaller;
import com.ncloud.marshaller.JsonMarshaller;
import com.ncloud.marshaller.XmlMarshaller;
import com.ncloud.vserver.model.*;

public class V2ApiExample {

	public static void main(String[] args) {
		ApiClient apiClient = new ApiClient.ApiClientBuilder()
			.addMarshaller(JsonMarshaller.getInstance())
			.addMarshaller(XmlMarshaller.getInstance())
			.addMarshaller(FormMarshaller.getInstance())
			.setCredentialsProvider(new PropertiesFileCredentialsProvider("your-credentials-properties-file"))
			.setLogging(true)
			.build();

		V2Api apiInstance = new V2Api(apiClient);
		AddAccessControlGroupInboundRuleRequest addAccessControlGroupInboundRuleRequest = new AddAccessControlGroupInboundRuleRequest(); // AddAccessControlGroupInboundRuleRequest | addAccessControlGroupInboundRuleRequest
		try {
			// Handler Successful response
			ApiResponse<AddAccessControlGroupInboundRuleResponse> result = apiInstance.addAccessControlGroupInboundRuleGet(addAccessControlGroupInboundRuleRequest);
		} catch (ApiException e) {
			// Handler Failed response
			int statusCode = e.getHttpStatusCode();
			Map<String, List<String>> responseHeaders = e.getHttpHeaders();
			InputStream byteStream = e.getByteStream();
			e.printStackTrace();
		} catch (SdkException e) {
			// Handle exceptions that occurred before communication with the server
			e.printStackTrace();
		}
	}
}

Documentation for API Endpoints

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

Class Method HTTP request Description
V2Api addAccessControlGroupInboundRuleGet GET /addAccessControlGroupInboundRule
V2Api addAccessControlGroupInboundRulePost POST /addAccessControlGroupInboundRule
V2Api addAccessControlGroupOutboundRuleGet GET /addAccessControlGroupOutboundRule
V2Api addAccessControlGroupOutboundRulePost POST /addAccessControlGroupOutboundRule
V2Api addMemberServerImageSharingPermissionGet GET /addMemberServerImageSharingPermission
V2Api addMemberServerImageSharingPermissionPost POST /addMemberServerImageSharingPermission
V2Api addNetworkInterfaceAccessControlGroupGet GET /addNetworkInterfaceAccessControlGroup
V2Api addNetworkInterfaceAccessControlGroupPost POST /addNetworkInterfaceAccessControlGroup
V2Api addPlacementGroupServerInstanceGet GET /addPlacementGroupServerInstance
V2Api addPlacementGroupServerInstancePost POST /addPlacementGroupServerInstance
V2Api addServerImageSharingPermissionGet GET /addServerImageSharingPermission
V2Api addServerImageSharingPermissionPost POST /addServerImageSharingPermission
V2Api assignSecondaryIpsGet GET /assignSecondaryIps
V2Api assignSecondaryIpsPost POST /assignSecondaryIps
V2Api associatePublicIpWithServerInstanceGet GET /associatePublicIpWithServerInstance
V2Api associatePublicIpWithServerInstancePost POST /associatePublicIpWithServerInstance
V2Api attachBlockStorageInstanceGet GET /attachBlockStorageInstance
V2Api attachBlockStorageInstancePost POST /attachBlockStorageInstance
V2Api attachNetworkInterfaceGet GET /attachNetworkInterface
V2Api attachNetworkInterfacePost POST /attachNetworkInterface
V2Api changeBlockStorageInstanceGet GET /changeBlockStorageInstance
V2Api changeBlockStorageInstancePost POST /changeBlockStorageInstance
V2Api changeBlockStorageVolumeSizeGet GET /changeBlockStorageVolumeSize
V2Api changeBlockStorageVolumeSizePost POST /changeBlockStorageVolumeSize
V2Api changeServerInstanceSpecGet GET /changeServerInstanceSpec
V2Api changeServerInstanceSpecPost POST /changeServerInstanceSpec
V2Api createAccessControlGroupGet GET /createAccessControlGroup
V2Api createAccessControlGroupPost POST /createAccessControlGroup
V2Api createBlockStorageInstanceGet GET /createBlockStorageInstance
V2Api createBlockStorageInstancePost POST /createBlockStorageInstance
V2Api createBlockStorageSnapshotInstanceGet GET /createBlockStorageSnapshotInstance
V2Api createBlockStorageSnapshotInstancePost POST /createBlockStorageSnapshotInstance
V2Api createInitScriptGet GET /createInitScript
V2Api createInitScriptPost POST /createInitScript
V2Api createLoginKeyGet GET /createLoginKey
V2Api createLoginKeyPost POST /createLoginKey
V2Api createMemberServerImageInstanceGet GET /createMemberServerImageInstance
V2Api createMemberServerImageInstancePost POST /createMemberServerImageInstance
V2Api createNetworkInterfaceGet GET /createNetworkInterface
V2Api createNetworkInterfacePost POST /createNetworkInterface
V2Api createPlacementGroupGet GET /createPlacementGroup
V2Api createPlacementGroupPost POST /createPlacementGroup
V2Api createPublicIpInstanceGet GET /createPublicIpInstance
V2Api createPublicIpInstancePost POST /createPublicIpInstance
V2Api createServerImageFromSnapshotGet GET /createServerImageFromSnapshot
V2Api createServerImageFromSnapshotPost POST /createServerImageFromSnapshot
V2Api createServerImageGet GET /createServerImage
V2Api createServerImagePost POST /createServerImage
V2Api createServerInstancesGet GET /createServerInstances
V2Api createServerInstancesPost POST /createServerInstances
V2Api deleteAccessControlGroupGet GET /deleteAccessControlGroup
V2Api deleteAccessControlGroupPost POST /deleteAccessControlGroup
V2Api deleteBlockStorageInstancesGet GET /deleteBlockStorageInstances
V2Api deleteBlockStorageInstancesPost POST /deleteBlockStorageInstances
V2Api deleteBlockStorageSnapshotInstancesGet GET /deleteBlockStorageSnapshotInstances
V2Api deleteBlockStorageSnapshotInstancesPost POST /deleteBlockStorageSnapshotInstances
V2Api deleteInitScriptsGet GET /deleteInitScripts
V2Api deleteInitScriptsPost POST /deleteInitScripts
V2Api deleteLoginKeysGet GET /deleteLoginKeys
V2Api deleteLoginKeysPost POST /deleteLoginKeys
V2Api deleteMemberServerImageInstancesGet GET /deleteMemberServerImageInstances
V2Api deleteMemberServerImageInstancesPost POST /deleteMemberServerImageInstances
V2Api deleteNetworkInterfaceGet GET /deleteNetworkInterface
V2Api deleteNetworkInterfacePost POST /deleteNetworkInterface
V2Api deletePlacementGroupGet GET /deletePlacementGroup
V2Api deletePlacementGroupPost POST /deletePlacementGroup
V2Api deletePublicIpInstanceGet GET /deletePublicIpInstance
V2Api deletePublicIpInstancePost POST /deletePublicIpInstance
V2Api deleteServerImageGet GET /deleteServerImage
V2Api deleteServerImagePost POST /deleteServerImage
V2Api detachBlockStorageInstancesGet GET /detachBlockStorageInstances
V2Api detachBlockStorageInstancesPost POST /detachBlockStorageInstances
V2Api detachNetworkInterfaceGet GET /detachNetworkInterface
V2Api detachNetworkInterfacePost POST /detachNetworkInterface
V2Api disableFlowLogGet GET /disableFlowLog
V2Api disableFlowLogPost POST /disableFlowLog
V2Api disassociatePublicIpFromServerInstanceGet GET /disassociatePublicIpFromServerInstance
V2Api disassociatePublicIpFromServerInstancePost POST /disassociatePublicIpFromServerInstance
V2Api enableFlowLogGet GET /enableFlowLog
V2Api enableFlowLogPost POST /enableFlowLog
V2Api getAccessControlGroupDetailGet GET /getAccessControlGroupDetail
V2Api getAccessControlGroupDetailPost POST /getAccessControlGroupDetail
V2Api getAccessControlGroupListGet GET /getAccessControlGroupList
V2Api getAccessControlGroupListPost POST /getAccessControlGroupList
V2Api getAccessControlGroupRuleListGet GET /getAccessControlGroupRuleList
V2Api getAccessControlGroupRuleListPost POST /getAccessControlGroupRuleList
V2Api getBlockStorageInstanceDetailGet GET /getBlockStorageInstanceDetail
V2Api getBlockStorageInstanceDetailPost POST /getBlockStorageInstanceDetail
V2Api getBlockStorageInstanceListGet GET /getBlockStorageInstanceList
V2Api getBlockStorageInstanceListPost POST /getBlockStorageInstanceList
V2Api getBlockStorageSnapshotInstanceDetailGet GET /getBlockStorageSnapshotInstanceDetail
V2Api getBlockStorageSnapshotInstanceDetailPost POST /getBlockStorageSnapshotInstanceDetail
V2Api getBlockStorageSnapshotInstanceListGet GET /getBlockStorageSnapshotInstanceList
V2Api getBlockStorageSnapshotInstanceListPost POST /getBlockStorageSnapshotInstanceList
V2Api getBlockStorageVolumeTypeListGet GET /getBlockStorageVolumeTypeList
V2Api getBlockStorageVolumeTypeListPost POST /getBlockStorageVolumeTypeList
V2Api getFlowLogConfigurationListGet GET /getFlowLogConfigurationList
V2Api getFlowLogConfigurationListPost POST /getFlowLogConfigurationList
V2Api getHypervisorTypeListGet GET /getHypervisorTypeList
V2Api getHypervisorTypeListPost POST /getHypervisorTypeList
V2Api getInitScriptDetailGet GET /getInitScriptDetail
V2Api getInitScriptDetailPost POST /getInitScriptDetail
V2Api getInitScriptListGet GET /getInitScriptList
V2Api getInitScriptListPost POST /getInitScriptList
V2Api getLoginKeyListGet GET /getLoginKeyList
V2Api getLoginKeyListPost POST /getLoginKeyList
V2Api getMemberServerImageInstanceDetailGet GET /getMemberServerImageInstanceDetail
V2Api getMemberServerImageInstanceDetailPost POST /getMemberServerImageInstanceDetail
V2Api getMemberServerImageInstanceListGet GET /getMemberServerImageInstanceList
V2Api getMemberServerImageInstanceListPost POST /getMemberServerImageInstanceList
V2Api getNetworkInterfaceDetailGet GET /getNetworkInterfaceDetail
V2Api getNetworkInterfaceDetailPost POST /getNetworkInterfaceDetail
V2Api getNetworkInterfaceListGet GET /getNetworkInterfaceList
V2Api getNetworkInterfaceListPost POST /getNetworkInterfaceList
V2Api getPlacementGroupDetailGet GET /getPlacementGroupDetail
V2Api getPlacementGroupDetailPost POST /getPlacementGroupDetail
V2Api getPlacementGroupListGet GET /getPlacementGroupList
V2Api getPlacementGroupListPost POST /getPlacementGroupList
V2Api getPublicIpInstanceDetailGet GET /getPublicIpInstanceDetail
V2Api getPublicIpInstanceDetailPost POST /getPublicIpInstanceDetail
V2Api getPublicIpInstanceListGet GET /getPublicIpInstanceList
V2Api getPublicIpInstanceListPost POST /getPublicIpInstanceList
V2Api getPublicIpTargetServerInstanceListGet GET /getPublicIpTargetServerInstanceList
V2Api getPublicIpTargetServerInstanceListPost POST /getPublicIpTargetServerInstanceList
V2Api getRaidListGet GET /getRaidList
V2Api getRaidListPost POST /getRaidList
V2Api getRegionListGet GET /getRegionList
V2Api getRegionListPost POST /getRegionList
V2Api getRootPasswordGet GET /getRootPassword
V2Api getRootPasswordPost POST /getRootPassword
V2Api getRootPasswordServerInstanceListGet GET /getRootPasswordServerInstanceList
V2Api getRootPasswordServerInstanceListPost POST /getRootPasswordServerInstanceList
V2Api getServerImageDetailGet GET /getServerImageDetail
V2Api getServerImageDetailPost POST /getServerImageDetail
V2Api getServerImageListGet GET /getServerImageList
V2Api getServerImageListPost POST /getServerImageList
V2Api getServerImageProductListGet GET /getServerImageProductList
V2Api getServerImageProductListPost POST /getServerImageProductList
V2Api getServerInstanceDetailGet GET /getServerInstanceDetail
V2Api getServerInstanceDetailPost POST /getServerInstanceDetail
V2Api getServerInstanceListGet GET /getServerInstanceList
V2Api getServerInstanceListPost POST /getServerInstanceList
V2Api getServerProductListGet GET /getServerProductList
V2Api getServerProductListPost POST /getServerProductList
V2Api getServerSpecDetailGet GET /getServerSpecDetail
V2Api getServerSpecDetailPost POST /getServerSpecDetail
V2Api getServerSpecListGet GET /getServerSpecList
V2Api getServerSpecListPost POST /getServerSpecList
V2Api getZoneListGet GET /getZoneList
V2Api getZoneListPost POST /getZoneList
V2Api importLoginKeyGet GET /importLoginKey
V2Api importLoginKeyPost POST /importLoginKey
V2Api interruptServerInstanceGet GET /interruptServerInstance
V2Api interruptServerInstancePost POST /interruptServerInstance
V2Api rebootServerInstancesGet GET /rebootServerInstances
V2Api rebootServerInstancesPost POST /rebootServerInstances
V2Api removeAccessControlGroupInboundRuleGet GET /removeAccessControlGroupInboundRule
V2Api removeAccessControlGroupInboundRulePost POST /removeAccessControlGroupInboundRule
V2Api removeAccessControlGroupOutboundRuleGet GET /removeAccessControlGroupOutboundRule
V2Api removeAccessControlGroupOutboundRulePost POST /removeAccessControlGroupOutboundRule
V2Api removeMemberServerImageSharingPermissionGet GET /removeMemberServerImageSharingPermission
V2Api removeMemberServerImageSharingPermissionPost POST /removeMemberServerImageSharingPermission
V2Api removeNetworkInterfaceAccessControlGroupGet GET /removeNetworkInterfaceAccessControlGroup
V2Api removeNetworkInterfaceAccessControlGroupPost POST /removeNetworkInterfaceAccessControlGroup
V2Api removePlacementGroupServerInstanceGet GET /removePlacementGroupServerInstance
V2Api removePlacementGroupServerInstancePost POST /removePlacementGroupServerInstance
V2Api removeServerImageSharingPermissionGet GET /removeServerImageSharingPermission
V2Api removeServerImageSharingPermissionPost POST /removeServerImageSharingPermission
V2Api setBlockStorageReturnProtectionGet GET /setBlockStorageReturnProtection
V2Api setBlockStorageReturnProtectionPost POST /setBlockStorageReturnProtection
V2Api setMemberServerImageSharingPermissionGet GET /setMemberServerImageSharingPermission
V2Api setMemberServerImageSharingPermissionPost POST /setMemberServerImageSharingPermission
V2Api setProtectServerTerminationGet GET /setProtectServerTermination
V2Api setProtectServerTerminationPost POST /setProtectServerTermination
V2Api startServerInstancesGet GET /startServerInstances
V2Api startServerInstancesPost POST /startServerInstances
V2Api stopServerInstancesGet GET /stopServerInstances
V2Api stopServerInstancesPost POST /stopServerInstances
V2Api terminateServerInstancesGet GET /terminateServerInstances
V2Api terminateServerInstancesPost POST /terminateServerInstances
V2Api unassignSecondaryIpsGet GET /unassignSecondaryIps
V2Api unassignSecondaryIpsPost POST /unassignSecondaryIps

Documentation for Models

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author