getBlockStorageVolumeTypeList

Available in VPC

Get the list of block storage volume types.

Syntax

The getBlockStorageVolumeTypeList syntax is as follows:

./ncloud vserver getBlockStorageVolumeTypeList \
    [--zoneCode <zone-code>] \
    [--blockStorageVolumeTypeCodeList <block-storage-volume-type-code-list>] \
    [--hypervisorTypeCodeList <hypervisor-type-code-list>] \
    [--serverSpecCode <server-spec-code>] \
    [--isBaseStorageAvailable <true|false>] \
    [--regionCode <KR|SGN|JPN>] \
    [--output <json|xml>]

Options

This section describes the options available when running getBlockStorageVolumeTypeList.

Optional options

These are the optional options for getBlockStorageVolumeTypeList. Options that are not specified will use their default values.

Options	Type	Required	Description
`--zoneCode`	String	Optional	Zone code See getZoneList.
`--blockStorageVolumeTypeCodeList`	List	Optional	Block storage volume type code list `HDD` \| `SSD` You can enter multiple items separated by spaces. (e.g., `--blockStorageVolumeTypeCodeList SSD HDD`)
`--hypervisorTypeCodeList`	List	Optional	Hypervisor type code list `XEN` \| `KVM` You can enter multiple items separated by spaces. (e.g., `--hypervisorTypeCodeList XEN KVM`) See getHypervisorTypeList.
`--serverSpecCode`	String	Optional	Server specification code See getServerSpecList.
`--isBaseStorageAvailable`	Boolean	Optional	Default storage availability `true` \| `false` `true`: Available `false`: Unavailable

Common options

For information about the options common to all vserver subcommands, see Server (VPC) options.

Examples

If the request to list block storage volume types is successful, the specifications and support information for each volume type are returned.

Command

The command example is as follows:

./ncloud vserver getBlockStorageVolumeTypeList \
    --zoneCode KR-1 \
    --blockStorageVolumeTypeCodeList SSD CB1 \
    --hypervisorTypeCodeList XEN KVM \
    --isBaseStorageAvailable true \
    --regionCode KR \
    --output json

Output

The output example is as follows:

{
  "getBlockStorageVolumeTypeListResponse": {
    "totalRows": 3,
    "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"
        ],
        "isBaseStorageAvailable": true
      },
      {
        "blockStorageVolumeType": {
          "code": "SSD",
          "codeName": "SSD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "minBaseVolumeSize": 50,
        "maxBaseVolumeSize": 100,
        "minVolumeSize": 10,
        "maxVolumeSize": 2000,
        "zoneCodeList": [
          "KR-1"
        ],
        "isBaseStorageAvailable": true
      },
      {
        "blockStorageVolumeType": {
          "code": "HDD",
          "codeName": "HDD"
        },
        "hypervisorType": {
          "code": "XEN",
          "codeName": "XEN"
        },
        "minBaseVolumeSize": 50,
        "maxBaseVolumeSize": 100,
        "minVolumeSize": 10,
        "maxVolumeSize": 2000,
        "zoneCodeList": [
          "KR-1"
        ],
        "isBaseStorageAvailable": true
      }
    ],
    "requestId": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "returnCode": "0",
    "returnMessage": "success"
  }
}

Documentation Index