createBlockStorageInstance

Available in VPC

Create a block storage instance.

Syntax

The createBlockStorageInstance syntax is as follows:

./ncloud vserver createBlockStorageInstance \
    [--zoneCode <zone-code>] \
    [--serverInstanceNo <server-instance-no>] \
    [--blockStorageVolumeTypeCode <volume-type-code>] \
    [--blockStorageSize <block-storage-size>] \
    [--blockStorageName <block-storage-name>] \
    [--blockStorageDiskDetailTypeCode <SSD|HDD>] \
    [--blockStorageSnapshotInstanceNo <snapshot-instance-no>] \
    [--blockStorageDescription <block-storage-description>] \
    [--isReturnProtection <true|false>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running createBlockStorageInstance.

Required options

The following options are required for createBlockStorageInstance.

Options	Type	Required	Description
`--zoneCode`	String	Conditional	Zone code Required for KVM block storage. See getZoneList.
`--serverInstanceNo`	String	Conditional	Server instance number Required for XEN block storage. KVM block storage can't be assigned to a server at creation time. See getServerInstanceList.
`--blockStorageVolumeTypeCode`	String	Conditional	Block storage volume type code `SSD` \| `HDD` \| `CB1` \| `FB1` Required for KVM block storage. See getBlockStorageVolumeTypeList.
`--blockStorageSize`	Integer	Conditional	Block storage size (GB) XEN: `10`-`2000` KVM: `10`-`16380` Enter in 10 GB increments. Determined automatically when creating with XEN block storage snapshots. Set to a size equal to or larger than the existing snapshot size when creating with a KVM block storage snapshot. For restrictions by storage type, see Storage specifications.

Optional options

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

Options	Type	Required	Description
`--blockStorageName`	String	Optional	Block storage name Automatically generated if not entered. Enter 3-30 characters using a combination of lowercase English letters, numbers, and special character `-`. The string must start with a lowercase English letter and end with a lowercase English letter or a number.
`--blockStorageDiskDetailTypeCode`	String	Optional	Block storage disk detailed type code `SSD` (default) \| `HDD` Available for XEN block storage
`--blockStorageSnapshotInstanceNo`	String	Optional	Block storage snapshot instance number Enter when creating storage with an expiration snapshot. See getBlockStorageSnapshotInstanceList.
`--blockStorageDescription`	String	Optional	Block storage description (byte) 0-1000
`--isReturnProtection`	Boolean	Optional	Termination protection status `true` \| `false` `true`: Protected `false`: Not protected

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 instance is successful, the block storage's identification information and initial status are returned.

Command

The command example is as follows:

./ncloud vserver createBlockStorageInstance \
    --serverInstanceNo 34567890 \
    --blockStorageSize 50 \
    --blockStorageName test-block-storage-01 \
    --blockStorageDiskDetailTypeCode SSD \
    --blockStorageDescription "Test block storage" \
    --isReturnProtection false \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "createBlockStorageInstanceResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "89012345",
        "serverInstanceNo": "34567890",
        "blockStorageName": "test-block-storage-01",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "Server BS"
        },
        "blockStorageSize": 53687091200,
        "blockStorageProductCode": "SPBSTBSTAD000006",
        "blockStorageInstanceStatus": {
          "code": "INIT",
          "codeName": "Block storage INIT status"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "Block storage NULL OP"
        },
        "blockStorageInstanceStatusName": "initialized",
        "createDate": "2026-05-14T20:18:21+0900",
        "blockStorageDescription": "Test block storage",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 4000,
        "isEncryptedVolume": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "isReturnProtection": false,
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        }
      }
    ],
    "requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index