getBlockStorageInstanceList

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

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

요청

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

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

참고

가이드는 GET 방식 기준으로 안내합니다. POST 방식의 호출 테스트는 네이버 클라우드 플랫폼 콘솔의 API Gateway 서비스에서 Swagger를 통해서 가능합니다.

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`regionCode`	String	Optional	리전 코드 getRegionList 참조 조회 결과의 첫 번째 리전 (기본값)
`zoneCode`	String	Optional	존 코드 getZoneList 참조
`blockStorageInstanceNoList.N`	Array	Optional	블록 스토리지 인스턴스 번호 목록 블록 스토리지 인스턴스 번호로 필터링 getBlockStorageInstanceList 참조 <예시> `blockStorageInstanceNoList.1=1234&blockStorageInstanceNoList.2=2345`
`blockStorageInstanceStatusCode`	String	Optional	블록 스토리지 인스턴스 상태 코드로 필터링 `INIT` \| `CREAT` \| `ATTAC` `INIT`: 생성 중 `CREAT`: 사용 가능 `ATTAC`: 사용 중
`blockStorageDiskTypeCode`	String	Optional	블록 스토리지 디스크 유형 코드로 필터링 `NET`: 네트워크 디스크 (유효 값)
`blockStorageDiskDetailTypeCode`	String	Optional	블록 스토리지 디스크 상세 유형 코드로 필터링 `HDD` \| `SSD`
`blockStorageSize`	Integer	Optional	블록 스토리지 크기로 필터링 입력한 크기(GB) 이하의 블록 스토리지 조회 가능
`blockStorageTypeCodeList.N`	Array	Optional	블록 스토리지 타입 코드 목록 `BASIC` \| `SVRBS` `BASIC`: 기본 스토리지 `SVRBS`: 추가 스토리지 블록 스토리지 타입 코드로 필터링 <예시> `blockStorageTypeCodeList.1=BASIC&blockStorageTypeCodeList.2=SVRBS`
`serverInstanceNo`	String	Optional	서버 인스턴스 번호로 필터링 getServerInstanceList 참조
`blockStorageName`	String	Optional	블록 스토리지 이름으로 필터링 `blockStorageName`, `serverName`, `connectionInfo` 중 하나만 사용
`serverName`	String	Optional	블록 스토리지 연결 서버 이름으로 필터링 `blockStorageName`, `serverName`, `connectionInfo` 중 하나만 사용
`connectionInfo`	String	Optional	블록 스토리지 연결 정보로 필터링 `{서버 이름} {디바이스 이름}` 또는 `{서버 이름}:{디바이스 이름}` 형태로 입력 <예시> `s173dc67dc2e /dev/xvda`, `s173dc67dc2e:/dev/xvda` `blockStorageName`, `serverName`, `connectionInfo` 중 하나만 사용
`blockStorageVolumeTypeCodeList.N`	Array	Optional	블록 스토리지 볼륨 타입 코드 목록 `HDD` \| `SSD` \| `FB1` \| `CB1` 블록 스토리지 볼륨 타입 코드로 필터링 <예시> `blockStorageVolumeTypeCodeList.1=SSD&blockStorageVolumeTypeCode.2=CB1`
`hypervisorTypeCodeList.N`	Array	Optional	하이퍼바이저 타입 코드 목록 `XEN` \| `KVM` 하이퍼바이저 타입 코드로 필터링 <예시> `hypervisorTypeCodeList.1=XEN`
`pageNo`	Integer	Optional	페이지 번호 0~N (기본값: 0) 첫 번째 페이지: `0` 또는 `1` 입력
`pageSize`	Integer	Conditional	페이지당 항목 수 1~1000 (기본값: 1) `pageNo` 입력 시 필수 입력
`responseFormatType`	String	Optional	응답 데이터의 형식 `xml` (기본값) \| `json`

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageInstanceList
?regionCode=KR
&blockStorageTypeCodeList.1=SVRBS
&blockStorageInstanceStatusCode=CREAT
&hypervisorTypeCodeList.1=KVM
&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}'

응답

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

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
  "getBlockStorageInstanceListResponse": {
    "totalRows": 1,
    "blockStorageInstanceList": [
      {
        "blockStorageInstanceNo": "10*****68",
        "blockStorageName": "storageX",
        "blockStorageType": {
          "code": "SVRBS",
          "codeName": "서버 BS"
        },
        "blockStorageSize": 10737418240,
        "blockStorageProductCode": "BST.CB.CB1.V001",
        "blockStorageInstanceStatus": {
          "code": "CREAT",
          "codeName": "블록스토리지 CREATED 상태"
        },
        "blockStorageInstanceOperation": {
          "code": "NULL",
          "codeName": "블록스토리지 NULL OP"
        },
        "blockStorageInstanceStatusName": "detached",
        "createDate": "2025-06-20T15:35:25+0900",
        "blockStorageDiskType": {
          "code": "NET",
          "codeName": "네트웍 스토리지"
        },
        "blockStorageDiskDetailType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "maxIopsThroughput": 100,
        "isEncryptedVolume": false,
        "zoneCode": "KR-2",
        "regionCode": "KR",
        "isReturnProtection": true,
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "throughput": 104857600,
        "iops": 100
      }
    ],
    "requestId": "4c0c5ebb-****-****-****-fb47d14bd21a",
    "returnCode": "0",
    "returnMessage": "success"
  }
}