getServerImageList

Prev Next

Available in VPC

Overview

Get a server image list.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
Determine the Region in which the server image list will be viewed
regionCode can be obtained through the getRegionList action
Default: Select the first Region of the getRegionList search result
serverImageNoList.N No List<String> - Server image number list
You can filter and search by server image number.
serverImageNo can be obtained through the getServerImageList action.
E.g., serverImageNoList.1=1234&serverImageNoList.2=2345
serverImageName No String - Server image name
You can filter and search by server image name.
serverImageStatusCode No String - Server image status code
You can filter and search by server image status code.
Options: INIT | CREAT
serverImageTypeCodeList.N No List<String> - Server image type code list
You can filter and search by server image type code.
Options: SELF | NCP
E.g., serverImageTypeCodeList.1=NCP
hypervisorTypeCodeList.N No List<String> - Hypervisor type code list
You can filter and search by hypervisor type code.
Options: XEN | KVM
E.g., hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM
osTypeCodeList.N No List<String> - OS type code list
You can filter and search by OS type code.
Options: CENTOS | UBUNTU | WINDOWS
E.g., osTypeCodeList.1=CENTOS&osTypeCodeList.2=UBUNTU
platformCategoryCodeList.N No List<String> - Platform category code list
You can filter and search by platform category code.
Options: OS | APP | DBMS | GPU
E.g., platformCategoryCodeList.1=OS&platformCategoryCodeList.2=GPU
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 - Sorting target
The results can be sorted by server image name.
Options: serverImageName
sortingOrder No String - Sort order
Set ascending/descending sorting when using sortedBy.
Options: ASC (ascending) | DESC (descending)
Default: ASC
responseFormatType No String - Response result's format type
Options: xml | json
Default: xml

Response

Response data type

  • ServerImageList type
ServerImageList extends CommonResponse
private Integer totalRows;
private List<ServerImage> serverImageList = new ArrayList<>();
ServerImage
private String serverImageNo;
private String serverImageName;
private String serverImageDescription;
private CommonCode serverImageType;
private CommonCode serverImageLifeCyclePhase;
private CommonCode hypervisorType;
private CommonCode cpuArchitectureType;
private CommonCode osCategoryType;
private CommonCode osType;
private String serverImageStatusName;
private CommonCode serverImageStatus;
private CommonCode serverImageOperation;
private String serverImageProductCode;
private Date createDate;
private CommonCode shareStatus;
private SharedLoginIdList sharedLoginIdList;
private String platformCategoryCode;
private List<BlockStorageMapping> blockStorageMappingList;
BlockStorageMapping
private Integer order;
private String blockStorageSnapshotInstanceNo;
private String blockStorageSnapshotName;
private Long blockStorageSize;
private String blockStorageName;
private CommonCode blockStorageVolumeType;
private Long iops;
private Long throughput;
private Boolean isEncryptedVolume;

Examples

Request example

ncloud vserver getServerImageList --regionCode KR --serverImageNoList ***5847 --serverImageName test-*** --serverImageStatusCode CREAT --osTypeCodeList CENTOS

Response example

<getServerImageListResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <serverImageList>
    <serverImage>
      <serverImageNo>***5847</serverImageNo>
      <serverImageName>test-***</serverImageName>
      <serverImageDescription></serverImageDescription>
      <serverImageType>
        <code>NCP</code>
        <codeName>NCP Server Image</codeName>
      </serverImageType>
      <serverImageLifeCyclePhase>
        <code>IN_SERVICE</code>
        <codeName>In Service</codeName>
      </serverImageLifeCyclePhase>
      <hypervisorType>
        <code>XEN</code>
        <codeName>XEN</codeName>
      </hypervisorType>
      <cpuArchitectureType>
        <code>X86_64</code>
        <codeName>x86 64bit</codeName>
      </cpuArchitectureType>
      <osCategoryType>
        <code>LINUX</code>
        <codeName>LINUX</codeName>
      </osCategoryType>
      <osType>
        <code>CENTOS</code>
        <codeName>CENTOS</codeName>
      </osType>
      <serverImageProductCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</serverImageProductCode>
      <serverImageStatus>
        <code>CREAT</code>
        <codeName>Server created state</codeName>
      </serverImageStatus>
      <serverImageOperation>
        <code>NULL</code>
        <codeName>NULL OP</codeName>
      </serverImageOperation>
      <serverImageStatusName>created</serverImageStatusName>
      <createDate>2020-08-24T10:34:27+0900</createDate>
      <blockStorageMappingList>
        <blockStorageMapping>
          <order>0</order>
          <blockStorageSize>53687091200</blockStorageSize>
          <blockStorageVolumeType>
            <code>HDD</code>
            <codeName>HDD</codeName>
          </blockStorageVolumeType>
          <isEncryptedVolume>false</isEncryptedVolume>
        </blockStorageMapping>
      </blockStorageMappingList>
      <shareStatus>
        <code>NULL</code>
        <codeName>NSI Share NULL State</codeName>
      </shareStatus>
      <sharedLoginIdList/>
      <platformCategoryCode>OS</platformCategoryCode>
    </serverImage>
  </serverImageList>
</getServerImageListResponse>