getServerInstanceList

Available in VPC

Get the list of server instances (VMs).

Syntax

The getServerInstanceList syntax is as follows:

./ncloud vserver getServerInstanceList \
    [--vpcNo <vpc-no>] \
    [--serverInstanceNoList <server-instance-no-list>] \
    [--serverName <server-name>] \
    [--serverInstanceStatusCode <INIT|CREAT|RUN|NSTOP>] \
    [--baseBlockStorageDiskTypeCode <NET>] \
    [--baseBlockStorageDiskDetailTypeCode <HDD|SSD>] \
    [--ip <ip-address>] \
    [--placementGroupNoList <placement-group-no-list>] \
    [--hypervisorTypeCodeList <XEN|KVM>] \
    [--fabricClusterPoolNo <fabric-cluster-pool-no>] \
    [--fabricClusterNo <fabric-cluster-no>] \
    [--fabricClusterMode <SINGLE|CLUSTER>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--sortedBy <serverName|serverInstanceNo>] \
    [--sortingOrder <ASC|DESC>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getServerInstanceList.

Required options

The following options are required for getServerInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-`1000` (default: `1`) Required when entering `--pageNo`

Optional options

These are the optional options for getServerInstanceList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--vpcNo`	String	Optional	VPC number See getVpcList.
`--serverInstanceNoList`	List	Optional	Server instance number list You can enter multiple items separated by spaces. (e.g., `--serverInstanceNoList 1234 2345`)
`--serverName`	String	Optional	Server name
`--serverInstanceStatusCode`	String	Optional	Server instance status code `INIT` \| `CREAT` \| `RUN` \| `NSTOP`
`--baseBlockStorageDiskTypeCode`	String	Optional	Default block storage disk type code `NET`: Network disk
`--baseBlockStorageDiskDetailTypeCode`	String	Optional	Detailed type code of the default block storage disk `HDD` \| `SSD`
`--ip`	String	Optional	Server IP address Both private IP and public IP are included.
`--placementGroupNoList`	List	Optional	Physical placement group number list You can enter multiple items separated by spaces. (e.g., `--placementGroupNoList 1234 2345`) See getPlacementGroupList.
`--hypervisorTypeCodeList`	List	Optional	Hypervisor type code list `XEN` \| `KVM` You can enter multiple items separated by spaces. (e.g., `--hypervisorTypeCodeList KVM XEN`)
`--fabricClusterPoolNo`	String	Optional	Fabric cluster pool number See getFabricClusterPoolList.
`--fabricClusterNo`	String	Optional	Fabric cluster number See getFabricClusterList.
`--fabricClusterMode`	String	Optional	Fabric cluster mode `SINGLE` \| `CLUSTER` `SINGLE`: Server not included in a Fabric cluster `CLUSTER`: Server included in a Fabric cluster
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`) First page: Enter `0` or `1`.
`--sortedBy`	String	Optional	Sort by `serverName` \| `serverInstanceNo` `serverName`: Server name `serverInstanceNo`: Server instance number
`--sortingOrder`	String	Optional	Sort order `ASC` (default) \| `DESC` `ASC`: Ascending order `DESC`: Descending order

Common options

For information about the options common to all vserver subcommands, see Server (VPC) options.

Examples

If the request to retrieve the list of server instances is successful, the identification and configuration information for each server is returned.

Command

The command example is as follows:

./ncloud vserver getServerInstanceList \
    --vpcNo 12345678 \
    --serverInstanceStatusCode RUN \
    --baseBlockStorageDiskTypeCode NET \
    --baseBlockStorageDiskDetailTypeCode SSD \
    --hypervisorTypeCodeList KVM XEN \
    --pageNo 0 \
    --pageSize 10 \
    --sortedBy serverName \
    --sortingOrder ASC \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getServerInstanceListResponse": {
    "totalRows": 4,
    "serverInstanceList": [
      {
        "serverInstanceNo": "34567890",
        "serverName": "kvm-server-01",
        "cpuCount": 2,
        "memorySize": 8589934592,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-login-key-01",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN status"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2026-04-28T13:01:30+0900",
        "uptime": "2026-04-28T13:03:43+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.NAVIX.09.G003",
        "serverProductCode": "SVR.VSVR.AMD.STAND.C002.M008.G003",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "12345678",
        "subnetNo": "23456789",
        "networkInterfaceNoList": [
          "56789012"
        ],
        "serverInstanceType": {
          "code": "STAND",
          "codeName": "Standard"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "serverImageNo": "45678902",
        "serverSpecCode": "s2-g3a",
        "eventList": [],
        "isPreInstallGpuDriver": false
      },
      {
        "serverInstanceNo": "34567891",
        "serverName": "xen-server-01",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-login-key-01",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN status"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2026-05-14T16:17:00+0900",
        "uptime": "2026-05-14T16:21:06+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.ROCKY.0810.B050",
        "serverProductCode": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B050.G002",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "12345678",
        "subnetNo": "23456789",
        "networkInterfaceNoList": [
          "56789013"
        ],
        "serverInstanceType": {
          "code": "HICPU",
          "codeName": "High-CPU"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "serverImageNo": "45678901",
        "serverSpecCode": "c2-g2-s50",
        "eventList": [],
        "isPreInstallGpuDriver": false
      },
      {
        "serverInstanceNo": "34567892",
        "serverName": "test-server-01",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-server-instance-key-01",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN status"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2026-05-14T17:29:35+0900",
        "uptime": "2026-05-14T17:34:00+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.ROCKY.0810.B050",
        "serverProductCode": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B050.G002",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "12345678",
        "subnetNo": "23456789",
        "networkInterfaceNoList": [
          "56789014"
        ],
        "serverInstanceType": {
          "code": "HICPU",
          "codeName": "High-CPU"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "serverImageNo": "45678901",
        "serverSpecCode": "c2-g2-s50",
        "eventList": [],
        "isPreInstallGpuDriver": false
      },
      {
        "serverInstanceNo": "34567893",
        "serverName": "test-server-02",
        "cpuCount": 2,
        "memorySize": 4294967296,
        "platformType": {
          "code": "LNX64",
          "codeName": "Linux 64 Bit"
        },
        "loginKeyName": "test-server-instance-key-01",
        "serverInstanceStatus": {
          "code": "RUN",
          "codeName": "Server RUN status"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "Server NULL OP"
        },
        "serverInstanceStatusName": "running",
        "createDate": "2026-05-14T17:29:43+0900",
        "uptime": "2026-05-14T17:33:45+0900",
        "serverImageProductCode": "SW.VSVR.OS.LNX64.ROCKY.0810.B050",
        "serverProductCode": "SVR.VSVR.HICPU.C002.M004.NET.SSD.B050.G002",
        "isProtectServerTermination": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "vpcNo": "12345678",
        "subnetNo": "23456789",
        "networkInterfaceNoList": [
          "56789015"
        ],
        "serverInstanceType": {
          "code": "HICPU",
          "codeName": "High-CPU"
        },
        "baseBlockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "baseBlockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "serverImageNo": "45678901",
        "serverSpecCode": "c2-g2-s50",
        "eventList": [],
        "isPreInstallGpuDriver": false
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index