getBlockStorageSnapshotInstanceDetail

Available in VPC

Get details of a block storage snapshot instance.

Syntax

The getBlockStorageSnapshotInstanceDetail syntax is as follows:

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

Options

This section describes the options available when running getBlockStorageSnapshotInstanceDetail.

Required options

The following options are required for getBlockStorageSnapshotInstanceDetail.

Options	Type	Required	Description
`--blockStorageSnapshotInstanceNo`	String	Required	Snapshot instance number See getBlockStorageSnapshotInstanceList.

Common options

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

Examples

If the request to retrieve detailed information about a block storage snapshot instance is successful, the snapshot's identification and configuration information is returned.

Command

The command example is as follows:

./ncloud vserver getBlockStorageSnapshotInstanceDetail \
    --blockStorageSnapshotInstanceNo 90123456 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getBlockStorageSnapshotInstanceDetailResponse": {
    "totalRows": 1,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "90123456",
        "blockStorageSnapshotName": "test-snapshot-01",
        "blockStorageSnapshotVolumeSize": 10737418240,
        "originalBlockStorageInstanceNo": "89012345",
        "blockStorageSnapshotInstanceStatus": {
          "code": "CREAT",
          "codeName": "Block storage CREATED status"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "NULL",
          "codeName": "Block storage NULL OP"
        },
        "blockStorageSnapshotInstanceStatusName": "created",
        "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": "c3d4e5f6-a7b8-9012-cdef-345678901234",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index