getServerInstanceList

VPC環境で利用できます。

サーバインスタンス(VM)リストを照会します。

構文

getServerInstanceList構文は次の通りです。

./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>]

オプション

getServerInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getServerInstanceListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~`1000` (デフォルト: `1`) `--pageNo`入力時、必ず入力

任意オプション

getServerInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--vpcNo`	String	Optional	VPC番号 getVpcListを参照
`--serverInstanceNoList`	List	Optional	サーバインスタンス番号リストスペースで区切って複数入力可能 (例: `--serverInstanceNoList 1234 2345`)
`--serverName`	String	Optional	サーバ名
`--serverInstanceStatusCode`	String	Optional	サーバインスタンスの状態コード `INIT` \| `CREAT` \| `RUN` \| `NSTOP`
`--baseBlockStorageDiskTypeCode`	String	Optional	基本ブロックストレージのディスクタイプコード `NET`: ネットワークディスク
`--baseBlockStorageDiskDetailTypeCode`	String	Optional	基本ブロックストレージディスクの詳細タイプコード `HDD` \| `SSD`
`--ip`	String	Optional	サーバの IPアドレスプライベート IPアドレスとパブリック IPアドレスのいずれも対象
`--placementGroupNoList`	List	Optional	物理配置グループ番号リストスペースで区切って複数入力可能 (例: `--placementGroupNoList 1234 2345`) getPlacementGroupListを参照
`--hypervisorTypeCodeList`	List	Optional	ハイパーバイザタイプコードリスト `XEN` \| `KVM` スペースで区切って複数入力可能 (例: `--hypervisorTypeCodeList KVM XEN`)
`--fabricClusterPoolNo`	String	Optional	Fabric Cluster Pool番号 getFabricClusterPoolListを参照
`--fabricClusterNo`	String	Optional	Fabric Cluster番号 getFabricClusterListを参照
`--fabricClusterMode`	String	Optional	Fabric Clusterモード `SINGLE` \| `CLUSTER` `SINGLE`: Fabric Clusterに含まれていないサーバ `CLUSTER`: Fabric Clusterに含まれているサーバ
`--pageNo`	Integer	Optional	ページ番号 `0`~N (デフォルト: `0`) 最初のページ: `0`または`1`を入力
`--sortedBy`	String	Optional	ソートの基準 `serverName` \| `serverInstanceNo` `serverName`: サーバ名 `serverInstanceNo`: サーバインスタンス番号
`--sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

例

サーバインスタンスリストの照会リクエストが成功すると、各サーバの識別情報および構成情報が返されます。

コマンド

コマンドの例は次の通りです。

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

出力

出力の例は次の通りです。

{
  "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": "サーバ RUN状態"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "サーバ 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": "ネットワークストレージ"
        },
        "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": "サーバ RUN状態"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "サーバ 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": "ネットワークストレージ"
        },
        "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": "サーバ RUN状態"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "サーバ 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": "ネットワークストレージ"
        },
        "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": "サーバ RUN状態"
        },
        "serverInstanceOperation": {
          "code": "NULL",
          "codeName": "サーバ 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": "ネットワークストレージ"
        },
        "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