getBlockStorageInstanceDetail

Available in VPC

Get details of a block storage instance.

Syntax

The getBlockStorageInstanceDetail syntax is as follows:

./ncloud vserver getBlockStorageInstanceDetail \
    --blockStorageInstanceNo <block-storage-instance-no> \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getBlockStorageInstanceDetail.

Required options

The following options are required for getBlockStorageInstanceDetail.

Options	Type	Required	Description
`--blockStorageInstanceNo`	String	Required	Block storage instance number See getBlockStorageInstanceList.

Common options

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

Examples

If the request to retrieve block storage instance details is successful, the block storage's identification and configuration information is returned.

Command

The command example is as follows:

./ncloud vserver getBlockStorageInstanceDetail \
    --blockStorageInstanceNo 89012345 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getBlockStorageInstanceDetailResponse": {
    "totalRows": 1,
    "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"
        }
      }
    ],
    "requestId": "d1e2f3a4-b5c6-7890-defa-234567890123",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index