List Volume Types (Detailed)

Overview

Lists available volume types with details

Classification

  • List

API Operation Object

  • VolumeType

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1.0/{tenant_id}/volume_types/detail

HTTP Request Header

Format

X-Auth-Token: <token>

HTTP Request Body

Format

  • none

Request Parameter

  • none

Response

HTTP Response Header

Response Code

Response Codes
Code Description Error? Note
200 OK No Returned in case of success
400 Bad Request Yes  
401 Unauthorized Yes  
500 Internal Server Error Yes  

HTTP Response Body

Response Parameter

Response Parameters
Key Value
api_error_message Error Message
volume_types List of VolumeType objects
extra_specs Includes available_volume_size, and available_iops_per_gb or available_volume_throughput
available_volume_size List of available volume sizes for the volume_type
available_iops_per_gb List of available IOPS/GB values for the volume_type
available_volume_throughput List of available throughput (MByte/s) values for the volume_type
id ID for the volume_type
name Name of the volume_type

Sample API Request and Response

Sample API Request

curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0/7dea34ac34a14d04b0accbfe793c74af/volume_types/detail -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: 5990f1de419e46649728bd3f505e9a17'

Sample API Response

HTTP/1.1 200 OK
Date: Thu, 21 Apr 2016 05:43:59 GMT
Content-Type: application/json
Content-Length: 551
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce1dacbc3220de23c617070fa6e432e5ab3c8d7aa8cae41c9ec52e43e50f50515b6; Path=/

{
    "api_error_message": "",
    "volume_types": [
        {
            "id": "6328d234-7939-4d61-9216-736de66d15f9",
            "name": "piops_iscsi_na",
            "extra_specs": {
                "available_volume_size": [
                    100,
                    250,
                    500,
                    1000,
                    2000,
                    4000,
                    8000,
                    12000
                ],
                "available_iops_per_gb": [
                    "2",
                    "4"
                ]
            }
        },
        {
            "id": "bf33db2a-d13e-11e5-8949-005056ab5d30",
            "name": "pre_nfs_na",
            "extra_specs": {
                "available_volume_size": [
                    256,
                    512
                ],
                "available_volume_throughput": [
                    "50",
                    "100",
                    "250",
                    "400"
                ]
            }
        },
        {
            "id": "704db6e5-8a93-41a5-850d-405913600341",
            "name": "standard_nfs_na",
            "extra_specs": {
                "available_volume_size": [
                    1024,
                    2048,
                    3072,
                    4096,
                    5120,
                    10240,
                    15360,
                    20480,
                    25600,
                    30720,
                    35840,
                    40960,
                    46080,
                    51200,
                    56320,
                    61440,
                    66560,
                    71680,
                    76800,
                    81920,
                    87040,
                    92160,
                    97280,
                    102400
                ]
            }
        },
        {
            "id": "a882ade4-9f8e-4aad-8b92-007d17e8887f",
            "name": "standard_smb_na",
            "extra_specs": {
                "available_volume_size": [
                    1024,
                    2048,
                    3072,
                    4096,
                    5120,
                    10240,
                    15360,
                    20480,
                    25600,
                    30720,
                    35840,
                    40960,
                    46080,
                    51200,
                    56320,
                    61440,
                    66560,
                    71680,
                    76800,
                    81920,
                    87040,
                    92160,
                    97280,
                    102400
                ]
            }
        }
    ]
}