getServerImageList

Available in VPC

Get the server image list.

Syntax

The getServerImageList syntax is as follows:

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

Options

This section describes the options available when running getServerImageList.

Required options

The following options are required for getServerImageList.

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 getServerImageList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--serverImageNoList`	List	Optional	Server image number list You can enter multiple items separated by spaces. (e.g., `--serverImageNoList 1234 2345`)
`--serverImageName`	String	Optional	Server image name
`--serverImageStatusCode`	String	Optional	Server image status code `INIT` \| `CREAT` \| `CREFL` `INIT`: Creating `CREAT`: Creation completed `CREFL`: Creation failed
`--serverImageTypeCodeList`	List	Optional	Server image type code list `SELF` \| `NCP` `SELF`: User created `NCP`: Provided by NAVER Cloud Platform You can enter multiple items separated by spaces. (e.g., `--serverImageTypeCodeList SELF NCP`)
`--hypervisorTypeCodeList`	List	Optional	Hypervisor type code list `XEN` \| `KVM` You can enter multiple items separated by spaces. (e.g., `--hypervisorTypeCodeList XEN KVM`)
`--osTypeCodeList`	List	Optional	Operating system type code list `CENTOS` \| `UBUNTU` \| `WINDOWS` \| `ROCKY` \| `NAVIX` You can enter multiple items separated by spaces. (e.g., `--osTypeCodeList CENTOS UBUNTU`)
`--platformCategoryCodeList`	List	Optional	Platform category code list `OS` \| `APP` \| `DBMS` \| `GPU` You can enter multiple items separated by spaces. (e.g., `--platformCategoryCodeList OS GPU`)
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`) First page: Enter `0` or `1`.
`--sortedBy`	String	Optional	Sort by `serverImageName`: Server image name
`--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 images is successful, the identification and configuration information for each server image is returned.

Command

The command example is as follows:

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

Output

The output example is as follows:

{
  "getServerImageListResponse": {
    "totalRows": 2,
    "serverImageList": [
      {
        "serverImageNo": "45678901",
        "serverImageName": "test-server-image-01",
        "serverImageDescription": "Test server image",
        "serverImageType": {
          "code": "SELF",
          "codeName": "SELF server image"
        },
        "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 server image"
        },
        "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