getBlockStorageSnapshotInstanceList

VPC環境で利用できます。

ブロックストレージのスナップショットインスタンスリストを照会します。

構文

getBlockStorageSnapshotInstanceList構文は次の通りです。

./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>]

オプション

getBlockStorageSnapshotInstanceListの実行時に指定できるオプションについて説明します。

必須オプション

getBlockStorageSnapshotInstanceListの必須オプションです。

オプション	タイプ	必須の有無	説明
`--pageSize`	Integer	Conditional	ページごとの項目数 `1`~`1000` (デフォルト: `1`) `pageNo`入力時、必ず入力

任意オプション

getBlockStorageSnapshotInstanceListの任意オプションです。指定しない場合、オプションにはデフォルト値が適用されます。

オプション	タイプ	必須の有無	説明
`--originalBlockStorageInstanceNoList`	List	Optional	ソースストレージ番号リストスペースで区切って複数入力可能 (例: `--originalBlockStorageInstanceNoList 1234 2345`) getBlockStorageInstanceListを参照
`--blockStorageSnapshotInstanceNoList`	List	Optional	スナップショットインスタンス番号リストスペースで区切って複数入力可能 (例: `--blockStorageSnapshotInstanceNoList 1234 2345`)
`--blockStorageSnapshotName`	String	Optional	スナップショット名
`--blockStorageSnapshotVolumeSize`	Integer	Optional	スナップショットサイズ (GB) 入力したサイズ以下のスナップショットを照会
`--isEncryptedOriginalBlockStorageVolume`	Boolean	Optional	ソースストレージは暗号化するか `true` \| `false` `true`: 暗号化 `false`: 暗号化しない
`--hypervisorTypeCodeList`	List	Optional	ハイパーバイザタイプコードリスト `XEN` \| `KVM` スペースで区切って複数入力可能 (例: `--hypervisorTypeCodeList XEN KVM`)
`--isBootable`	Boolean	Optional	サーバイメージが作成可能か `true` \| `false` `true`: 可能 `false`: 不可
`--blockStorageSnapshotInstanceStatusCode`	String	Optional	スナップショットインスタンスの状態コード `INIT` \| `CREAT` `INIT`: 作成中 `CREAT`: 使用可能
`--pageNo`	Integer	Optional	ページ番号 `0`~N (デフォルト: `0`) 最初のページ: `0`または`1`を入力
`--sortedBy`	String	Optional	ソート基準 `blockStorageSnapshotName`: スナップショット名
`--sortingOrder`	String	Optional	ソート順序 `ASC` (デフォルト) \| `DESC` `ASC`: 昇順 `DESC`: 降順

共通オプション

vserverコマンドで共通して使用するオプションについては、Server (VPC)のオプションをご参照ください。

例

ブロックストレージのスナップショットインスタンスリストの照会リクエストが成功すると、各スナップショットの識別情報および構成情報が返されます。

コマンド

コマンドの例は次の通りです。

./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

出力

出力の例は次の通りです。

{
  "getBlockStorageSnapshotInstanceListResponse": {
    "totalRows": 2,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "90123456",
        "blockStorageSnapshotName": "test-snapshot-01",
        "blockStorageSnapshotVolumeSize": 10737418240,
        "originalBlockStorageInstanceNo": "89012345",
        "blockStorageSnapshotInstanceStatus": {
          "code": "INIT",
          "codeName": "ブロックストレージ INIT状態"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "CREAT",
          "codeName": "ブロックストレージ 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": "ブロックストレージ CREATED状態"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ 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