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.

getBlockStorageSnapshotInstanceList

Prev Next

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