Available in VPC
Overview
Get the server instance (VM) list.
Request
Request parameters
Parameter name | Required | Type | Restrictions | Description |
---|---|---|---|---|
regionCode | No | String | - Region code Determine the Region in which the server instance list will be queried. regionCode can be obtained through the getRegionList action. Default: Select the first Region of the getRegionList search result. |
|
vpcNo | No | String | - VPC number Search by filtering with the VPC number. vpcNo can be obtained through the getVpcList action. |
|
serverInstanceNoList | No | List<String> | - Server instance number list You can filter and search by server instance number. serverInstanceNo can be obtained through the getServerInstanceList action. Example) --serverInstanceNoList 1234 2345 |
|
serverName | No | String | - Server name You can filter and search by server name. |
|
serverInstanceStatusCode | No | String | - Server instance status code You can filter and search by server instance status code Options: INIT | CREAT | RUN | NSTOP |
|
baseBlockStorageDiskTypeCode | No | String | - Default block storage disk type code You can search by filtering with the default block storage type of server instance. Options: NET (NETWORK DISK) |
|
baseBlockStorageDiskDetailTypeCode | No | String | - Default block storage disk type detailed code You can search by filtering with the default block storage detailed type of server instance. Options: HDD | SSD |
|
ip | No | String | - IP address You can search by filtering with the IP address of the server instance. Both private IPs and public IPs are subject to filtering. |
|
placementGroupNoList | No | List<String> | - Physical placement group number list You can search by filtering with the physical placement group number to which the server instance belongs. placementGroupNo can be obtained through the getPlacementGroupList action. Example) --placementGroupNoList 1234 2345 |
|
hypervisorTypeCodeList | No | List<String> | - Hypervisor type code list You can filter and search by hypervisor type. Options: XEN | KVM Example) --hypervisorTypeCodeList KVM XEN |
|
pageNo | No | Integer | - Page numbers in paged results The results can be paged using pageNo and pageSize. |
|
pageSize | Conditional | Integer | - Size of each page to display when paging The results can be paged using pageNo and pageSize. Required when entering pageNo |
|
sortedBy | No | String | - Sort target The results can be sorted by server image name and server instance number. Options: serverName | serverInstanceNo |
|
sortingOrder | No | String | - Sort order Set ascending/descending sorting when using sortedBy. Options: ASC (ascending) | DESC (descending) Default: ASC |
|
responseFormatType | No | String | - Response result's format type Options: xml | json Default: xml |
Response
Response data type
- ServerInstanceList type
ServerInstanceList extends CommonResponse |
---|
private Integer totalRows; |
private List<ServerInstance> serverInstanceList = new ArrayList<>(); |
ServerInstance |
---|
private String serverInstanceNo; |
private String serverName; |
private String serverDescription; |
private Integer cpuCount; |
private Long memorySize; |
private CommonCode platformType; |
private String loginKeyName; |
private String publicIpInstanceNo; |
private String publicIp; |
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 zoneCode; |
private String regionCode; |
private String vpcNo; |
private String subnetNo; |
private NetworkInterfaceNoList networkInterfaceNoList; |
private String initScriptNo; |
private CommonCode serverInstanceType; |
private CommonCode baseBlockStorageDiskType; |
private CommonCode baseBlockStorageDiskDetailType; |
private String placementGroupNo; |
private String placementGroupName; |
private String memberServerImageInstanceNo; |
private List<BlockDevicePartition> blockDevicePartitionList; |
private CommonCode hypervisorType; |
private String serverImageNo; |
private String serverSpecCode; |
private List<String> eventList; |
Examples
Request example
ncloud vserver getServerInstanceList --regionCode KR --vpcNo ***04 --serverInstanceNoList ***4299 --serverName test-*** --serverInstanceStatusCode RUN --baseBlockStorageDiskTypeCode NET --baseBlockStorageDiskDetailTypeCode SSD --ip ***.***.111.215 --placementGroupNoList ***61
Response example
<getServerInstanceListResponse>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<serverInstanceList>
<serverInstance>
<serverInstanceNo>***4299</serverInstanceNo>
<serverName>test-***</serverName>
<serverDescription></serverDescription>
<cpuCount>2</cpuCount>
<memorySize>4294967296</memorySize>
<platformType>
<code>LNX64</code>
<codeName>Linux 64 Bit</codeName>
</platformType>
<loginKeyName>test-***</loginKeyName>
<publicIpInstanceNo>***7551</publicIpInstanceNo>
<publicIp>***.***.111.215</publicIp>
<serverInstanceStatus>
<code>RUN</code>
<codeName>Server run state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>running</serverInstanceStatusName>
<createDate>2020-08-19T15:05:07+0900</createDate>
<uptime>2020-08-19T15:08:09+0900</uptime>
<serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
<serverProductCode>SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<zoneCode>KR-1</zoneCode>
<regionCode>KR</regionCode>
<vpcNo>***04</vpcNo>
<subnetNo>***43</subnetNo>
<networkInterfaceNoList>
<networkInterfaceNo>***87</networkInterfaceNo>
</networkInterfaceNoList>
<initScriptNo></initScriptNo>
<serverInstanceType>
<code>STAND</code>
<codeName>Standard</codeName>
</serverInstanceType>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>SSD</code>
<codeName>SSD</codeName>
</baseBlockStorageDiskDetailType>
<placementGroupNo>***61</placementGroupNo>
<placementGroupName>test-***</placementGroupName>
<hypervisorType>
<code>KVM</code>
<codeName>KVM</codeName>
</hypervisorType>
<serverImageNo>61</serverImageNo>
<serverSpecCode>mi2-g3i</serverSpecCode>
<eventList>
<string>Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration</string>
</eventList>
</serverInstance>
</serverInstanceList>
</getServerInstanceListResponse>