createBlockStorageInstance

Prev Next

Available in VPC

Overview

Creates block storage instances.

Requests

Request parameters

Parameter name Requirement status Type Restrictions Description
regionCode No String - - Region code
Decides the Region in which the block storage instance will be created
regionCode can be obtained through the getRegionList action
Default: select the first Region shown in the getRegionList search results
zoneCode Conditional String - - ZONE code
Decides the zone in which the block storage instance will be created
zoneCode can be obtained through the getCodeList action (required for KVM block storage)
blockStorageName No 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		 - Name of block storage
Default: automatically granted by the NAVER Cloud Platform
blockStorageDiskDetailTypeCode No String - - Detailed type code of the block storage disk
Decides the detailed type for the block storage disk to be created
Valid only for XEN block storage
Options : SSD | HDD
Default : SSD
blockStorageVolumeTypeCode Conditional String - - Block storage volume type code
Decides the volume type of the block storage to be created
blockStorageVolumeTypeCode can be obtained through the getBlockStorageVolumeTypeList action
- Required for KVM block storage
Options : SSD | HDD | FB1 | CB1
serverInstanceNo Conditional String - - Server instance number
It must be assigned to the server when creating the first block storage
serverInstanceNo can be obtained through the getServerInstanceList action
- Required for XEN block storage
KVM block storage does not support assignment along with the creation, so there should be no serverInstanceNo
blockStorageSnapshotInstanceNo No String - - Block storage snapshot instance number
Entered when creating a block storage from a manually created snapshot
blockStorageSnapshotInstanceNo can be obtained through the getBlockStorageSnapshotInstanceList action
blockStorageSize Conditional Integer - XEN block storage
Min : 10, Max : 2000 GB
- KVM block storage
Min : 10, Max : 16380 GB
Enter in 10 GB units		 - Block storage size
Decides the size of the block storage to be created
It is automatically determined when creating it using a XEN block storage snapshot
It must be equal to or greater than the size of the snapshot when creating it using a XEN block storage snapshot.
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
blockStorageDescription No String Min : 0, Max : 1000 Bytes Description of the block storage to be created
isReturnProtection No Boolean - - Server termination protection status
Termination protection status can be set
Options : true | false
Default : false
responseFormatType No String - - Format type of responses
Options : xml | json
Default : xml

Responses

Response data type

  • Type of BlockStorageInstanceList
BlockStorageInstanceList extends CommonResponse
private Integer totalRows;
private List<BlockStorageInstance> blockStorageInstanceList = new ArrayList<>();
BlockStorageInstance
private String blockStorageInstanceNo;
private String serverInstanceNo;
private String blockStorageName;
private CommonCode blockStorageType;
private Long blockStorageSize;
private String deviceName;
private String blockStorageProductCode;
private CommonCode blockStorageInstanceStatus;
private CommonCode blockStorageInstanceOperation;
private String blockStorageInstanceStatusName;
private Date createDate;
private String blockStorageDescription;
private CommonCode blockStorageDiskType;
private CommonCode blockStorageDiskDetailType;
private Integer maxIopsThroughput;
private Boolean isEncryptedVolume;
private String zoneCode;
private String regionCode;
private Boolean isReturnProtection;

Examples

Request examples

ncloud vserver createBlockStorageInstance --regionCode KR --blockStorageName test-*** --blockStorageDiskDetailTypeCode SSD --serverInstanceNo ***4299 --blockStorageSize 50 --isReturnProtection false

Response examples

<createBlockStorageInstanceResponse>
  <requestId>89254a11-97e3-41d6-9ed2-e9249ebcec7a</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageInstanceList>
    <blockStorageInstance>
      <blockStorageInstanceNo>***7746</blockStorageInstanceNo>
      <serverInstanceNo>***4299</serverInstanceNo>
      <blockStorageName>test-***</blockStorageName>
      <blockStorageType>
        <code>SVRBS</code>
        <codeName>Server BS</codeName>
      </blockStorageType>
      <blockStorageSize>53687091200</blockStorageSize>
      <deviceName></deviceName>
      <blockStorageProductCode>SPBSTBSTAD000006</blockStorageProductCode>
      <blockStorageInstanceStatus>
        <code>INIT</code>
        <codeName>Block storage INIT state</codeName>
      </blockStorageInstanceStatus>
      <blockStorageInstanceOperation>
        <code>NULL</code>
        <codeName>Block Storage NULLOP</codeName>
      </blockStorageInstanceOperation>
      <blockStorageInstanceStatusName>initialized</blockStorageInstanceStatusName>
      <createDate>2020-08-24T22:25:35+0900</createDate>
      <blockStorageDescription></blockStorageDescription>
      <blockStorageDiskType>
        <code>NET</code>
        <codeName>Network Storage</codeName>
      </blockStorageDiskType>
      <blockStorageDiskDetailType>
        <code>SSD</code>
        <codeName>SSD</codeName>
      </blockStorageDiskDetailType>
      <maxIopsThroughput>4000</maxIopsThroughput>
      <isEncryptedVolume>false</isEncryptedVolume>
      <zoneCode>KR-1</zoneCode>
      <regionCode>KR</regionCode>
      <isReturnProtection>false</isReturnProtection>
    </blockStorageInstance>
  </blockStorageInstanceList>
</createBlockStorageInstanceResponse>