Cloud Management API 1.5
RecurringVolumeAttachments
A RecurringVolumeAttachment specifies a Volume/VolumeSnapshot to attach to a Server/ServerArray the next time an instance is launched.
Actions
index
Lists all recurring volume attachments.
- URLs
- GET /api/clouds/:cloud_id/recurring_volume_attachments
- GET /api/clouds/:cloud_id/volume_snapshots/:volume_snapshot_id/recurring_volume_attachments
- GET /api/clouds/:cloud_id/volumes/:volume_id/recurring_volume_attachments
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.recurring_volume_attachment;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 |
|---|---|---|
| runnable_href | no | The href of the server or server array to filter on. |
| storage_href | no | The href of the volume or volume snapshot to filter on. |
Example Responses
Click on a format below to see an example response:
JSON XML[{
"created_at": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"name": "Recurring Volume Attachment between nickname-1746348843 and NAME_1978450230",
"runnable_type": "Server",
"storage_type": "Volume",
"status": "attached",
"device": "/dev/xvdj",
"device_id": "device_id:9",
"size": "1 GB",
"links": [
{"rel":"self","href":"/api/clouds/888/recurring_volume_attachments/1"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"runnable","href":"/api/servers/1"},
{"rel":"storage","href":"/api/clouds/888/volumes/RESOURCE_1166705757;2332079705"}
],
"actions": [
]
},{
"created_at": "2023/10/09 11:06:02 +0000",
"updated_at": "2023/10/09 11:06:02 +0000",
"name": "Recurring Volume Attachment between nickname-203931973 and NAME_1267233762",
"runnable_type": "Server",
"storage_type": "Volume",
"status": "attached",
"device": "/dev/xvdj",
"device_id": "device_id:9",
"size": "1 GB",
"links": [
{"rel":"self","href":"/api/clouds/888/recurring_volume_attachments/2"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"runnable","href":"/api/servers/3"},
{"rel":"storage","href":"/api/clouds/888/volumes/RESOURCE_128588983;3087885902"}
],
"actions": [
]
}]<?xml version="1.0" encoding="UTF-8"?>
<recurring_volume_attachments>
<recurring_volume_attachment>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<name>Recurring Volume Attachment between nickname-1746348843 and NAME_1978450230</name>
<runnable_type>Server</runnable_type>
<storage_type>Volume</storage_type>
<status>attached</status>
<device>/dev/xvdj</device>
<device_id>device_id:9</device_id>
<size>1 GB</size>
<links>
<link rel="self" href="/api/clouds/888/recurring_volume_attachments/1"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="runnable" href="/api/servers/1"/>
<link rel="storage" href="/api/clouds/888/volumes/RESOURCE_1166705757;2332079705"/>
</links>
<actions/>
</recurring_volume_attachment>
<recurring_volume_attachment>
<created_at>2023/10/09 11:06:02 +0000</created_at>
<updated_at>2023/10/09 11:06:02 +0000</updated_at>
<name>Recurring Volume Attachment between nickname-203931973 and NAME_1267233762</name>
<runnable_type>Server</runnable_type>
<storage_type>Volume</storage_type>
<status>attached</status>
<device>/dev/xvdj</device>
<device_id>device_id:9</device_id>
<size>1 GB</size>
<links>
<link rel="self" href="/api/clouds/888/recurring_volume_attachments/2"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="runnable" href="/api/servers/3"/>
<link rel="storage" href="/api/clouds/888/volumes/RESOURCE_128588983;3087885902"/>
</links>
<actions/>
</recurring_volume_attachment>
</recurring_volume_attachments>
show
Displays information about a single recurring volume attachment.
- URLs
- GET /api/clouds/:cloud_id/recurring_volume_attachments/:id
- GET /api/clouds/:cloud_id/volume_snapshots/:volume_snapshot_id/recurring_volume_attachments/:id
- GET /api/clouds/:cloud_id/volumes/:volume_id/recurring_volume_attachments/:id
- HTTP response code
- 200 OK
- Content-type
- application/vnd.rightscale.recurring_volume_attachment
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": "2023/10/09 11:06:01 +0000",
"updated_at": "2023/10/09 11:06:01 +0000",
"name": "Recurring Volume Attachment between nickname-1746348843 and NAME_1978450230",
"runnable_type": "Server",
"storage_type": "Volume",
"status": "attached",
"device": "/dev/xvdj",
"device_id": "device_id:9",
"size": "1 GB",
"links": [
{"rel":"self","href":"/api/clouds/888/recurring_volume_attachments/1"},
{"rel":"cloud","href":"/api/clouds/888"},
{"rel":"runnable","href":"/api/servers/1"},
{"rel":"storage","href":"/api/clouds/888/volumes/RESOURCE_1166705757;2332079705"}
],
"actions": [
]
}<?xml version="1.0" encoding="UTF-8"?>
<recurring_volume_attachment>
<created_at>2023/10/09 11:06:01 +0000</created_at>
<updated_at>2023/10/09 11:06:01 +0000</updated_at>
<name>Recurring Volume Attachment between nickname-1746348843 and NAME_1978450230</name>
<runnable_type>Server</runnable_type>
<storage_type>Volume</storage_type>
<status>attached</status>
<device>/dev/xvdj</device>
<device_id>device_id:9</device_id>
<size>1 GB</size>
<links>
<link rel="self" href="/api/clouds/888/recurring_volume_attachments/1"/>
<link rel="cloud" href="/api/clouds/888"/>
<link rel="runnable" href="/api/servers/1"/>
<link rel="storage" href="/api/clouds/888/volumes/RESOURCE_1166705757;2332079705"/>
</links>
<actions/>
</recurring_volume_attachment>
create
Creates a new recurring volume attachment.
- URLs
- POST /api/clouds/:cloud_id/recurring_volume_attachments
- POST /api/clouds/:cloud_id/volume_snapshots/:volume_snapshot_id/recurring_volume_attachments
- POST /api/clouds/:cloud_id/volumes/:volume_id/recurring_volume_attachments
- HTTP response code
- 201 Created
- Location
- Href of created RecurringVolumeAttachment.
Required roles
- actor||instance
Parameters
| name | required | type | values | regexp | blank? | description |
|---|---|---|---|---|---|---|
| recurring_volume_attachment | yes | Hash | * | * | no | |
| recurring_volume_attachment[device] | yes | String | * | * | no | The device location where the volume or volume snapshot will be mounted. Value must be of format /dev/xvd[bcefghij]. This is not reliable and will be deprecated. |
| recurring_volume_attachment[runnable_href] | yes | String | * | * | no | The href of the server or server array to attach to. |
| recurring_volume_attachment[settings] | no | Hash | * | * | no | Additional parameters concerning created attachment. For example, ':delete_on_termination => true' will schedule volume deletion if instance was terminated. |
| recurring_volume_attachment[settings][*] | no | String | * | * | no | Key/Value separated options |
| recurring_volume_attachment[storage_href] | yes | String | * | * | no | The href of the volume or volume snapshot to be attached on launch of a next instance. |
| recurring_volume_attachment[volume_type_href] | no | String | * | * | no | The href of the volume type. Can be required by some clouds in case if you attaching volume snapshot. |
destroy
Deletes a given recurring volume attachment.
- URLs
- DELETE /api/clouds/:cloud_id/recurring_volume_attachments/:id
- DELETE /api/clouds/:cloud_id/volume_snapshots/:volume_snapshot_id/recurring_volume_attachments/:id
- DELETE /api/clouds/:cloud_id/volumes/:volume_id/recurring_volume_attachments/:id
- HTTP response code
- 204 No Content
Required roles
- actor||instance