createBlockStorageSnapshotInstance

Available in VPC

Create a block storage snapshot instance.

Syntax

The createBlockStorageSnapshotInstance syntax is as follows:

./ncloud vserver createBlockStorageSnapshotInstance \
    --originalBlockStorageInstanceNo <original-block-storage-instance-no> \
    [--blockStorageSnapshotName <block-storage-snapshot-name>] \
    [--blockStorageSnapshotDescription <block-storage-snapshot-description>] \
    [--snapshotTypeCode <FULL|INCREMENTAL>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createBlockStorageSnapshotInstance.

Required options

The following options are required for createBlockStorageSnapshotInstance.

Options	Type	Required	Description
`--originalBlockStorageInstanceNo`	String	Required	Source storage instance number See getBlockStorageInstanceList.

Optional options

These are the optional options for createBlockStorageSnapshotInstance. Options that are not specified will use their default values.

Options	Type	Required	Description
`--blockStorageSnapshotName`	String	Optional	Snapshot name Automatically generated if not entered. Enter 3-30 characters using a combination of English letters, numbers, and special character `-` and `_`. The string must start with an English letter and end with an English letter or a number.
`--blockStorageSnapshotDescription`	String	Optional	Snapshot description (byte) 0-1000
`--snapshotTypeCode`	String	Optional	Snapshot type code `FULL` (default) \| `INCREMENTAL` `FULL`: Full storage snapshot `INCREMENTAL`: Incremental snapshot Incremental snapshots can be taken after a full snapshot is created. Up to 7 incremental snapshots can be created.

Common options

For information about the options common to all vserver subcommands, see Server (VPC) options.

Examples

If the request to create a block storage snapshot instance is successful, the identification and configuration information for the created snapshot is returned.

Command

The command example is as follows:

./ncloud vserver createBlockStorageSnapshotInstance \
    --originalBlockStorageInstanceNo 89012345 \
    --blockStorageSnapshotName test-snapshot-01 \
    --blockStorageSnapshotDescription "Test snapshot" \
    --snapshotTypeCode FULL \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createBlockStorageSnapshotInstanceResponse": {
    "totalRows": 1,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "90123456",
        "blockStorageSnapshotName": "test-snapshot-01",
        "blockStorageSnapshotVolumeSize": 10737418240,
        "originalBlockStorageInstanceNo": "89012345",
        "blockStorageSnapshotInstanceStatus": {
          "code": "INIT",
          "codeName": "Block storage INIT status"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "CREAT",
          "codeName": "Block storage CREAT OP"
        },
        "blockStorageSnapshotInstanceStatusName": "creating",
        "createDate": "2026-05-14T20:40:11+0900",
        "isEncryptedOriginalBlockStorageVolume": false,
        "blockStorageSnapshotDescription": "Test snapshot",
        "snapshotType": {
          "code": "FULL",
          "codeName": "Full Storage Snapshot"
        },
        "snapshotChainDepth": 0,
        "isBootable": true,
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        }
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index