getBlockStorageVolumeTypeList

Prev Next

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

사용 가능한 블록 스토리지 볼륨 타입 코드 목록을 조회합니다.

요청

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

메서드 URI
GET | POST /vserver/v2/getBlockStorageVolumeTypeList
참고

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

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
regionCode String Optional 리전 코드
  • getRegionList 참조
    • 조회 결과의 첫 번째 리전 (기본값)
zoneCode String Optional 존 코드
blockStorageVolumeTypeCodeList.N Array Optional 블록 스토리지 볼륨 타입 코드 목록
  • 블록 스토리지 볼륨 타입 코드로 필터링
  • getBlockStorageVolumeTypeList 참조
  • <예시> blockStorageVolumeTypeCodeList.1=SSD&blockStorageVolumeTypeCodeList.2=CB1
hypervisorTypeCodeList.N Array Optional 하이퍼바이저 타입 코드 목록
  • XEN | KVM
  • getHypervisorTypeList 참조
  • 하이퍼바이저 타입 코드로 필터링
  • <예시> hypervisorTypeCodeList.1=XEN&hypervisorTypeCodeList.2=KVM
serverSpecCode String Optional 서버 스펙 코드로 필터링
isBaseStorageAvailable Boolean Optional 기본 스토리지 가능 여부로 필터링
  • true | false
    • true: 가능
    • false: 불가능
responseFormatType String Optional 응답 데이터의 형식
  • xml (기본값) | json

요청 예시

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

curl --location --request GET 'https://ncloud.apigw.ntruss.com/vserver/v2/getBlockStorageVolumeTypeList
?regionCode=KR
&blockStorageVolumeTypeCodeList.1=CB1
&blockStorageVolumeTypeCodeList.2=SSD
&hypervisorTypeCodeList.1=XEN
&hypervisorTypeCodeList.2=KVM
&isBaseStorageAvailable=true
&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}'

응답

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

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
  "getBlockStorageVolumeTypeListResponse": {
    "totalRows": 2,
    "blockStorageVolumeTypeList": [
      {
        "blockStorageVolumeType": {
          "code": "CB1",
          "codeName": "Common BlockStorage 1"
        },
        "hypervisorType": {
          "code": "KVM",
          "codeName": "KVM"
        },
        "minBaseVolumeSize": 10,
        "maxBaseVolumeSize": 2000,
        "minVolumeSize": 10,
        "maxVolumeSize": 16380,
        "minIops": 100,
        "maxIops": 16000,
        "minThroughput": 100,
        "maxThroughput": 250,
        "zoneCodeList": [
          "KR-1",
          "KR-2"
        ],
        "isBaseStorageAvailable": true
      },
      {
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "minBaseVolumeSize": 50,
        "maxBaseVolumeSize": 100,
        "minVolumeSize": 10,
        "maxVolumeSize": 2000,
        "zoneCodeList": [
          "KR-2",
          "KR-1"
        ],
        "isBaseStorageAvailable": true
      }
    ],
    "requestId": "fc05c29d-****-****-****-149469afb646",
    "returnCode": "0",
    "returnMessage": "success"
  }
}