Cloud Management API 1.5
VolumeTypes
A VolumeType describes the type of volume, particularly the size.
Actions
index
Lists Volume Types.
- URLs
- GET /api/clouds/:cloud_id/volume_types
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.volume_type;type=collection
Required roles
- observer||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| filter | no | Array | * | * | no | See below for valid filter parameters. |
| view | no | String | default | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Filters
| name | partial_match? | description |
|---|---|---|
| name | yes | The name of the Volume Type to filter on. |
| resource_uid | no | Resource Unique IDentifier for the Volume Type to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"name": "small",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_399298104",
"size": "5",
"description": "Small Disk, 5 GB",
"links": [
{"rel":"self","href":"/api/clouds/888/volume_types/RESOURCE_399298104;1362809635"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"actions": [
]
},{
"name": "small",
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"resource_uid": "RESOURCE_1715092902",
"size": "5",
"description": "Small Disk, 5 GB",
"links": [
{"rel":"self","href":"/api/clouds/888/volume_types/RESOURCE_1715092902;269541717"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"actions": [
]
}]<?xml version="1.0" encoding="UTF-8"?>
<volume_types>
<volume_type>
<name>small</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_399298104</resource_uid>
<size>5</size>
<description>Small Disk, 5 GB</description>
<links>
<link rel="self" href="/api/clouds/888/volume_types/RESOURCE_399298104;1362809635"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<actions/>
</volume_type>
<volume_type>
<name>small</name>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<resource_uid>RESOURCE_1715092902</resource_uid>
<size>5</size>
<description>Small Disk, 5 GB</description>
<links>
<link rel="self" href="/api/clouds/888/volume_types/RESOURCE_1715092902;269541717"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<actions/>
</volume_type>
</volume_types>
show
Displays information about a single Volume Type.
- URLs
- GET /api/clouds/:cloud_id/volume_types/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.volume_type
Required roles
- observer||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| view | no | String | default | * | no | Specifies how many attributes and/or expanded nested relationships to include. |
Example Responses
Click on a format below to see an example response:
JSON XML{
"name": "small",
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"resource_uid": "RESOURCE_399298104",
"size": "5",
"description": "Small Disk, 5 GB",
"links": [
{"rel":"self","href":"/api/clouds/888/volume_types/RESOURCE_399298104;1362809635"},
{"rel":"cloud","href":"/api/clouds/888"}
],
"actions": [
]
}<?xml version="1.0" encoding="UTF-8"?>
<volume_type>
<name>small</name>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<resource_uid>RESOURCE_399298104</resource_uid>
<size>5</size>
<description>Small Disk, 5 GB</description>
<links>
<link rel="self" href="/api/clouds/888/volume_types/RESOURCE_399298104;1362809635"/>
<link rel="cloud" href="/api/clouds/888"/>
</links>
<actions/>
</volume_type>