ServerInstance

Available in Classic

This is the server instance information.

Syntax

The syntax is as follows.

private String serverInstanceNo;
private String serverName;
private String serverDescription;
private Integer cpuCount;
private Long memorySize;
private Long baseBlockStorageSize;
private CommonCode platformType;
private String loginKeyName;
private Boolean isFeeChargingMonitoring;
private String publicIp;
private String privateIp;
private String serverImageName;
private CommonCode serverInstanceStatus;
private CommonCode serverInstanceOperation;
private String serverInstanceStatusName;
private Date createDate;
private Date uptime;
private String serverImageProductCode;
private String serverProductCode;
private Boolean isProtectServerTermination;
private String portForwardingPublicIp;
private Integer portForwardingExternalPort;
private Integer portForwardingInternalPort;
private Zone zone;
private Region region;
private CommonCode baseBlockStorageDiskType;
private CommonCode baseBlockStroageDiskDetailType;
private CommonCode serverInstanceType;
private String userData;
private List<AccessControlGroup> accessControlGroupList;
private List<BlockDevicePartition> blockDevicePartitionList;

Field

The following describes the fields.

Field	Type	Required	Description
`serverInstanceNo`	String	Required	Server instance number NAVER Cloud Platform's identifier to identify server instances (VMs)
`serverName`	String	Required	Server name
`serverDescription`	String	Required	Server description
`cpuCount`	Integer	Required	Number of virtual CPUs
`memorySize`	Long	Required	Memory size (bytes)
`baseBlockStorageSize`	Long	Required	Default block storage size (byte)
`platformType`	CommonCode	Required	Platform type of the image installed on the server `LNX32` \| `WIN64`
`loginKeyName`	String	Required	Name of the login key encrypted with the public key that issued the server's password
`isFeeChargingMonitoring`	Boolean	Required	Paid monitoring status `true` \| `false`
`publicIp`	String	Optional	Public IP assigned to the server
`privateIp`	String	Required	Private IP assigned to the server
`serverImageName`	String	Required	Server image name
`serverInstanceStatus`	CommonCode	Required	Server instance status `INIT` \| `CREAT` \| `RUN` \| `NSTOP` \| `TERMT` \| `FSTOP` \| `SD_FL` \| `RS_FL` \| `ST_FL` `INIT`: server INIT status `CREAT`: server CREATED status `RUN`: server RUN status `NSTOP`: server NORMAL STOPPED status `TERMT`: server TERMINATED status `FSTOP`: server FAILURE STOPPED status `SD_FL`: server shutdown failure status `RS_FL`: server restart failure status `ST_FL`: server start failure status
`serverInstanceOperation`	CommonCode	Required	Server instance operation status `START` \| `SHTDN` \| `RESTA` \| `TERMT` \| `NULL` \| `MIGRA` \| `COPY` \| `SETUP` \| `HREST` \| `HSHTD` \| `CHNG` \| `CREAT` `START`: start `SHTDN`: shutdown `RESTA`: restart `TERMT`: terminate `NULL`: null `MIGRA`: migration `COPY`: currently targeted for copy `SETUP`: currently in setup `HREST`: force restart `HSHTD`: server force shutdown `CHNG`: server spec change `CREAT`: create
`serverInstanceStatusName`	String	Required	Server instance status name Pass the current server instance status name by combining the server instance status and the server instance operation status `init` \| `creating` \| `booting` \| `setting up` \| `running` \| `rebooting` \| `hard rebooting` \| `shutting down` \| `hard shutting down` \| `terminating` \| `changingSpec` \| `copying` \| `repairing`
`createDate`	Date	Required	Creation date and time (YYYY-MM-DDThh:mm:ssZ)
`uptime`	Date	Required	Uptime (YYYY-MM-DDThh:mm:ssZ)
`serverImageProductCode`	String	Required	Server Image product code Product code corresponding to the Server Image product managed by NAVER Cloud Platform
`serverProductCode`	String	Required	Server product code Product code corresponding to the Server product managed by NAVER Cloud Platform
`isProtectServerTermination`	Boolean	Required	Termination protection status `true` \| `false` If the server termination protection column has a value of `true`, the termination won't occur
`portForwardingPublicIp`	String	Optional	Port forwarding public IP Pass only if port forwarding public IP is set
`portForwardingExternalPort`	Integer	Optional	Port forwarding public IP external port value Pass only if port forwarding is set
`portForwardingInternalPort`	Integer	Optional	Port forwarding public IP internal port value Pass only if port forwarding is set
`zone`	Zone	Required	Zone where the server is located
`region`	Region	Required	Region where the server is located
`baseBlockStorageDiskType`	CommonCode	Required	Default block storage disk type `LOCAL` \| `NET` `LOCAL`: local `NET`: network
`baseBlockStorageDiskDetailType`	CommonCode	Required	Base block storage disk detailed type `HDD` \| `SSD`
`serverInstanceType`	CommonCode	Required	Server instance type `MICRO` \| `COMPT` \| `STAND` \| `GPU` \| `LDISK` \| `CHADP` \| `BM` \| `VDS` `MICRO`: Micro `COMPT`: Compact `STAND`: Standard `GPU`: GPU `LDISK`: Local Disk `CHADP`: Cloud Hadoop `BM`: Bare Metal `VDS`: Virtual Dedicated Server
`userData`	String	Required	User data The user can pass a script that can be executed. If the script is passed, it will be executed on the first boot of the server This value is only passed on single queries
`accessControlGroupList`	List<AccessControlGroup>	Required	ACG list
`blockDevicePartitionList`	List<BlockDevicePartition>	Optional	Block device partition list Pass custom partition information if it is a bare metal server