getServerInstanceList

Article summary

Did you find this summary helpful?

Thank you for your feedback

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in VPC

Overview

It searches for a server instance (VM) list.

Requests

Request Parameters

Parameter name	Requirement status	Type	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 : Choose 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.N	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 ex) serverInstanceNoList.1=1234&serverInstanceNoList.2=2345
serverName	No	String	- Server name Query can be filtered by server name.
serverInstanceStatusCode	No	String	Server instance status code Query can be filtered 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 Filters query with a server instance IP address Both private IP and public IP are subject to filtering.
placementGroupNoList.N	No	List<String>	- List of the physical placement group numbers Filters query by the number of physical placement group to which a server instance belongs placementGroupNo can be obtained via the getPlacementGroupList action ex) placementGroupNoList.1=1234&placementGroupNoList.2=2345
hypervisorTypeCodeList.N	No	List<String>	- List of hypervisor type codes Filters query by hypervisor type Options : XEN \| KVM ex) hypervisorTypeCodeList.1=KVM&hypervisorTypeCodeList.2=XEN
pageNo	No	Integer	- Page number of paged result The results can be paged using pageNo and pageSize
pageSize	Conditional	Integer	- Size of each page to be shown during paging The results can be paged using pageNo and pageSize 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 bodies

ServerInstanceList

Examples

Request Examples

GET {API_URL}/getServerInstanceList
?regionCode=KR
&vpcNo=***04
&serverInstanceNoList.1=***4299
&serverName=test-***
&serverInstanceStatusCode=RUN
&baseBlockStorageDiskTypeCode=NET
&baseBlockStorageDiskDetailTypeCode=SSD
&ip=***.***.111.215
&placementGroupNoList.1=***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?

What's Next

getServerInstanceDetail

Table of contents

Overview
Requests
Responses
Examples