Cloud Management API 1.5
VolumeSnapshots
A VolumeSnapshot represents a Cloud storage volume at a particular point in time. One can create a snapshot regardless of whether or not a volume is attached to an Instance. When a snapshot is created, various meta data is retained such as a Created At timestamp, a unique Resource UID (e.g. vol-52EF05A9), the Volume Owner and Visibility (e.g. private or public). Snapshots consist of a series of data blocks that are incrementally saved.
Actions
index
Lists all volume_snapshots.
- URLs
- GET /api/clouds/:cloud_id/volume_snapshots
- GET /api/clouds/:cloud_id/volumes/:volume_id/volume_snapshots
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.volume_snapshot;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 |
---|---|---|
deployment_href | no | Deployment href to filter on. |
description | no | The description of the Volume Snapshot to filter on. |
name | yes | The name of the Volume Snapshot to filter on. |
parent_volume_href | no | The href of the volume from which the Volume Snapshot was created. |
resource_uid | no | Resource Unique IDentifier for the Volume Snapshot to filter on. |
state | no | The current state of the snapshot |
visibility | no | Visibilty of volume snapshot (public, private, or account) |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"created_at": null,
"updated_at": "2018/10/16 16:04:41 +0000",
"name": "NAME_4119096354",
"resource_uid": "RESOURCE_3652870584",
"size": null,
"description": "DESCRIPTION_3721719627",
"state": "available",
"visibility": "private",
"links": [
{"rel":"self","href":"/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"parent_volume","href":"/api/clouds/888/volumes/RESOURCE_27208532;1394468489"},
{"rel":"recurring_volume_attachments","href":"/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337/recurring_volume_attachments"}
],
"actions": [
],
"cloud_specific_attributes": {
"aws_owner_id": "CLOUD_OWNER_178283852"
}
},{
"created_at": null,
"updated_at": "2018/10/16 16:04:43 +0000",
"name": "NAME_2374659771",
"resource_uid": "RESOURCE_225136547",
"size": null,
"description": "DESCRIPTION_607945990",
"state": "available",
"visibility": "private",
"links": [
{"rel":"self","href":"/api/clouds/888/volume_snapshots/RESOURCE_225136547;770073199"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"parent_volume","href":"/api/clouds/888/volumes/RESOURCE_1911242403;4247695277"},
{"rel":"recurring_volume_attachments","href":"/api/clouds/888/volume_snapshots/RESOURCE_225136547;770073199/recurring_volume_attachments"}
],
"actions": [
],
"cloud_specific_attributes": {
"aws_owner_id": "CLOUD_OWNER_178283852"
}
}]
<?xml version="1.0" encoding="UTF-8"?>
<volume_snapshots>
<volume_snapshot>
<created_at/>
<updated_at>2018/10/16 16:04:41 +0000</updated_at>
<name>NAME_4119096354</name>
<resource_uid>RESOURCE_3652870584</resource_uid>
<size/>
<description>DESCRIPTION_3721719627</description>
<state>available</state>
<visibility>private</visibility>
<links>
<link rel="self" href="/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="parent_volume" href="/api/clouds/888/volumes/RESOURCE_27208532;1394468489"/>
<link rel="recurring_volume_attachments" href="/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337/recurring_volume_attachments"/>
</links>
<actions/>
<cloud_specific_attributes>
<aws_owner_id>CLOUD_OWNER_178283852</aws_owner_id>
</cloud_specific_attributes>
</volume_snapshot>
<volume_snapshot>
<created_at/>
<updated_at>2018/10/16 16:04:43 +0000</updated_at>
<name>NAME_2374659771</name>
<resource_uid>RESOURCE_225136547</resource_uid>
<size/>
<description>DESCRIPTION_607945990</description>
<state>available</state>
<visibility>private</visibility>
<links>
<link rel="self" href="/api/clouds/888/volume_snapshots/RESOURCE_225136547;770073199"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="parent_volume" href="/api/clouds/888/volumes/RESOURCE_1911242403;4247695277"/>
<link rel="recurring_volume_attachments" href="/api/clouds/888/volume_snapshots/RESOURCE_225136547;770073199/recurring_volume_attachments"/>
</links>
<actions/>
<cloud_specific_attributes>
<aws_owner_id>CLOUD_OWNER_178283852</aws_owner_id>
</cloud_specific_attributes>
</volume_snapshot>
</volume_snapshots>
show
Displays information about a single volume_snapshot.
- URLs
- GET /api/clouds/:cloud_id/volume_snapshots/:id
- GET /api/clouds/:cloud_id/volumes/:volume_id/volume_snapshots/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.volume_snapshot
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{
"created_at": null,
"updated_at": "2018/10/16 16:04:41 +0000",
"name": "NAME_4119096354",
"resource_uid": "RESOURCE_3652870584",
"size": null,
"description": "DESCRIPTION_3721719627",
"state": "available",
"visibility": "private",
"links": [
{"rel":"self","href":"/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"parent_volume","href":"/api/clouds/888/volumes/RESOURCE_27208532;1394468489"},
{"rel":"recurring_volume_attachments","href":"/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337/recurring_volume_attachments"}
],
"actions": [
],
"cloud_specific_attributes": {
"aws_owner_id": "CLOUD_OWNER_178283852"
}
}
<?xml version="1.0" encoding="UTF-8"?>
<volume_snapshot>
<created_at/>
<updated_at>2018/10/16 16:04:41 +0000</updated_at>
<name>NAME_4119096354</name>
<resource_uid>RESOURCE_3652870584</resource_uid>
<size/>
<description>DESCRIPTION_3721719627</description>
<state>available</state>
<visibility>private</visibility>
<links>
<link rel="self" href="/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="parent_volume" href="/api/clouds/888/volumes/RESOURCE_27208532;1394468489"/>
<link rel="recurring_volume_attachments" href="/api/clouds/888/volume_snapshots/RESOURCE_3652870584;22692337/recurring_volume_attachments"/>
</links>
<actions/>
<cloud_specific_attributes>
<aws_owner_id>CLOUD_OWNER_178283852</aws_owner_id>
</cloud_specific_attributes>
</volume_snapshot>
create
Creates a new volume_snapshot.
- URLs
- POST /api/clouds/:cloud_id/volume_snapshots
- POST /api/clouds/:cloud_id/volumes/:volume_id/volume_snapshots
- HTTP response code
- 201 Created
- Location
- Href of created VolumeSnapshot.
Required roles
- actor||instance
Parameters
name | required | type | values | regexp | blank? | description |
---|---|---|---|---|---|---|
volume_snapshot | yes | Hash | * | * | no | |
volume_snapshot[deployment_href] | no | String | * | * | no | The href of the Deployment that owns this Volume Snapshot. |
volume_snapshot[description] | no | String | * | * | no | The description for the Volume Snapshot to be created. |
volume_snapshot[name] | yes | String | * | * | no | The name for the Volume Snapshot to be created. |
volume_snapshot[parent_volume_href] | no | String | * | * | no | The href of the Volume from which the Volume Snapshot will be created. |
destroy
Deletes a given volume_snapshot.
- URLs
- DELETE /api/clouds/:cloud_id/volume_snapshots/:id
- DELETE /api/clouds/:cloud_id/volumes/:volume_id/volume_snapshots/:id
- HTTP response code
- 204 No Content
Required roles
- actor||instance
copy
- URLs
- POST /api/clouds/:cloud_id/volume_snapshots/:id/copy
- POST /api/clouds/:cloud_id/volumes/:volume_id/volume_snapshots/:id/copy
- HTTP response code
- 201 Created
- Location
- Href of created VolumeSnapshot.
Required roles
- actor||instance
Parameters
name | required | type | values | regexp | blank? | description |
---|---|---|---|---|---|---|
volume_snapshot_copy | yes | Hash | * | * | no | |
volume_snapshot_copy[cloud_href] | yes | String | * | * | no | The href of the destination cloud. |
volume_snapshot_copy[description] | no | String | * | * | no | The description of the Volume Snapshot to be copied. |
volume_snapshot_copy[name] | no | String | * | * | no | The name of the Volume Snapshot to be copied. |