getBlockStorageInstanceList

Available in VPC

Get the list of block storage instances.

Syntax

The getBlockStorageInstanceList syntax is as follows:

./ncloud vserver getBlockStorageInstanceList \
    [--zoneCode <zone-code>] \
    [--blockStorageInstanceNoList <block-storage-instance-no-list>] \
    [--blockStorageName <block-storage-name>] \
    [--blockStorageInstanceStatusCode <INIT|CREAT|ATTAC>] \
    [--blockStorageDiskTypeCode <NET>] \
    [--blockStorageDiskDetailTypeCode <HDD|SSD>] \
    [--blockStorageSize <block-storage-size>] \
    [--blockStorageTypeCodeList <block-storage-type-code-list>] \
    [--blockStorageVolumeTypeCodeList <block-storage-volume-type-code-list>] \
    [--hypervisorTypeCodeList <hypervisor-type-code-list>] \
    [--serverInstanceNo <server-instance-no>] \
    [--serverName <server-name>] \
    [--connectionInfo <connection-info>] \
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getBlockStorageInstanceList.

Required options

The following options are required for getBlockStorageInstanceList.

Options	Type	Required	Description
`--pageSize`	Integer	Conditional	Number of items per page `1`-`1000` (default: `1`) Required when entering `pageNo`

Optional options

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

Options	Type	Required	Description
`--zoneCode`	String	Optional	Zone code See getZoneList.
`--blockStorageInstanceNoList`	List	Optional	Block storage instance number list You can enter multiple items separated by spaces. (e.g., `--blockStorageInstanceNoList 1234 2345`)
`--blockStorageName`	String	Optional	Block storage name Only use one among `blockStorageName`, `serverName`, and `connectionInfo`.
`--blockStorageInstanceStatusCode`	String	Optional	Block storage instance status code `INIT` \| `CREAT` \| `ATTAC` `INIT`: Creating `CREAT`: Available `ATTAC`: In use
`--blockStorageDiskTypeCode`	String	Optional	Block storage disk type code `NET`: Network disk
`--blockStorageDiskDetailTypeCode`	String	Optional	Detailed type code of block storage disk `HDD` \| `SSD`
`--blockStorageSize`	Integer	Optional	Block storage size (GB) Query block storage up to the entered size (GB).
`--blockStorageTypeCodeList`	List	Optional	Block storage type code list `BASIC` \| `SVRBS` `BASIC`: Default storage `SVRBS`: Additional storage You can enter multiple items separated by spaces. (e.g., `--blockStorageTypeCodeList BASIC SVRBS`)
`--blockStorageVolumeTypeCodeList`	List	Optional	Block storage volume type code list `HDD` \| `SSD` \| `FB1` \| `CB1` You can enter multiple items separated by spaces. (e.g., `--blockStorageVolumeTypeCodeList SSD CB1`)
`--hypervisorTypeCodeList`	List	Optional	Hypervisor type code list `XEN` \| `KVM` You can enter multiple items separated by spaces. (e.g., `--hypervisorTypeCodeList XEN KVM`) See getHypervisorTypeList.
`--serverInstanceNo`	String	Optional	Server instance number See getServerInstanceList.
`--serverName`	String	Optional	Name of the server connected to the block storage Only use one among `blockStorageName`, `serverName`, and `connectionInfo`.
`--connectionInfo`	String	Optional	Block storage connection information Enter in the {Server name} {Device name} or {Server name}:{Device name} format. (e.g., `s173dc67dc2e /dev/xvda`, `s173dc67dc2e:/dev/xvda`) Only use one among `blockStorageName`, `serverName`, and `connectionInfo`.
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`) First page: Enter `0` or `1`.

Common options

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

Examples

If the request to retrieve the list of block storage instances is successful, the identification and configuration information for each block storage instance is returned.

Command

The command example is as follows:

./ncloud vserver getBlockStorageInstanceList \
    --zoneCode KR-1 \
    --blockStorageInstanceStatusCode ATTAC \
    --blockStorageDiskTypeCode NET \
    --blockStorageDiskDetailTypeCode SSD \
    --blockStorageTypeCodeList BASIC SVRBS \
    --blockStorageVolumeTypeCodeList SSD CB1 \
    --hypervisorTypeCodeList XEN KVM \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getBlockStorageInstanceListResponse": {
    "totalRows": 3,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "89012345",
        "serverInstanceNo": "34567890",
        "blockStorageName": "test-block-storage-01",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "Server BS"
        },
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvdb",
        "blockStorageProductCode": "SPBSTBSTAD000006",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED status"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "Block storage NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "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"
        }
      },
      {
        "blockStorageInstanceNo": "89012346",
        "serverInstanceNo": "34567890",
        "blockStorageName": "test-server-02",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "Default BS"
        },
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED status"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "Block storage NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2026-05-14T17:29:43+0900",
        "blockStorageDescription": "test-server-02's basic 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"
        }
      },
      {
        "blockStorageInstanceNo": "89012347",
        "serverInstanceNo": "34567891",
        "blockStorageName": "test-server-01",
        "blockStorageType": {
          "code": "BASIC",
          "codeName": "Default BS"
        },
        "blockStorageSize": 10737418240,
        "deviceName": "/dev/vda",
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "Block storage ATTACHED status"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "Block storage NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2026-04-28T13:01:30+0900",
        "blockStorageDescription": "test-server-01's basic storage",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "Network storage"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 100,
        "isEncryptedVolume": false,
        "zoneCode": "KR-1",
        "regionCode": "KR",
        "isReturnProtection": false,
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "throughput": 104857600,
        "iops": 100,
        "blockStorageSnapshotInstanceNo": 90123456
      }
    ],
    "requestId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index