createServerImage

Article summary

Did you find this summary helpful?

Thank you for your feedback

Available in VPC

Overview

Creates a My server image.

Requests

Request parameters

Parameter name	Requirement status	Type	Restrictions	Description
regionCode	No	String	-	- Region code Decides the Region where the server image list is to be viewed regionCode can be obtained through the getRegionList action Default: select the first Region shown in the getRegionList search results
serverInstanceNo	Yes	String	-	- Instance number of the source server
serverImageName	Yes	String	Min : 3, Max : 30 Only English letters, numbers, and the special character "-" can be used. 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	- Order of block storages Choose the order of storages to be assigned to the server image to be created At least 1 primary storage is required Enter 0 to set as the default storage Up to 21 storages can be assigned
blockStorageList.N.snapshotInstanceNo	Yes	String	-	- Storage snapshot instance number Choose the snapshot instance in which a server image is to be created snapshotInstanceNo can be obtained through the getBlockStorageSnapshotInstanceList action
blockStorageList.N.blockStorageSize	Conditional	Integer	-	- Storage size (GB) Choose the storage size to create (GB) If the snapshot has been specified, it must be equal to or greater than the snapshot size. For more information on the restrictions for the size 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 Choose the storage type to create The default storage cannot be changed. Options : CB1 \| FB1 Between the storage snapshot instance number (snapshotInstanceNo) and the storage type member (blockStorageVolumeTypeCode), 1 must be entered
blockStorageList.N.noBlockStorage	Conditional	Boolean	-	- Storage exclusion - Choose whether to exclude the storage The default storage cannot be changed. Options : true \| false When false, the storage snapshot instance number (snapshotInstanceNo) must be entered
blockStorageList.N.emptyBlockStorage	Conditional	Boolean	-	- Whether to create a new storage Creates a new storage without creating a storage from a snapshot. The default storage cannot be changed. Options : true \| false When false, the storage snapshot instance number (snapshotInstanceNo) must be entered
responseFormatType	No	String	-	- Format type of responses Options : xml \| json Default : xml

Responses

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 List<BlockStorageMapping> blockStorageMappingList;

Examples

Request examples

ncloud vserver createServerImage --regionCode KR --serverInstanceNo 1234 --serverImageName test-***

Response examples

<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>
      <productCode>SW.VSVR.OS.LNX64.CNTOS.0703.B050</productCode>
      <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/>
    </serverImage>
  </serverImageList>
</getServerImageListResponse>

Was this article helpful?

What's Next

deleteServerImage

Table of contents

Overview
Requests
Responses
Examples