Documentation Index

Fetch the complete documentation index at: https://cli.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

getBlockStorageInstanceList

Prev Next

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의 필수 옵션입니다.

옵션 타입 필수 여부 설명
--pageSize Integer Conditional 페이지당 항목 수
  • 1~1000 (기본값: 1)
  • pageNo 입력 시 필수 입력

선택 옵션

getBlockStorageInstanceList의 선택 옵션입니다. 지정하지 않은 옵션에는 기본값이 적용됩니다.

옵션 타입 필수 여부 설명
--zoneCode String Optional 존 코드
--blockStorageInstanceNoList List Optional 블록 스토리지 인스턴스 번호 목록
  • 공백으로 구분하여 여러 개 입력 가능 (예시: --blockStorageInstanceNoList 1234 2345)
--blockStorageName String Optional 블록 스토리지 이름
  • blockStorageName, serverName, connectionInfo 중 하나만 사용
--blockStorageInstanceStatusCode String Optional 블록 스토리지 인스턴스 상태 코드
  • INIT | CREAT | ATTAC
    • INIT: 생성 중
    • CREAT: 사용 가능
    • ATTAC: 사용 중
--blockStorageDiskTypeCode String Optional 블록 스토리지 디스크 유형 코드
  • NET: 네트워크 디스크
--blockStorageDiskDetailTypeCode String Optional 블록 스토리지 디스크 상세 유형 코드
  • HDD | SSD
--blockStorageSize Integer Optional 블록 스토리지 크기 (GB)
  • 입력한 크기 이하의 블록 스토리지 조회
--blockStorageTypeCodeList List Optional 블록 스토리지 유형 코드 목록
  • BASIC | SVRBS
    • BASIC: 기본 스토리지
    • SVRBS: 추가 스토리지
  • 공백으로 구분하여 여러 개 입력 가능 (예시: --blockStorageTypeCodeList BASIC SVRBS)
--blockStorageVolumeTypeCodeList List Optional 블록 스토리지 볼륨 유형 코드 목록
  • HDD | SSD | FB1 | CB1
  • 공백으로 구분하여 여러 개 입력 가능 (예시: --blockStorageVolumeTypeCodeList SSD CB1)
--hypervisorTypeCodeList List Optional 하이퍼바이저 유형 코드 목록
  • XEN | KVM
  • 공백으로 구분하여 여러 개 입력 가능 (예시: --hypervisorTypeCodeList XEN KVM)
  • getHypervisorTypeList 참조
--serverInstanceNo String Optional 서버 인스턴스 번호
--serverName String Optional 블록 스토리지 연결 서버 이름
  • blockStorageName, serverName, connectionInfo 중 하나만 사용
--connectionInfo String Optional 블록 스토리지 연결 정보
  • {서버 이름} {디바이스 이름} 또는 {서버 이름}:{디바이스 이름} 형태로 입력 (예시: s173dc67dc2e /dev/xvda, s173dc67dc2e:/dev/xvda)
  • blockStorageName, serverName, connectionInfo 중 하나만 사용
--pageNo Integer Optional 페이지 번호
  • 0~N (기본값: 0)
  • 첫 번째 페이지: 0 또는 1 입력

공통 옵션

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"
  }
}