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.

getBlockStorageVolumeTypeList

Prev Next

Available in VPC

Overview

Get the list of block storage volume types.

Request

Request parameters

Parameter name Required Type Restrictions Description
regionCode No String - Region code
  • Determine the Region in which the block storage snapshot instance list will be queried.
  • regionCode can be obtained through the getRegionList action.
  • Default: Select the first Region of the getRegionList query result.
zoneCode No String - Zone code
  • Determine the zone where the block storage instance list will be queried.
  • zoneCode can be obtained through the getZoneList action.
blockStorageVolumeTypeCodeList No List<String> - Block storage volume type code list
  • Search by filtering with block storage volume type code.
  • Example) --blockStorageVolumeTypeCodeList SSD
hypervisorTypeCodeList No List<String> - Hypervisor type code list
  • hypervisorTypeCode can be obtained through the getHypervisorTypeList action.
  • Example) --hypervisorTypeCodeList XEN
serverSpecCode No String - Server specification code
  • Search by filtering with server specification code.
  • serverSpecCode can be obtained through the getServerSpecList action.
isBaseStorageAvailable No Boolean - Default storage availability
output No String Response result's format type
  • Options : xml | json
  • Default : json

Response

Response data type

  • BlockStorageVolumeTypeList type
BlockStorageVolumeTypeList extends CommonResponse
private Integer totalRows;
private List<BlockStorageVolumeType> blockStorageVolumeTypeList = new ArrayList<>();
BlockStorageVolumeType
private CommonCode blockStorageVolumeType;
private CommonCode hypervisorType;
private Long minBasicVolumeSize;
private Long maxBasicVolumeSize;
private Long minVolumeSize;
private Long maxVolumeSize;
private Long minIops;
private Long maxIops;
private Long minThroughput;
private Long maxThroughput;
private List<String> zoneCodeList;
private Boolean isBaseStorageAvailable;

Examples

Request example

ncloud vserver getBlockStorageVolumeTypeList --regionCode KR --zoneCode KR-1 --blockStorageVolumeTypeCodeList SSD --hypervisorTypeCodeList XEN --isBaseStorageAvailable true

Response example

<getBlockStorageVolumeTypeListResponse>
  <requestId></requestId>
  <returnCode>0</returnCode>
  <returnMessage>success</returnMessage>
  <totalRows>1</totalRows>
  <blockStorageVolumeTypeList>
      <blockStorageVolumeType>
          <blockStorageVolumeType>
            <code>SSD</code>
            <codeName>SSD</codeName>
          </blockStorageVolumeType>
          <hypervisorType>
            <code>XEN</code>
            <codeName>XEN</codeName>
          </hypervisorType>
          <minBasicVolumeSize>53687091200</minBasicVolumeSize>
          <maxBasicVolumeSize>107374182400</maxBasicVolumeSize>
          <minVolumeSize>10737418240</minVolumeSize>
          <maxVolumeSize>2147483648000</maxVolumeSize>
          <zoneCodeList>
              <zoneCode>KR-1</zoneCode>
              <zoneCode>KR-2</zoneCode>
          </zoneCodeList>
          <isBaseStorageAvailable>true</isBaseStorageAvailable>
      </blockStorageVolumeType>
  </blockStorageVolumeTypeList>
</getBlockStorageVolumeTypeListResponse>