getServerInstanceList
- Print
- PDF
getServerInstanceList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Overview
It searches for a server instance (VM) list.
Requests
Request parameters
| Parameter name | Essential parameter (True/False) | Type | Limitations | Description |
|---|---|---|---|---|
| regionCode | No | String | - Region code It can determine the Region for which the server instance list is to be viewed regionCode can be acquired through getRegionList action Default: select the first region shown through getRegionList | |
| vpcNo | No | String | - VPC number You can search by filtering with a VPC number vpcNo can be obtained through the getVpcList action | |
| serverInstanceNoList | No | List<String> | - List of server instance numbers You can search by filtering with a server instance number. serverInstanceNo can be acquired through getServerInstanceList action e.g., --serverInstanceNoList 1234 2345 | |
| serverName | No | String | - Server name You can search by filtering with a Server name | |
| serverInstanceStatusCode | No | String | - Server instance status code You can search by filtering with a server instance status traffic log available Options : INIT | CREAT | RUN | NSTOP | |
| baseBlockStorageDiskTypeCode | No | String | - Type code of default block storage disk Filters query by setting base block storage size of server instance Options : NET (NETWORK DISK) | |
| baseBlockStorageDiskDetailTypeCode | No | String | - Detailed type code of the default block storage disk You can search by filtering by setting detailed base block storage type of server instance Options : HDD | SSD | |
| ip | No | String | - IP Address You can search by filtering with a server instance IP address Both private IP and public IP are subject to filtering. | |
| placementGroupNoList | No | List<String> | - List of the physical placement group numbers You can search by filtering with the number of physical placement group to which a server instance belongs placementGroupNo can be obtained via the getPlacementGroupList action e.g., --placementGroupNoList 1234 2345 | |
| hypervisorTypeCodeList | No | List<String> | - List of hypervisor type codes You can search by filtering by hypervisor type Options : XEN | KVM e.g., --hypervisorTypeCodeList KVM XEN | |
| pageNo | No | Integer | - Page number of paged result The results can be paged using page No. and page size | |
| pageSize | Conditional | Integer | - Size of each page to be shown during paging The results can be paged using page No. and page size Must be entered when entering pageNO | |
| sortedBy | No | String | - Items subject to sorting The results can be sorted by server name and server instance number Options : serverName | serverInstanceNo | |
| sortingOrder | No | String | - Sorting order When using sortedBy, set for sort in ascending/descending order Options: ASC (ascending order) | DESC (descending order) Default : ASC | |
| responseFormatType | No | String | - Format type of responses Options : xml | json Default : xml |
Responses
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; |
Examples
Request examples
ncloud vserver getServerInstanceList --regionCode KR --vpcNo ***04 --serverInstanceNoList ***4299 --serverName test-*** --serverInstanceStatusCode RUN --baseBlockStorageDiskTypeCode NET --baseBlockStorageDiskDetailTypeCode SSD --ip ***.***.111.215 --placementGroupNoList ***61
Response examples
<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>
</serverInstance>
</serverInstanceList>
</getServerInstanceListResponse>
Was this article helpful?