createServerImage

Prev Next

Available in VPC

Overview

Create a My server image.

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
serverInstanceNo Yes String - - Source server instance number
serverImageName Yes String Min: 3, Max: 30
Only English letters, numbers, and special character "-" are allowed, and it must start with an English letter
It must end with an English letter or number		 - Server image name
serverImageDescription No String Min: 0, Max: 1000 Bytes - Description of the server image to be created
blockStorageList.N.order Yes Integer Min: 0, Max: 20 - Block storage order
Determine the order of storage to be assigned to the created server.
There must be one default storage.
Enter 0 to set it as the default storage.
Up to 21 storage can be assigned.
blockStorageList.N.snapshotInstanceNo Yes String - - Storage snapshot instance number
Determine the snapshot instance that will be used to create the server image.
snapshotInstanceNo can be obtained through the getBlockStorageSnapshotInstanceList action.
blockStorageList.N.blockStorageSize Conditional Integer - - Storage size (GB)
Determine the size (GB) of the storage to create.
If a snapshot is specified, it must be equal to or larger than the snapshot size.
For size restrictions by volume type, see the user guide.
Compute > Server > VPC > Using Server > Server > Block Storage > Block Storage overview > Block Storage overview
blockStorageList.N.blockStorageVolumeTypeCode Conditional String - - Storage type
Determine the type of the storage to create.
The default storage can't be changed.
Options: CB1 | FB1
Must enter either the storage snapshot instance number (snapshotInstanceNo) or the storage type (blockStorageVolumeTypeCode).
blockStorageList.N.noBlockStorage Conditional Boolean - - Whether to exclude storage
Determine whether to exclude the storage.
The default storage can't be changed.
Options: true | false
If false, the storage snapshot instance number (snapshotInstanceNo) must be entered.
blockStorageList.N.emptyBlockStorage Conditional Boolean - - Whether to create new storage
Create new storage without creating storage from a snapshot.
The default storage can't be changed.
Options: true | false
If false, the storage snapshot instance number (snapshotInstanceNo) must be entered.
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 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 createServerImage --regionCode KR --serverInstanceNo 1234 --serverImageName test-***

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