getBlockStorageInstanceList

VPC環境で利用できます。

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

構文

getBlockStorageInstanceList構文は次の通りです。

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

オプション

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

必須オプション

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

任意オプション

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

共通オプション

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

例

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

コマンド

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

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

出力

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

{
  "getBlockStorageInstanceListResponse": {
    "totalRows": 3,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "89012345",
        "serverInstanceNo": "34567890",
        "blockStorageName": "test-block-storage-01",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "サーバ BS"
        },
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvdb",
        "blockStorageProductCode": "SPBSTBSTAD000006",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "ブロックストレージ ATTACHED状態"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2026-05-14T20:18:21+0900",
        "blockStorageDescription": "Test block storage",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "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": "基本 BS"
        },
        "blockStorageSize": 53687091200,
        "deviceName": "/dev/xvda",
        "blockStorageProductCode": "SPBSTBSTBS000005",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "ブロックストレージ ATTACHED状態"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2026-05-14T17:29:43+0900",
        "blockStorageDescription": "test-server-02's basic storage",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "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": "基本 BS"
        },
        "blockStorageSize": 10737418240,
        "deviceName": "/dev/vda",
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "ATTAC",
          "codeName": "ブロックストレージ ATTACHED状態"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "ブロックストレージ NULL OP"
        },
        "blockStorageInstanceStatusName": "attached",
        "createDate": "2026-04-28T13:01:30+0900",
        "blockStorageDescription": "test-server-01's basic storage",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "ネットワークストレージ"
        },
        "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"
  }
}