getServerImageList

VPC環境で利用できます。

サーバイメージリストを照会します。

構文

getServerImageList構文は次の通りです。

./ncloud vserver getServerImageList \
    [--serverImageNoList <server-image-no-list>] \
    [--serverImageName <server-image-name>] \
    [--serverImageStatusCode <INIT|CREAT|CREFL>] \
    [--serverImageTypeCodeList <SELF|NCP>] \
    [--hypervisorTypeCodeList <XEN|KVM>] \
    [--osTypeCodeList <CENTOS|UBUNTU|WINDOWS|ROCKY|NAVIX>] \
    [--platformCategoryCodeList <OS|APP|DBMS|GPU>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--sortedBy <serverImageName>] \
    [--sortingOrder <ASC|DESC>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

オプション

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

必須オプション

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

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

任意オプション

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

オプション	タイプ	必須の有無	説明
`--serverImageNoList`	List	Optional	サーバイメージ番号リストスペースで区切って複数入力可能 (例: `--serverImageNoList 1234 2345`)
`--serverImageName`	String	Optional	サーバイメージの名前
`--serverImageStatusCode`	String	Optional	サーバイメージの状態コード `INIT` \| `CREAT` \| `CREFL` `INIT`: 作成中 `CREAT`: 作成完了 `CREFL`: 作成失敗
`--serverImageTypeCodeList`	List	Optional	サーバイメージタイプコードリスト `SELF` \| `NCP` `SELF`: ユーザー作成 `NCP`: NAVERクラウドプラットフォームが提供スペースで区切って複数入力可能 (例: `--serverImageTypeCodeList SELF NCP`)
`--hypervisorTypeCodeList`	List	Optional	ハイパーバイザタイプコードリスト `XEN` \| `KVM` スペースで区切って複数入力可能 (例: `--hypervisorTypeCodeList XEN KVM`)
`--osTypeCodeList`	List	Optional	OSタイプコードリスト `CENTOS` \| `UBUNTU` \| `WINDOWS` \| `ROCKY` \| `NAVIX` スペースで区切って複数入力可能 (例: `--osTypeCodeList CENTOS UBUNTU`)
`--platformCategoryCodeList`	List	Optional	プラットフォームカテゴリコードリスト `OS` \| `APP` \| `DBMS` \| `GPU` スペースで区切って複数入力可能 (例: `--platformCategoryCodeList OS GPU`)
`--pageNo`	Integer	Optional	ページ番号 `0`~N (デフォルト: `0`) 最初のページ: `0`または`1`を入力
`--sortedBy`	String	Optional	ソート基準 `serverImageName`: サーバイメージ名
`--sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順

共通オプション

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

例

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

コマンド

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

./ncloud vserver getServerImageList \
    --serverImageStatusCode CREAT \
    --serverImageTypeCodeList SELF \
    --hypervisorTypeCodeList KVM \
    --osTypeCodeList NAVIX \
    --platformCategoryCodeList OS \
    --pageNo 0 \
    --pageSize 10 \
    --sortedBy serverImageName \
    --sortingOrder ASC \
    --regionCode KR \
    --output json

出力

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

{
  "getServerImageListResponse": {
    "totalRows": 2,
    "serverImageList": [
      {
        "serverImageNo": "45678901",
        "serverImageName": "test-server-image-01",
        "serverImageDescription": "Test server image",
        "serverImageType": {
          "code": "SELF",
          "codeName": "SELFサーバイメージ"
        },
        "serverImageLifeCyclePhase": {
          "code": "IN_SERVICE",
          "codeName": "In Service"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "cpuArchitectureType": {
          "code": "X86_64",
          "codeName": "x86 64bit"
        },
        "osCategoryType": {
          "code": "LINUX",
          "codeName": "LINUX"
        },
        "osType": {
          "code": "NAVIX",
          "codeName": "NAVIX"
        },
        "serverImageStatus": {
          "code": "CREAT",
          "codeName": "NSI CREATED state"
        },
        "serverImageOperation": {
          "code": "NULL",
          "codeName": "NSI NULL OP"
        },
        "serverImageStatusName": "created",
        "shareStatus": {
          "code": "NULL",
          "codeName": "NSI Share NULL State"
        },
        "blockStorageMappingList": [
          {
            "order": 0,
            "blockStorageSnapshotInstanceNo": 90123456,
            "blockStorageSnapshotName": "n01234567890abcd",
            "blockStorageSize": 10737418240,
            "blockStorageVolumeType": {
              "code": "CB1",
              "codeName": "Common BlockStorage 1"
            },
            "iops": 100,
            "throughput": 104857600,
            "isEncryptedVolume": false
          }
        ],
        "sharedLoginIdList": [],
        "serverImageProductCode": "SW.VSVR.OS.LNX64.NAVIX.09.G003",
        "createDate": "2026-05-14T16:25:00+0900",
        "platformCategoryCode": "OS"
      },
      {
        "serverImageNo": "45678902",
        "serverImageName": "test-server-image-fromsnap-01",
        "serverImageType": {
          "code": "SELF",
          "codeName": "SELFサーバイメージ"
        },
        "serverImageLifeCyclePhase": {
          "code": "IN_SERVICE",
          "codeName": "In Service"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "cpuArchitectureType": {
          "code": "X86_64",
          "codeName": "x86 64bit"
        },
        "osCategoryType": {
          "code": "LINUX",
          "codeName": "LINUX"
        },
        "osType": {
          "code": "NAVIX",
          "codeName": "NAVIX"
        },
        "serverImageStatus": {
          "code": "CREAT",
          "codeName": "NSI CREATED state"
        },
        "serverImageOperation": {
          "code": "NULL",
          "codeName": "NSI NULL OP"
        },
        "serverImageStatusName": "created",
        "shareStatus": {
          "code": "NULL",
          "codeName": "NSI Share NULL State"
        },
        "blockStorageMappingList": [
          {
            "order": 0,
            "blockStorageSnapshotInstanceNo": 90123457,
            "blockStorageSnapshotName": "test-bootable-snap-01",
            "blockStorageSize": 10737418240,
            "blockStorageVolumeType": {
              "code": "CB1",
              "codeName": "Common BlockStorage 1"
            },
            "iops": 100,
            "throughput": 104857600,
            "isEncryptedVolume": false
          }
        ],
        "sharedLoginIdList": [],
        "serverImageProductCode": "SW.VSVR.OS.LNX64.NAVIX.09.G003",
        "createDate": "2026-05-14T16:31:28+0900",
        "platformCategoryCode": "OS"
      }
    ],
    "requestId": "d4e5f678-9012-3456-def0-456789012345",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index