List volume types¶
Overview¶
Lists volume types.
Classification¶
List
API Operation Object¶
types
Synchronous / Asynchronous¶
-
Request¶
HTTP Request Method¶
GET
HTTP Request Path¶
{api_endpoint}/v2/{tenant_id}/types
Response¶
HTTP Response Header¶
Format¶
HTTP/1.1 <response code> <message> (ex. 200 OK)
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
skip auto insert field such as "X-Compute-Request-Id" and "X-Openstack-Request-Id", "Content-Length", "Date"
Response Code¶
response code |
condition |
---|---|
200 |
normal end |
* |
Follow a Common Error Code |
HTTP Response Body¶
Format¶
{
"volume_types": [
{
"extra_specs": {
"capabilities": "gpu"
},
"id": "<id>",
"name": "<name>"
},
<<repeat>>
]
}
Response Parameter¶
item |
format |
description |
---|---|---|
volume_type |
dict |
A set of key and value pairs that contains the properties for a volume type. |
id |
UUID |
The UUID for the volume type. |
name |
String |
The name of the volume type. |
extra_specs |
dict |
A set of key and value pairs that contains the specifications for a volume type. |
volume_backend_name |
list |
The list of available volumes. |
Sample API Request and Response¶
Sample API Request¶
Request URI¶
https://example.com/v2/{tenant_id}/types
Request Header¶
Accept-Encoding: gzip, deflate, compress (optional)
Accept: application/json
X-Auth-Token: ajk3adjiown02
Request Body¶
none
Sample API Response¶
Response Header¶
HTTP/1.1 200 OK
<response_code>: see "HTTP Responses" section
<message>: message based on the response code
skip auto insert field such as "X-Compute-Request-Id" and "X-Openstack-Request-Id", "Content-Length", "Date"
Response Body¶
{
"volume_types": [
{
"extra_specs": {
"capabilities": "gpu"
},
"id": "6685584b-1eac-4da6-b5c3-555430cf68ff",
"name": "SSD"
},
{
"extra_specs": {},
"id": "8eb69a46-df97-4e41-9586-9a40a7533803",
"name": "SATA"
}
]
}
Execution Example¶
HTTP Request¶
GET /v2/cb8aa2a2c7244af5aab1fa7881ba7f4c/types HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:8776
X-Auth-Token: 517486dbd39a44088fdc5b3dfcfdb831
Content-type: application/json
Accept: application/json
HTTP Response¶
HTTP/1.1 200 OK
X-Compute-Request-Id: req-3a5f0663-eead-4db4-a125-efdaa56938d5
Content-Type: application/json
Content-Length: 144
X-Openstack-Request-Id: req-3a5f0663-eead-4db4-a125-efdaa56938d5
Date: Thu, 15 Oct 2015 12:37:17 GMT
{"volume_types": [{"extra_specs": {"volume_backend_name": "lvmdriver-1"}, "name": "lvmdriver-1", "id": "b01065ad-acab-415a-8157-8766a51984d6"}]}
Error Execution Example¶
HTTP Request¶
GET /v2/cb8aa2a2c7244af5aab1fa7881ba7f4/types HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.56.250:8776
X-Auth-Token: 517486dbd39a44088fdc5b3dfcfdb831
Content-type: application/json
Accept: application/json
HTTP Response¶
HTTP/1.1 400 Bad Request
Content-Length: 65
Content-Type: application/json; charset=UTF-8
X-Compute-Request-Id: req-6967efc5-1a8c-4157-a950-c42c7d824edb
X-Openstack-Request-Id: req-6967efc5-1a8c-4157-a950-c42c7d824edb
Date: Thu, 15 Oct 2015 12:37:23 GMT
{"badRequest": {"message": "Malformed request url", "code": 400}}