getBlockStorageSnapshotInstanceList

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

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

요청

요청 형식에 대해 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
GET \| POST	/vserver/v2/getBlockStorageSnapshotInstanceList

요청 헤더

Server API에서 공통으로 사용하는 헤더에 대한 정보는 Server 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`regionCode`	String	Optional	리전 코드 getRegionList 참조 조회 결과의 첫 번째 리전 (기본값)
`blockStorageSnapshotInstanceNoList.N`	Array	Optional	스냅샷 인스턴스 번호 목록 스냅샷 인스턴스 번호로 필터링 <예시> `blockStorageSnapshotInstanceNoList.1=1234&blockStorageSnapshotInstanceNoList.2=2345`
`blockStorageSnapshotName`	String	Optional	스냅샷 이름으로 필터링
`blockStorageSnapshotInstanceStatusCode`	String	Optional	스냅샷 인스턴스 상태 코드로 필터링 `INIT` \| `CREAT` `INIT`: 생성 중 `CREAT`: 사용 가능
`originalBlockStorageInstanceNoList.N`	Array	Optional	원본 스토리지 번호 목록 원본 스토리지 번호로 필터링 getBlockStorageInstanceList 참조 <예시> `originalBlockStorageInstanceNoList.1=1234&originalBlockStorageInstanceNoList.2=2345`
`blockStorageSnapshotVolumeSize`	Integer	Optional	스냅샷 크기로 필터링 입력한 크기(GB) 이하의 스냅샷 조회 가능
`isEncryptedOriginalBlockStorageVolume`	Boolean	Optional	원본 스토리지 암호화 여부로 필터링 `true` \| `false` `true`: 암호화 `false`: 암호화 안 함
`hypervisorTypeCodeList.N`	Array	Optional	하이퍼바이저 타입 코드 목록 `XEN` \| `KVM` 하이퍼바이저 타입 코드로 필터링 <예시> `hypervisorTypeCodeList.1=KVM`
`isBootable`	Boolean	Optional	서버 이미지 생성 가능 여부로 필터링 `true` \| `false` `true`: 가능 `false`: 불가능
`pageNo`	Integer	Optional	페이지 번호 0~N (기본값: 0) 첫 번째 페이지: `0` 또는 `1` 입력
`pageSize`	Integer	Conditional	페이지당 항목 수 1~1000 (기본값: 1) `pageNo` 입력 시 필수 입력
`sortedBy`	String	Optional	정렬 기준 `blockStorageSnapshotName`: 스냅샷 이름 (유효 값)
`sortingOrder`	String	Optional	정렬 순서 `ASC` (기본값) \| `DESC` `ASC`: 오름차순 `DESC`: 내림차순
`responseFormatType`	String	Optional	응답 데이터의 형식 `xml` (기본값) \| `json`

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageSnapshotInstanceList
?regionCode=KR
&originalBlockStorageInstanceNoList.1=10*****19
&blockStorageSnapshotInstanceStatusCode=CREAT
&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식에 대해 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`getBlockStorageSnapshotInstanceListResponse`	Object	-	응답 결과 BlockStorageSnapshotInstanceList 참조
`getBlockStorageSnapshotInstanceListResponse.requestId`	String	-	요청에 대한 아이디 UUID 형식
`getBlockStorageSnapshotInstanceListResponse.returnCode`	String	-	응답 코드
`getBlockStorageSnapshotInstanceListResponse.returnMessage`	String	-	응답 메시지

응답 상태 코드

Server API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Server 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "getBlockStorageSnapshotInstanceListResponse": {
    "totalRows": 1,
    "blockStorageSnapshotInstanceList": [
      {
        "blockStorageSnapshotInstanceNo": "10*****50",
        "blockStorageSnapshotName": "snapshot1",
        "blockStorageSnapshotVolumeSize": 53687091200,
        "originalBlockStorageInstanceNo": "10*****19",
        "blockStorageSnapshotInstanceStatus": {
          "code": "CREAT",
          "codeName": "블록스토리지 CREATED 상태"
        },
        "blockStorageSnapshotInstanceOperation": {
          "code": "NULL",
          "codeName": "블록스토리지 NULL OP"
        },
        "blockStorageSnapshotInstanceStatusName": "created",
        "createDate": "2025-06-20T14:05:34+0900",
        "isEncryptedOriginalBlockStorageVolume": false,
        "snapshotType": {
          "code": "FULL",
          "codeName": "Full Storage Snapshot"
        },
        "snapshotChainDepth": 0,
        "isBootable": false,
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        }
      }
    ],
    "requestId": "2c5c9b1d-****-****-****-70bf191962eb",
    "returnCode": "0",
    "returnMessage": "success"
  }
}