Get the server instance (VM) list. Paging is available, and the userData field is only provided when querying server instance details.
Request
Request parameters
| Parameter name | Required | Type | Restrictions | Description |
|---|---|---|---|---|
| serverInstanceNoList.N | No | List<String> | - Server instance number list to query serverInstanceNo can be obtained through the getServerInstanceList action. e.g., serverInstanceNoList.1=937507&serverInstanceNoList.2=1021003 |
|
| searchFilterName | No | String | - Name of filter to search You can search by filtering by server name and IP. In the case of IPs, both private IPs and public IPs can be searched. Options: serverName (server name) | ip (IP address) [case-insensitive]searchFilterName is used by mapping with the searchFilterValue value shown below. e.g., searchFilterName=ip&searchFilterValue=10.41.3.81 e.g., searchFilterName=serverName&searchFilterValue=monkeys |
|
| searchFilterValue | No | String | - Filter value to search for Enter the value to be mapped to the searchFilterName value above. |
|
| pageNo | No | Integer | Min: 0, Max: 2147483647 | - Page number of the paged results The results can be paged using pageNo. |
| pageSize | No | Integer | Min: 0, Max: 2147483647 | - Size of each page to be displayed when paging The results can be paged using pageSize. |
| serverInstanceStatusCode | No | String | Min: 0, Max: 5 | - Server instance status code List of servers by server instance status code to query serverInstanceStatusCode can be obtained through the getServerInstanceList action. For the available status, see the server instance status (serverInstanceStatus) value of the server instance data type (ServerInstance). e.g., serverInstanceStatusCode=NSTOP |
| regionNo | No | String | - Region number Determine the Region in which the server list will be queried. regionNo can be obtained through the getRegionList action. |
|
| zoneNo | No | String | - Zone number Determine the zone in which the server list will be queried. zoneNo can be obtained through the getZoneList action. Default: Select the first zone of the Region. |
|
| baseBlockStorageDiskTypeCode | No | String | Min: 1, Max: 5 | - Server disk type classification code Options: NET (NETWORK DISK) |
| baseBlockStorageDiskDetailTypeCode | No | String | Min: 1, Max: 5 | - Server disk detail type classification code Options: HDD | SSD |
| sortedBy | No | String | - Sorted by Sort by server name and server instance number Options: serverName (server name) | serverInstanceNo (server instance number) [case-insensitive]sortedBy is used by mapping with the sortingOrder shown below. e.g., sortedBy=serverName&sortingOrder=ascending e.g., sortedBy=serverInstanceNo&sortingOrder=descending |
|
| sortingOrder | No | String | - Sorting order Set the ascending/descending sort order of sortedBy set above. ascending | descending [case-insensitive]Default: ascending |
|
| serverInstanceTypeCodeList.N | No | List<String> | - List of server instance classification codes to query For the available status, see the server instance type (serverInstanceType) value of the server instance data type (ServerInstance). Options: MICRO (Micro) | COMPT (Compact) | STAND(Standard) | HIMEM(High Memory) | GPU(GPU) | VDS (Virtual Dedicated Server) |
|
| tagKeyList.N | No | List<String> | - Tag key of the instance to query You can search for an instance through the instance's tag key. TagKey of the instance can be obtained through the getInstanceTagList action. e.g., instanceTagList.1.tagKey=tag1 |
|
| tagKeyValue.N | No | List<String> | - Tag value of the instance to query You can search for an instance through the instance's tag value. TagValue of the instance can be obtained through the getInstanceTagList action. e.g., instanceTagList.1.tagValue=dolphins |
|
| responseFormatType | No | String | - Response result's format type Options: xml | json Default: xml |
Response
Response body
Examples
Request example
GET {SERVER_API_URL}/getServerInstanceList
?serverInstanceStatusCode=RUN
&searchFilterName=ip
&searchFilterValue=106.10.46.237
Response example
<getServerInstanceListResponse>
<requestId>0cf1cb98-6fdb-4064-804d-c1a14f903d9b</requestId>
<returnCode>0</returnCode>
<returnMessage>success</returnMessage>
<totalRows>1</totalRows>
<serverInstanceList>
<serverInstance>
<serverInstanceNo>1081368</serverInstanceNo>
<serverName>s1673fa87a9b</serverName>
<serverDescription></serverDescription>
<cpuCount>1</cpuCount>
<memorySize>1073741824</memorySize>
<baseBlockStorageSize>53687091200</baseBlockStorageSize>
<platformType>
<code>LNX32</code>
<codeName>Linux 32 Bit</codeName>
</platformType>
<loginKeyName>juhoon-kim</loginKeyName>
<isFeeChargingMonitoring>false</isFeeChargingMonitoring>
<publicIp></publicIp>
<privateIp>10.41.19.248</privateIp>
<serverImageName>centos-6.3-32</serverImageName>
<serverInstanceStatus>
<code>NSTOP</code>
<codeName>Server normal stopped state</codeName>
</serverInstanceStatus>
<serverInstanceOperation>
<code>NULL</code>
<codeName>Server NULL OP</codeName>
</serverInstanceOperation>
<serverInstanceStatusName>stopped</serverInstanceStatusName>
<createDate>2018-11-23T17:21:05+0900</createDate>
<uptime>2018-11-23T17:36:40+0900</uptime>
<serverImageProductCode>SPSW0LINUX000032</serverImageProductCode>
<serverProductCode>SPSVRSTAND000056</serverProductCode>
<isProtectServerTermination>false</isProtectServerTermination>
<portForwardingPublicIp>106.10.51.90</portForwardingPublicIp>
<zone>
<zoneNo>3</zoneNo>
<zoneName>KR-2</zoneName>
<zoneCode>KR-2</zoneCode>
<zoneDescription>Pyeongchon zone</zoneDescription>
<regionNo>1</regionNo>
</zone>
<region>
<regionNo>1</regionNo>
<regionCode>KR</regionCode>
<regionName>Korea</regionName>
</region>
<baseBlockStorageDiskType>
<code>NET</code>
<codeName>Network Storage</codeName>
</baseBlockStorageDiskType>
<baseBlockStorageDiskDetailType>
<code>HDD</code>
<codeName>HDD</codeName>
</baseBlockStorageDiskDetailType>
<serverInstanceType>
<code>MICRO</code>
<codeName>Micro Server</codeName>
</serverInstanceType>
<userData></userData>
<initScriptNo></initScriptNo>
<accessControlGroupList>
<accessControlGroup>
<accessControlGroupConfigurationNo>39995</accessControlGroupConfigurationNo>
<accessControlGroupName>ncloud-default-acg</accessControlGroupName>
<accessControlGroupDescription>Default AccessControlGroup</accessControlGroupDescription>
<isDefault>true</isDefault>
<createDate>2018-04-09T11:12:54+0900</createDate>
</accessControlGroup>
</accessControlGroupList>
<instanceTagList/>
</serverInstance>
</serverInstanceList>
</getServerInstanceListResponse>