| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>CIMI Resource Collections - Machine Image</title> |
| <!-- Le HTML5 shim, for IE6-8 support of HTML elements --> |
| <!--[if lt IE 9]> |
| <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script> |
| <![endif]--> |
| |
| <!-- Le JavaScript --> |
| <script src="/assets/js/jquery-1.7.1.min.js" type="text/javascript"></script> |
| <script src="/assets/js/bootstrap-dropdown.js" type="text/javascript"></script> |
| <script src="/assets/js/jquery.tweet.js" type="text/javascript"></script> |
| <script src="/assets/js/application.js" type="text/javascript"></script> |
| <script src="/assets/js/bootstrap-transition.js"></script> |
| <script src="/assets/js/bootstrap-alert.js"></script> |
| <script src="/assets/js/bootstrap-modal.js"></script> |
| <script src="/assets/js/bootstrap-scrollspy.js"></script> |
| <script src="/assets/js/bootstrap-tab.js"></script> |
| <script src="/assets/js/bootstrap-tooltip.js"></script> |
| <script src="/assets/js/bootstrap-popover.js"></script> |
| <script src="/assets/js/bootstrap-button.js"></script> |
| <script src="/assets/js/bootstrap-collapse.js"></script> |
| <script src="/assets/js/bootstrap-carousel.js"></script> |
| <script src="/assets/js/bootstrap-typeahead.js"></script> |
| |
| <!-- Le styles --> |
| <link href="/assets/css/bootstrap.css" rel="stylesheet"> |
| <link href="/assets/css/application.css" rel="stylesheet"> |
| <link rel="shortcut icon" href="/assets/img/favicon.ico"> |
| </head> |
| |
| <body><div style="background: red"><h1>2015/07/20 - Apache Deltacloud has been retired. </h1><h2>For more information, please explore the <a href="http://attic.apache.org/">Attic</a>. </h2></div> |
| |
| <div class="navbar navbar-fixed-top"> |
| <div class="navbar-inner"> |
| <div class="container"> |
| <a class="brand" href="/"><img src="/assets/img/logo.png" width="152" |
| alt="Deltacloud API"/></a> |
| <ul class="nav top-nav"> |
| <li><a href="/">Home</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">About<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/about.html">What is Deltacloud?</a></li> |
| <li><a href="/drivers.html#drivers">Supported Providers</a></li> |
| </ul> |
| </li> |
| <li><a href="/download.html">Download</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Installation<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/install-deltacloud.html">Install Deltacloud</a></li> |
| <li><a href="/run-deltacloud-server.html">Run the Deltacloud Server</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="/usage.html" class="dropdown-toggle" data-toggle="dropdown">Usage<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/usage.html#usingapi">Using API</a></li> |
| <li><a href="/usage.html#clients">Client Libraries</a></li> |
| <li><a href="/command-tools.html">Command Line Tools</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/getting-sources.html">Getting Sources</a></li> |
| <li><a href="/how-to-contribute.html">How Can I Contribute?</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">API<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/rest-api.html">Deltacloud REST API</a></li> |
| <li><a href="/curl-examples.html">Deltacloud API cURL examples</a></li> |
| <li><a href="/drivers.html">Drivers API</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown">CIMI<b class="caret"></b></a> |
| <ul class="dropdown-menu"> |
| <li><a href="/cimi-rest.html">CIMI REST API</a></li> |
| <li><a href="/cimi-curl.html">CIMI cURL Examples</a></li> |
| </ul> |
| </li> |
| <li><a href="/contact.html">Contact</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| <div class="container content"> |
| |
| <p><br></p> |
| |
| <div class="row"> |
| <div class="span9"> |
| |
| <h3 id="cimi-machine-image">Machine Image</h3> |
| <p> |
| <strong><em> |
| This resource represents the information necessary for hardware virtualized resources to create a Machine Instance; it contains configuration data such as startup instructions, including possible combinations of the following items, depending on the 'type' of Machine Image created: the software image, installation software, both a disk image and a set of software and parameters. <br> <br> |
| A Machine Image Collection resource represents the collection of Machine Image resources within a Provider. |
| </em></strong> |
| </p> |
| |
| </div> |
| <div class="span3"> |
| |
| |
| <ul class="nav nav-list well"> |
| <li class="nav-header"> |
| CIMI REST API |
| </li> |
| <li><a href="../cimi-rest.html">Introduction</a></li> |
| <li><a href="cimi-rest-entry-point.html">Cloud Entry Point</a></li> |
| <li class="dropdown"> |
| <a href="#" class="dropdown-toggle" data-toggle="dropdown"> |
| CIMI Resources |
| <b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="cimi-rest-resource-metadata.html">ResourceMetadata</a></li> |
| <li><a href="cimi-rest-collections.html">Machine</a></li> |
| <li><a href="cimi-rest-volumes.html">Volume</a></li> |
| </ul> |
| </li> |
| <hr> |
| <li class="nav-header"> |
| Machine Resources |
| </li> |
| <ul class="nav nav-list"> |
| <li><a href="cimi-rest-collections.html">Machine</a></li> |
| <li class="active"><a href="cimi-rest-machine-images.html">MachineImage</a></li> |
| <li><a href="cimi-rest-machine-configs.html">MachineConfiguration</a></li> |
| <li><a href="cimi-rest-machine-templates.html">MachineTemplate</a></li> |
| </ul> |
| |
| </ul> |
| |
| </div> |
| |
| </div> |
| |
| <ul class="nav nav-pills"> |
| <li class="active"><a href="#image-collection" data-toggle="tab">Retrieve the Machine Image Collection</a></li> |
| <li><a href="#single-image" data-toggle="tab">Retrieve a single Machine Image</a></li> |
| <li><a href="#create-image" data-toggle="tab">Create or Delete a Machine Image</a></li> |
| </ul> |
| |
| <hr> |
| |
| <div class="tab-content"> |
| <div class="tab-pane active" id="image-collection"> |
| |
| <h4>Retrieve the Machine Image Collection</h4> |
| |
| <p> |
| Note the 'add' URI of the Machine Image Collection resource in the example response below. This is the URI that is used for creating a new Machine Image (adding to the Machine Image Collection). This URI is also returned when dereferencing a Machine resource, as the href attribute of the 'capture' operation (when this is possible for the given Machine on the particular Cloud Provider). |
| </p> |
| |
| <p>Example request:</p> |
| <pre> |
| GET /cimi/machine_images HTTP/1.1 |
| Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk |
| User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) |
| Host: localhost:3001 |
| Accept: application/xml |
| </pre> |
| |
| <p>Server response:</p> |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/xml |
| CIMI-Specification-Version: 1.0.1 |
| Content-Length: 1195 |
| ETag: e2f73ed48eb2abeae77322eea56dfc5d |
| Cache-Control: max-age=0, private, must-revalidate |
| Date: Fri, 28 Dec 2012 14:23:35 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/MachineImageCollection"> |
| <id>http://localhost:3001/cimi/machine_images</id> |
| <count>3</count> |
| <MachineImage> |
| <id>http://localhost:3001/cimi/machine_images/img1</id> |
| <name>img1</name> |
| <description>Fedora 10</description> |
| <created>2012-12-28T16:23:35+02:00</created> |
| <state>AVAILABLE</state> |
| <type>IMAGE</type> |
| <imageLocation>mock://img1</imageLocation> |
| </MachineImage> |
| <MachineImage> |
| <id>http://localhost:3001/cimi/machine_images/img2</id> |
| <name>img2</name> |
| <description>Fedora 10</description> |
| <created>2012-12-28T16:23:35+02:00</created> |
| <state>AVAILABLE</state> |
| <type>IMAGE</type> |
| <imageLocation>mock://img2</imageLocation> |
| </MachineImage> |
| <MachineImage> |
| <id>http://localhost:3001/cimi/machine_images/img3</id> |
| <name>img3</name> |
| <description>JBoss</description> |
| <created>2012-12-28T16:23:35+02:00</created> |
| <state>AVAILABLE</state> |
| <type>IMAGE</type> |
| <imageLocation>mock://img3</imageLocation> |
| </MachineImage> |
| <operation rel="add" href="http://localhost:3001/cimi/machine_images" /> |
| </Collection> |
| </pre> |
| |
| </div> |
| <div class="tab-pane" id="single-image"> |
| |
| <h4>Retrieve a single Machine Image</h4> |
| |
| <p>Example request:</p> |
| |
| <pre> |
| GET /cimi/machine_images/img1 HTTP/1.1 |
| Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk |
| User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) |
| Host: localhost:3001 |
| Accept: application/xml |
| </pre> |
| |
| <p>Server response:</p> |
| |
| <pre> |
| HTTP/1.1 200 OK |
| Content-Type: application/xml |
| CIMI-Specification-Version: 1.0.1 |
| Content-Length: 385 |
| ETag: 130f8e9592138afc544d65d73039e540 |
| Cache-Control: max-age=0, private, must-revalidate |
| Date: Fri, 28 Dec 2012 14:55:42 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| |
| <MachineImage xmlns="http://schemas.dmtf.org/cimi/1" |
| resourceURI="http://schemas.dmtf.org/cimi/1/MachineImage"> |
| <id>http://localhost:3001/cimi/machine_images/img1</id> |
| <name>img1</name> |
| <description>Fedora 10</description> |
| <created>2012-12-28T16:55:42+02:00</created> |
| <state>AVAILABLE</state> |
| <type>IMAGE</type> |
| <imageLocation>mock://img1</imageLocation> |
| </MachineImage> |
| </pre> |
| |
| </div> |
| |
| <div class="tab-pane" id="create-image"> |
| |
| |
| <h4>Create a new Machine Image</h4> |
| |
| <p> |
| The example below shows the creation of a new Machine Image resource from an existing Machine resource. When supported by the Machine and the given Cloud Provider, the href attribute of the serialized Machine resource's 'capture' operation provides the URI to which the request body should be sent with HTTP POST in order to create the new Machine Image. The message body is the representation of the to be created Machine Image resource, with the 'imageLocation' attribute referring to the Machine resource from which the Machine Image is to be created, as shown in the example below: |
| </p> |
| |
| <p>Example request:</p> |
| |
| <pre> |
| POST /cimi/machine_images HTTP/1.1 |
| Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk |
| User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) |
| Host: localhost:3001 |
| Content-Type: application/xml |
| Accept: application/xml |
| Content-Length: 188 |
| <MachineImage> |
| <name>some_name</name> |
| <description>my new machine_image</description> |
| <type>IMAGE</type> |
| <imageLocation>http://localhost:3001/cimi/machines/inst1</imageLocation> |
| </MachineImage> |
| </pre> |
| |
| <p>Server response:</p> |
| |
| <pre> |
| HTTP/1.1 201 Created |
| Content-Type: application/xml |
| Location: http://localhost:3001/cimi/machine_images/some_name |
| CIMI-Specification-Version: 1.0.1 |
| Content-Length: 411 |
| ETag: c929191a65da6564f9f69301d38eb6fc |
| Cache-Control: max-age=0, private, must-revalidate |
| Date: Fri, 28 Dec 2012 15:10:12 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| |
| <MachineImage xmlns="http://schemas.dmtf.org/cimi/1" |
| resourceURI="http://schemas.dmtf.org/cimi/1/MachineImage"> |
| <id>http://localhost:3001/cimi/machine_images/some_name</id> |
| <name>some_name</name> |
| <description>my new machine image</description> |
| <created>2012-12-28T17:10:12+02:00</created> |
| <state>AVAILABLE</state> |
| <type>IMAGE</type> |
| <imageLocation>mock://some_name</imageLocation> |
| </MachineImage> |
| </pre> |
| |
| <br> |
| <hr> |
| |
| <h4>Delete a Machine Image</h4> |
| |
| <p>Example request:</p> |
| |
| <pre> |
| DELETE /cimi/machine_images/some_name HTTP/1.1 |
| Authorization: Basic bW9ja3VzZXI6bW9ja3Bhc3N3b3Jk |
| User-Agent: curl/7.24.0 (i686-redhat-linux-gnu) |
| Host: localhost:3001 |
| Accept: application/xml |
| </pre> |
| |
| <p>Server response:</p> |
| |
| <pre> |
| 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: Fri, 28 Dec 2012 15:21:14 GMT |
| Connection: keep-alive |
| Server: thin 1.5.0 codename Knife |
| </pre> |
| |
| </div> |
| </div> |
| |
| |
| <footer class="footer"> |
| <p class="pull-right"><span class='icon-circle-arrow-up'> </span><a href="#">Back to top</a></p> |
| <div class='row'> |
| <div class='span3'> |
| <img src="/assets/img/asf.png" alt="Apache Software Foundation"/> |
| </div> |
| <div class='span9'> |
| <strong>Apache Deltacloud</strong> is a top-level project at the <a |
| href="http://www.apache.org">Apache Software Foundation</a>, |
| having graduated from the ASF Incubator in October |
| 2011. Through a collaborative and meritocratic development process, Apache |
| projects deliver enterprise-grade, freely available software products that |
| attract large communities of users. |
| </div> |
| </div> |
| </footer> |
| |
| </div> <!-- /container --> |
| |
| <!-- Piwik --> |
| <script type="text/javascript"> |
| var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.salasaga.org/aeolus/piwik/" : "http://stats.salasaga.org/aeolus/piwik/"); |
| document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E")); |
| </script><script type="text/javascript"> |
| try { |
| var piwikTracker = Piwik.getTracker(pkBaseURL + "piwik.php", 2); |
| piwikTracker.trackPageView(); |
| piwikTracker.enableLinkTracking(); |
| } catch( err ) {} |
| </script><noscript><p><img src="http://stats.salasaga.org/aeolus/piwik/piwik.php?idsite=2" style="border:0" alt="" /></p></noscript> |
| <!-- End Piwik Tracking Code --> |
| |
| </body> |
| </html> |
