Documentation Index

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

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

getBlockStorageSnapshotInstanceList

Prev Next

VPC 환경에서 이용 가능합니다.

개요

블록 스토리지 스냅샷 인스턴스 리스트를 조회합니다.

요청

요청 파라미터

파라미터명 필수 여부 타입 제약 사항 설명
regionCode No String - 리전 코드
블록 스토리지 스냅샷 인스턴스 리스트가 조회될 리전(Region) 결정 가능
regionCode는 getRegionList 액션을 통해 획득 가능
Default : getRegionList 조회 결과의 첫 번째 리전을 선택
blockStorageSnapshotInstanceNoList.N No List<String> - 블록 스토리지 스냅샷 인스턴스 번호 리스트
블록 스토리지 스냅샷 인스턴스 번호로 필터링하여 검색 가능
blockStorageSnapshotInstanceNo는 getBlockStorageSnapshotInstanceList 액션을 통해 획득 가능
ex) --blockStorageSnapshotInstanceNoList 1234 2345
blockStorageSnapshotName No String - 블록 스토리지 스냅샷 이름
블록 스토리지 스냅샷 이름으로 필터링하여 검색 가능
blockStorageSnapshotInstanceStatusCode No String - 블록 스토리지 스냅샷 인스턴스 상태 코드
블록 스토리지 스냅샷 인스턴스 상태 코드로 필터링하여 검색 가능
Options : INIT | CREAT
originalBlockStorageInstanceNoList.N No List<String> - 원본 블록 스토리지 인스턴스 번호 리스트
원본 블록 스토리지 인스턴스 번호로 필터링하여 검색 가능
originalBlockStorageInstanceNo는 getBlockStorageInstanceList 액션을 통해 획득 가능
ex) --originalBlockStorageInstanceNoList 1234 2345
blockStorageSnapshotVolumeSize No Integer - 블록 스토리지 스냅샷 볼륨 사이즈
입력한 GB 단위 사이즈 이하의 블록스토리지 스냅샷을 필터링하여 검색 가능
isEncryptedOriginalBlockStorageVolume No Boolean - 원본 블록 스토리지 볼륨 암호화 여부
원본 블록 스토리지 볼륨의 암호화 여부로 필터링하여 검색 가능
Options : true | false
pageNo No Integer - 페이징된 결과의 페이지 번호
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageSize Conditional Integer - 페이징 시 보여줄 각 페이지 사이즈
결과값을 pageNo, pageSize를 이용하여 페이징 처리 가능
pageNo 입력시 반드시 입력함
sortedBy No String - 정렬 대상
결과값을 블록 스토리지 스냅샷 이름으로 정렬 가능
Options : blockStorageSnapshotName
sortingOrder No String - 정렬 순서
sortedBy 이용시 오름차순/내림차순 정렬을 설정함
Options : ASC (오름차순) | DESC (내림차순)
Default : ASC
output No String 응답 결과의 포맷 타입
  • Options : xml | json
  • Default : json

응답

응답 데이터 타입

  • BlockStorageSnapshotInstanceList 타입
BlockStorageSnapshotInstanceList extends CommonResponse
private Integer totalRows;
private List blockStorageSnapshotInstanceList = new ArrayList<>();
BlockStorageSnapshotInstance
private String blockStorageSnapshotInstanceNo;
private String blockStorageSnapshotName;
private Long blockStorageSnapshotVolumeSize;
private String originalBlockStorageInstanceNo;
private CommonCode blockStorageSnapshotInstanceStatus;
private CommonCode blockStorageSnapshotInstanceOperation;
private String blockStorageSnapshotInstanceStatusName;
private Date createDate;
private Boolean isEncryptedOriginalBlockStorageVolume;
private String blockStorageSnapshotDescription;
private CommonCode snapshotType;
private String baseSnapshotInstanceNo;
private Integer snapshotChainDepth;
private CommonCode hypervisorType;
private Boolean isBootable;
private CommonCode blockStorageVolumeType;

예시

요청 예시

ncloud vserver getBlockStorageSnapshotInstanceList --regionCode KR --blockStorageSnapshotInstanceNoList ***1951 --blockStorageSnapshotName test-*** --blockStorageSnapshotInstanceStatusCode CREAT --originalBlockStorageInstanceNoList ***7746 --blockStorageSnapshotVolumeSize 50 --isEncryptedOriginalBlockStorageVolume false

응답 예시

<getBlockStorageSnapshotInstanceListResponse>
  <requestId>08cacedf-cfd7-4a8d-a495-89aa0d72f7ca</requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageSnapshotInstanceList>
    <blockStorageSnapshotInstance>
      <blockStorageSnapshotInstanceNo>***1951</blockStorageSnapshotInstanceNo>
      <blockStorageSnapshotName>test-***</blockStorageSnapshotName>
      <blockStorageSnapshotVolumeSize>53687091200</blockStorageSnapshotVolumeSize>
      <originalBlockStorageInstanceNo>***7746</originalBlockStorageInstanceNo>
      <blockStorageSnapshotInstanceStatus>
        <code>CREAT</code>
        <codeName>Block storage CREATED state</codeName>
      </blockStorageSnapshotInstanceStatus>
      <blockStorageSnapshotInstanceOperation>
        <code>NULL</code>
        <codeName>Block Storage NULLOP</codeName>
      </blockStorageSnapshotInstanceOperation>
      <blockStorageSnapshotInstanceStatusName>created</blockStorageSnapshotInstanceStatusName>
      <createDate>2020-08-25T10:18:15+0900</createDate>
      <isEncryptedOriginalBlockStorageVolume>false</isEncryptedOriginalBlockStorageVolume>
      <blockStorageSnapshotDescription></blockStorageSnapshotDescription>
      <snapshotType>
        <code>FULL</code>
        <codeName>Full Storage Snapshot</codeName>
      </snapshotType>
      <baseSnapshotInstanceNo/>
      <snapshotChainDepth>0</snapshotChainDepth>
      <isBootable>true</isBootable>
      <hypervisorType>
          <code>KVM</code>
          <codeName>KVM</codeName>
      </hypervisorType>
      <blockStorageVolumeType>
          <code>CB1</code>
          <codeName>Common BlockStorage 1</codeName>
      </blockStorageVolumeType>
    </blockStorageSnapshotInstance>
  </blockStorageSnapshotInstanceList>
</getBlockStorageSnapshotInstanceListResponse>