2015/07/20 - Apache Deltacloud has been retired.

For more information, please explore the Attic.

Deltacloud API


Volume Image

This resource represents an image that could be placed on a pre-loaded volume.

A Volume Image Collection resource represents the collection of Volume Image resources within a Provider.

Retrieve the Volume Image Collection

Example request:

GET /cimi/volume_images HTTP/1.1
Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
User-Agent: curl/7.24.0 (i686-redhat-linux-gnu)
Host: localhost:3001
Accept: application/xml

Server response:

HTTP/1.1 200 OK
Content-Type: application/xml
CIMI-Specification-Version: 1.0.1
Content-Length: 1095
ETag: ae3be87f858bb7c9b1000e5409c497f9
Cache-Control: max-age=0, private, must-revalidate
Date: Mon, 07 Jan 2013 15:18:00 GMT
Connection: keep-alive
Server: thin 1.5.0 codename Knife

<Collection xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/VolumeImageCollection">
  <id>http://localhost:3001/cimi/volume_images</id>
  <count>3</count>
  <VolumeImage>
    <id>http://localhost:3001/cimi/volume_images/snap1</id>
    <name>snap1</name>
    <description>snap1</description>
    <created>2009-07-29T18:15:24Z</created>
    <imageLocation href="http://localhost:3001/cimi/volumes/vol1" />
    <bootable>false</bootable>
  </VolumeImage>
  <VolumeImage>
    <id>http://localhost:3001/cimi/volume_images/snap3</id>
    <name>snap3</name>
    <description>snap3</description>
    <created>2009-07-29T18:15:24Z</created>
    <imageLocation href="http://localhost:3001/cimi/volumes/vol2" />
    <bootable>false</bootable>
  </VolumeImage>
  <VolumeImage>
    <id>http://localhost:3001/cimi/volume_images/snap2</id>
    <name>snap2</name>
    <description>snap2</description>
    <created>2009-07-29T18:15:24Z</created>
    <imageLocation href="http://localhost:3001/cimi/volumes/vol2" />
    <bootable>false</bootable>
  </VolumeImage>
</Collection>

Retrieve a single Volume Image

Example request:

GET /cimi/volume_images/snap2 HTTP/1.1
Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) libcurl/7.24.0 NSS/3.13.5.0 zlib/1.2.5 libidn/1.24 libssh2/1.4.1
Host: localhost:3001
Accept: application/xml

Server response:

HTTP/1.1 200 OK
Content-Type: application/xml
CIMI-Specification-Version: 1.0.1
Content-Length: 377
ETag: 134b5cae11297fd59b2a783a0ee430ed
Cache-Control: max-age=0, private, must-revalidate
Date: Tue, 08 Jan 2013 13:40:54 GMT
Connection: keep-alive
Server: thin 1.5.0 codename Knife

<VolumeImage xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/VolumeImage">
  <id>http://localhost:3001/cimi/volume_images/snap1</id>
  <name>snap1</name>
  <description>snap1</description>
  <created>2009-07-29T18:15:24Z</created>
  <imageLocation href="http://localhost:3001/cimi/volumes/vol1" />
  <bootable>false</bootable>
</VolumeImage>

Create a Volume Image

A new Volume Image can be created from an existing Volume, by referencing the Volume resource with the imageLocation attribute in the message body. This is illustrated in the example below.

Example request:

POST /cimi/volume_images HTTP/1.1
Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) libcurl/7.24.0 NSS/3.13.5.0 zlib/1.2.5 libidn/1.24 libssh2/1.4.1
Host: localhost:3001
Content-Type: application/xml
Accept: application/xml
Content-Length: 210

<VolumeImage xmlns="http://schemas.dmtf.org/cimi/1">
  <name> my_vol_image </name>
  <description> marios first volume image </description>
  <imageLocation href="http://localhost:3001/cimi/volumes/vol1"/>
</VolumeImage>

Server response:

HTTP/1.1 201 Created
Content-Type: application/xml
Location: http://localhost:3001/cimi/volume_images/store_snapshot_1357663577
CIMI-Specification-Version: 1.0.1
Content-Length: 429
ETag: 5d4bdca8ed98295d1c463012bb8ff427
Cache-Control: max-age=0, private, must-revalidate
Date: Tue, 08 Jan 2013 16:46:17 GMT
Connection: keep-alive
Server: thin 1.5.0 codename Knife

<VolumeImage xmlns="http://schemas.dmtf.org/cimi/1" resourceURI="http://schemas.dmtf.org/cimi/1/VolumeImage">
  <id>http://localhost:3001/cimi/volume_images/store_snapshot_1357663577</id>
  <name>my_vol_image</name>
  <description>marios first volume image</description>
  <created>2013-01-08T18:46:17+02:00</created>
  <imageLocation href="http://localhost:3001/cimi/volumes/vol1" />
  <bootable>false</bootable>
</VolumeImage>

Delete a Volume Image

Example request:

DELETE /cimi/volume_images/snap1 HTTP/1.1
Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk
User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) libcurl/7.24.0 NSS/3.13.5.0 zlib/1.2.5 libidn/1.24 libssh2/1.4.1
Host: localhost:3001
Accept: application/xml

Server response:

HTTP/1.1 200 OK
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: text/html;charset=utf-8
CIMI-Specification-Version: 1.0.1
Content-Length: 0
Date: Wed, 09 Jan 2013 15:45:32 GMT
Connection: keep-alive
Server: thin 1.5.0 codename Knife