createBlockStorageSnapshotInstance

Prev Next

Available in VPC

Overview

Create block storage snapshot instances.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String Region code
  • Enter regionCode applicable for originalBlockStorageInstanceNo (Snapshots can only be created where the block storage is located.)
  • regionCode can be obtained through the getRegionList action.
  • Default: Select the first Region of the getRegionList query result.
originalBlockStorageInstanceNo Yes String Source block storage instance number
  • Determine the block storage you want to create a snapshot of.
  • originalBlockStorageInstanceNo can be obtained through the getBlockStorageInstanceList action.
blockStorageSnapshotName No 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.
 Block storage snapshot name
  • Default: NAVER Cloud Platform automatically assigns it.
blockStorageSnapshotDescription No String Min: 0, Max: 1000 Bytes Description of the block storage snapshot to be created
snapshotTypeCode No String Snapshot type code
  • Determine the snapshot type.
  • A full storage snapshot must be created first to create incremental snapshots.
  • Up to 7 incremental snapshots can be created.
  • Options: FULL | INCREMENTAL
  • Default: FULL
responseFormatType No String Response result's format type
  • Options: xml | json
  • Default: xml

Response

Response data type

  • BlockStorageSnapshotInstanceList type
BlockStorageSnapshotInstanceList extends CommonResponse
private Integer totalRows;
private List<BlockStorageSnapshotInstance> blockStorageSnapshotInstanceList = new ArrayList<>();
BlockStorageSnapshotInstance
private String blockStorageSnapshotInstanceNo;
private String blockStorageSnapshotName;
private Long blockStorageSnapshotVolumeSize;
private String originalBlockStorageInstanceNo;
private CommonCode blockStorageSnapshotInstanceStatus;
private CommonCode blockStorageSnapshotInstanceOperation;
private String blockStorageSnapshotInstanceStatusName;
private Date createDate;
private Boolean isEncryptedOriginalBlockStorageVolume;
private String blockStorageSnapshotDescription;
private CommonCode snapshotType;
private String baseSnapshotInstanceNo;
private Integer snapshotChainDepth;
private CommonCode hypervisorType;
private Boolean isBootable;
private CommonCode blockStorageVolumeType;

Examples

Request example

ncloud vserver createBlockStorageSnapshotInstance --regionCode KR --originalBlockStorageInstanceNo ***7746 --blockStorageSnapshotName test-*** --snapshotTypeCode FULL

Response example

<createBlockStorageSnapshotInstanceResponse>
  <requestId>82de18de-f08f-4490-84c7-5849fbfd9a5d</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageSnapshotInstanceList>
    <blockStorageSnapshotInstance>
      <blockStorageSnapshotInstanceNo>***1951</blockStorageSnapshotInstanceNo>
      <blockStorageSnapshotName>test-***</blockStorageSnapshotName>
      <blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
      <originalBlockStorageInstanceNo>***7746</originalBlockStorageInstanceNo>
      <blockStorageSnapshotInstanceStatus>
        <code>INIT</code>
        <codeName>Block storage INIT state</codeName>
      </blockStorageSnapshotInstanceStatus>
      <blockStorageSnapshotInstanceOperation>
        <code>NULL</code>
        <codeName>Block Storage NULLOP</codeName>
      </blockStorageSnapshotInstanceOperation>
      <blockStorageSnapshotInstanceStatusName>initialized</blockStorageSnapshotInstanceStatusName>
      <createDate>2020-08-25T10:50:30+0900</createDate>
      <isEncryptedOriginalBlockStorageVolume>false</isEncryptedOriginalBlockStorageVolume>
      <blockStorageSnapshotDescription></blockStorageSnapshotDescription>
      <snapshotType>
        <code>FULL</code>
        <codeName>Full Storage Snapshot</codeName>
      </snapshotType>
      <baseSnapshotInstanceNo/>
      <snapshotChainDepth>0</snapshotChainDepth>
      <isBootable>true</isBootable>
      <hypervisorType>
        <code>KVM</code>
        <codeName>KVM</codeName>
      </hypervisorType>
      <blockStorageVolumeType>
        <code>CB1</code>
        <codeName>Common BlockStorage 1</codeName>
      </blockStorageVolumeType>
    </blockStorageSnapshotInstance>
  </blockStorageSnapshotInstanceList>
</createBlockStorageSnapshotInstanceResponse>