getServerInstanceList

Prev Next

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
fabricClusterPoolNo No String - Fabric cluster pool number
Search by filtering with the Fabric cluster pool number.
fabricClusterPoolNo can be obtained through the getFabricClusterPoolList action.
fabricClusterNo No String - Fabric cluster number
Search by filtering with the Fabric cluster number.
fabricClusterNo can be obtained through the getFabricClusterList action.
fabricClusterMode No String - Filter by the Fabric cluster mode.
Options: SINGLE | CLUSTER
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 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
output No String Response result's format type
  • Options: xml | json
  • Default: json

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;
private String fabricClusterPoolNo;
private String fabricClusterPoolName;
private String fabricClusterMode;
private String fabricClusterNo;
private String fabricClusterName;
private Boolean isPreInstallGpuDriver;

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

For server

{
  "getServerInstanceListResponse": {
    "returnCode": "0",
    "returnMessage": "success",
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "***4299",
        "serverName": "test-***",
        "serverDescription": "",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-***",
        "publicIpInstanceNo": "***7551",
        "publicIp": "***.***.111.215",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server run state"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2020-08-19T15:05:07+0900",
        "uptime": "2020-08-19T15:08:09+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.CNTOS.0703.B050",
        "serverProductCode": "SVR.VSVR.STAND.C002.M004.NET.SSD.B050.G001",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***04",
        "subnetNo": "***43",
        "networkInterfaceNoList": [
          "***87"
        ],
        "initScriptNo": "",
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network Storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "placementGroupNo": "***61",
        "placementGroupName": "test-***",
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "serverImageNo": "61",
        "serverSpecCode": "mi2-g3i",
        "eventList": [
          "Scheduled Maintenance Event | 2025-03-19 PM 10:11 (UTC+09:00) migration"
        ]
      }
    ]
  }
}

<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>

For bare metal

{
  "getServerInstanceListResponse": {
    "totalRows": 1,
    "serverInstanceList": [
      {
        "serverInstanceNo": "****2594",
        "serverName": "test-***",
        "serverDescription": "test",
        "cpuCount": 64,
        "memorySize": 2199023255552,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-***",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN status"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2025-12-12T13:36:17+0900",
        "uptime": "2026-01-05T10:29:51+0900",
        "serverImageProductCode": "SW.VSVR.BM.OS.LNX64.UBNTU.SVR24.WRKND.G001",
        "serverProductCode": "SVR.VSVR.BM.GPU.H200N10.G008.C064.M2048.LOCAL.SSD.B48145.G001",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "***84",
        "subnetNo": "***54",
        "networkInterfaceNoList": [
          "***143"
        ],
        "serverInstanceType": {
          "code": "BM",
          "codeName": "BareMetal"
        },
        "baseBlockStorageDiskType": {
          "code": "LOCAL",
          "codeName": "Local storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "BM",
          "codeName": "BM"
        },
        "fabricClusterPoolNo": "***01",
        "fabricClusterPoolName": "test-***",
        "fabricClusterMode": "SINGLE",
        "isPreInstallGpuDriver": false
      }
    ],
    "requestId": "b340fcb4-74b1-4223-ab36-b8c1b67c56f1",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

<getServerInstanceListResponse>
    <totalRows>1</totalRows>
    <serverInstanceList>
        <serverInstance>
            <serverInstanceNo>****2594</serverInstanceNo>
            <serverName>test-***</serverName>
            <serverDescription>test</serverDescription>
            <cpuCount>64</cpuCount>
            <memorySize>2199023255552</memorySize>
            <platformType>
                <code>LNX64</code>
                <codeName>Linux 64 Bit</codeName>
            </platformType>
            <loginKeyName>test-***</loginKeyName>
            <serverInstanceStatus>
                <code>RUN</code>
                <codeName>Server RUN status</codeName>
            </serverInstanceStatus>
            <serverInstanceOperation>
                <code>NULL</code>
                <codeName>Server NULL OP</codeName>
            </serverInstanceOperation>
            <serverInstanceStatusName>running</serverInstanceStatusName>
            <createDate>2025-12-12T13:36:17+0900</createDate>
            <uptime>2026-01-05T10:29:51+0900</uptime>
            <serverImageProductCode>SW.VSVR.BM.OS.LNX64.UBNTU.SVR24.WRKND.G001</serverImageProductCode>
            <serverProductCode>SVR.VSVR.BM.GPU.H200N10.G008.C064.M2048.LOCAL.SSD.B48145.G001</serverProductCode>
            <isProtectServerTermination>false</isProtectServerTermination>
            <zoneCode>KR-1</zoneCode>
            <regionCode>KR</regionCode>
            <vpcNo>***84</vpcNo>
            <subnetNo>***54</subnetNo>
            <networkInterfaceNoList>
                <networkInterfaceNo>***143</networkInterfaceNo>
            </networkInterfaceNoList>
            <serverInstanceType>
                <code>BM</code>
                <codeName>BareMetal</codeName>
            </serverInstanceType>
            <baseBlockStorageDiskType>
                <code>LOCAL</code>
                <codeName>Local storage</codeName>
            </baseBlockStorageDiskType>
            <baseBlockStorageDiskDetailType>
                <code>SSD</code>
                <codeName>SSD</codeName>
            </baseBlockStorageDiskDetailType>
            <hypervisorType>
                <code>BM</code>
                <codeName>BM</codeName>
            </hypervisorType>
            <fabricClusterPoolNo>***01</fabricClusterPoolNo>
            <fabricClusterPoolName>test-***</fabricClusterPoolName>
            <fabricClusterMode>SINGLE</fabricClusterMode>
            <isPreInstallGpuDriver>false</isPreInstallGpuDriver>
        </serverInstance>
    </serverInstanceList>
    <requestId>b340fcb4-74b1-4223-ab36-b8c1b67c56f1</requestId>
    <returnCode>0</returnCode>
    <returnMessage>success</returnMessage>
</getServerInstanceListResponse>