getBlockStorageSnapshotInstanceList

Available in VPC

Get the list of block storage snapshot instances.

Syntax

The getBlockStorageSnapshotInstanceList syntax is as follows:

./ncloud vserver getBlockStorageSnapshotInstanceList \
    [--originalBlockStorageInstanceNoList <original-block-storage-instance-no-list>] \
    [--blockStorageSnapshotInstanceNoList <block-storage-snapshot-instance-no-list>] \
    [--blockStorageSnapshotName <block-storage-snapshot-name>] \
    [--blockStorageSnapshotVolumeSize <block-storage-snapshot-volume-size>] \
    [--isEncryptedOriginalBlockStorageVolume <true|false>] \
    [--hypervisorTypeCodeList <hypervisor-type-code-list>] \
    [--isBootable <true|false>] \
    [--blockStorageSnapshotInstanceStatusCode <INIT|CREAT>] \    
    [--pageNo <page-no>] \
    [--pageSize <page-size>] \
    [--sortedBy <blockStorageSnapshotName>] \
    [--sortingOrder <ASC|DESC>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getBlockStorageSnapshotInstanceList.

Required options

The following options are required for getBlockStorageSnapshotInstanceList.

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 getBlockStorageSnapshotInstanceList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--originalBlockStorageInstanceNoList`	List	Optional	Source storage number list You can enter multiple items separated by spaces. (e.g., `--originalBlockStorageInstanceNoList 1234 2345`) See getBlockStorageInstanceList.
`--blockStorageSnapshotInstanceNoList`	List	Optional	Snapshot instance number list You can enter multiple items separated by spaces. (e.g., `--blockStorageSnapshotInstanceNoList 1234 2345`)
`--blockStorageSnapshotName`	String	Optional	Snapshot name
`--blockStorageSnapshotVolumeSize`	Integer	Optional	Snapshot size (GB) Query snapshots up to the entered size.
`--isEncryptedOriginalBlockStorageVolume`	Boolean	Optional	Source storage encryption status `true` \| `false` `true`: Encrypted `false`: Not encrypted
`--hypervisorTypeCodeList`	List	Optional	Hypervisor type code list `XEN` \| `KVM` You can enter multiple items separated by spaces. (e.g., `--hypervisorTypeCodeList XEN KVM`)
`--isBootable`	Boolean	Optional	Whether server images can be created `true` \| `false` `true`: Available `false`: Unavailable
`--blockStorageSnapshotInstanceStatusCode`	String	Optional	Snapshot instance status code `INIT` \| `CREAT` `INIT`: Creating `CREAT`: Available
`--pageNo`	Integer	Optional	Page number `0`-N (default: `0`) First page: Enter `0` or `1`.
`--sortedBy`	String	Optional	Sort by `blockStorageSnapshotName`: Snapshot name
`--sortingOrder`	String	Optional	Sort order `ASC` (default) \| `DESC` `ASC`: Ascending order `DESC`: Descending order

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 snapshot instances is successful, the identification and configuration information for each snapshot is returned.

Command

The command example is as follows:

./ncloud vserver getBlockStorageSnapshotInstanceList \
    --originalBlockStorageInstanceNoList 89012345 \
    --blockStorageSnapshotInstanceNoList 90123456 90123457 \
    --blockStorageSnapshotVolumeSize 100 \
    --isEncryptedOriginalBlockStorageVolume false \
    --hypervisorTypeCodeList XEN KVM \
    --isBootable true \
    --pageNo 0 \
    --pageSize 10 \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getBlockStorageSnapshotInstanceListResponse": {
    "totalRows": 2,
    "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"
        }
      },
      {
        "blockStorageSnapshotInstanceNo": "90123457",
        "blockStorageSnapshotName": "nbs0000000000001",
        "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-14T19:41:22+0900",
        "isEncryptedOriginalBlockStorageVolume": false,
        "blockStorageSnapshotDescription": "auto created by server image - test-image-01 (45678901)",
        "snapshotType": {
          "code": "FULL",
          "codeName": "Full Storage Snapshot"
        },
        "snapshotChainDepth": 0,
        "isBootable": true,
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        }
      }
    ],
    "requestId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index