����JFIF��x�x����'
Server IP : 78.140.185.180 / Your IP : 216.73.216.45 Web Server : LiteSpeed System : Linux cpanel13.v.fozzy.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : builderbox ( 1072) PHP Version : 7.3.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/builderbox/www/vendor/rackspace/php-opencloud/doc/_build/html/services/image/ |
Upload File : |
<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Images v1 — php-opencloud 1.12.1 documentation</title> <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'> <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> <link rel="top" title="php-opencloud 1.12.1 documentation" href="../../index.html"/> <link rel="next" title="Images" href="images.html"/> <link rel="prev" title="Tenants" href="../identity/tenants.html"/> <script src="https://cdnjs.cloudflare.com/ajax/libs/modernizr/2.6.2/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-nav-search"> <a href="../../index.html" class="fa fa-home"> php-opencloud</a> <div role="search"> <form id ="rtd-search-form" class="wy-form" action="../../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../autoscale/index.html">Auto Scale v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../autoscale/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../compute/index.html">Compute v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../compute/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../database/index.html">Databases v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../database/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../dns/index.html">DNS v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../dns/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../identity/index.html">Identity v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../identity/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../identity/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../identity/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../identity/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1 current"><a class="current reference internal" href="">Images v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../load-balancer/index.html">Load Balancer v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../load-balancer/index.html#further-links">Further Links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../monitoring/index.html">Monitoring v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../monitoring/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../networking/index.html">Networking v2</a><ul> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../networking/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../object-store/index.html">Object Store v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../object-store/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../orchestration/index.html">Orchestration v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../orchestration/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../queues/index.html">Queues v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../queues/index.html#further-links">Further links</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../volume/index.html">Volumes v1</a><ul> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#operations">Operations</a></li> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#glossary">Glossary</a></li> <li class="toctree-l2"><a class="reference internal" href="../volume/index.html#further-links">Further links</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../../debugging.html">Debugging</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-1-meaningful-exception-handling">Strategy 1: Meaningful exception handling</a></li> <li class="toctree-l2"><a class="reference internal" href="../../debugging.html#strategy-2-wire-logging">Strategy 2: Wire logging</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../caching-creds.html">Caching credentials</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../caching-creds.html#filesystem-example">Filesystem example</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../iterators.html">Iterators</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#common-behaviour">Common behaviour</a></li> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#very-important-note">Very important note</a></li> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#using-paginated-collections">Using paginated collections</a></li> <li class="toctree-l2"><a class="reference internal" href="../../iterators.html#setting-up-a-paginatediterator">Setting up a PaginatedIterator</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../regions.html">Rackspace regions</a></li> <li class="toctree-l1"><a class="reference internal" href="../../url-types.html">URL types</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../url-types.html#internalurl">internalURL</a></li> <li class="toctree-l2"><a class="reference internal" href="../../url-types.html#publicurl">publicURL</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../logging.html">Logging</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../logging.html#logger-injection">Logger injection</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../http-clients.html">HTTP Clients</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#default-http-headers">Default HTTP headers</a></li> <li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#user-agents">User agents</a></li> <li class="toctree-l2"><a class="reference internal" href="../../http-clients.html#other-functionality">Other functionality</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../../auth.html">Authentication</a><ul> <li class="toctree-l2"><a class="reference internal" href="../../auth.html#service-catalog">Service Catalog</a></li> </ul> </li> </ul> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="../../index.html">php-opencloud</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="../../index.html">Docs</a> »</li> <li>Images v1</li> <li class="wy-breadcrumbs-aside"> <a href="../../_sources/services/image/index.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main"> <div class="section" id="images-v1"> <h1>Images v1<a class="headerlink" href="#images-v1" title="Permalink to this headline">¶</a></h1> <div class="section" id="setup"> <h2>Setup<a class="headerlink" href="#setup" title="Permalink to this headline">¶</a></h2> <div class="section" id="rackspace-setup"> <h3>Rackspace setup<a class="headerlink" href="#rackspace-setup" title="Permalink to this headline">¶</a></h3> <p>The first step is to pass in your credentials and set up a client. For Rackspace users, you will need your username and API key:</p> <div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">OpenCloud\Rackspace</span><span class="p">;</span> <span class="nv">$client</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">Rackspace</span><span class="p">(</span><span class="nx">Rackspace</span><span class="o">::</span><span class="na">US_IDENTITY_ENDPOINT</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span> <span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'{username}'</span><span class="p">,</span> <span class="s1">'apiKey'</span> <span class="o">=></span> <span class="s1">'{apiKey}'</span><span class="p">,</span> <span class="p">));</span> </pre></div> </div> </div> <div class="section" id="openstack-setup"> <h3>OpenStack setup<a class="headerlink" href="#openstack-setup" title="Permalink to this headline">¶</a></h3> <p>If you’re an OpenStack user, you will also need to prove a few other configuration parameters:</p> <div class="highlight-php"><div class="highlight"><pre><span class="nv">$client</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">OpenCloud\OpenStack</span><span class="p">(</span><span class="s1">'{keystoneUrl}'</span><span class="p">,</span> <span class="k">array</span><span class="p">(</span> <span class="s1">'username'</span> <span class="o">=></span> <span class="s1">'{username}'</span><span class="p">,</span> <span class="s1">'password'</span> <span class="o">=></span> <span class="s1">'{apiKey}'</span><span class="p">,</span> <span class="s1">'tenantId'</span> <span class="o">=></span> <span class="s1">'{tenantId}'</span><span class="p">,</span> <span class="p">));</span> </pre></div> </div> </div> <div class="section" id="images-service"> <h3>Images service<a class="headerlink" href="#images-service" title="Permalink to this headline">¶</a></h3> <p>Now to instantiate the Images service:</p> <div class="highlight-php"><div class="highlight"><pre><span class="nv">$service</span> <span class="o">=</span> <span class="nv">$client</span><span class="o">-></span><span class="na">imageService</span><span class="p">(</span><span class="k">null</span><span class="p">,</span> <span class="s1">'{region}'</span><span class="p">);</span> </pre></div> </div> </div> </div> <div class="section" id="operations"> <h2>Operations<a class="headerlink" href="#operations" title="Permalink to this headline">¶</a></h2> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="images.html">Images</a><ul> <li class="toctree-l2"><a class="reference internal" href="images.html#list-images">List images</a></li> <li class="toctree-l2"><a class="reference internal" href="images.html#get-image-details">Get image details</a><ul> <li class="toctree-l3"><a class="reference internal" href="images.html#a-note-on-schema-classes">A note on schema classes</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="images.html#update-image">Update image</a></li> <li class="toctree-l2"><a class="reference internal" href="images.html#delete-image">Delete image</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="schemas.html">JSON schemas</a><ul> <li class="toctree-l2"><a class="reference internal" href="schemas.html#schema-types">Schema types</a></li> <li class="toctree-l2"><a class="reference internal" href="schemas.html#example-response-from-the-api">Example response from the API</a></li> <li class="toctree-l2"><a class="reference internal" href="schemas.html#json-patch">JSON Patch</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="sharing.html">Sharing images</a><ul> <li class="toctree-l2"><a class="reference internal" href="sharing.html#typical-workflow">Typical workflow</a><ul> <li class="toctree-l3"><a class="reference internal" href="sharing.html#additional-notes">Additional notes</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="sharing.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="sharing.html#list-image-members">List image members</a></li> <li class="toctree-l2"><a class="reference internal" href="sharing.html#create-image-member">Create image member</a></li> <li class="toctree-l2"><a class="reference internal" href="sharing.html#delete-image-member">Delete image member</a></li> <li class="toctree-l2"><a class="reference internal" href="sharing.html#update-image-member-status">Update image member status</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="tags.html">Image tags</a><ul> <li class="toctree-l2"><a class="reference internal" href="tags.html#setup">Setup</a></li> <li class="toctree-l2"><a class="reference internal" href="tags.html#add-image-tag">Add image tag</a></li> <li class="toctree-l2"><a class="reference internal" href="tags.html#delete-image-tag">Delete image tag</a></li> </ul> </li> </ul> </div> </div> <div class="section" id="glossary"> <h2>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h2> <blockquote> <div><dl class="docutils"> <dt>image</dt> <dd>A virtual machine image is a single file which contains a virtual disk that has an installed bootable operating system. In the Cloud Images API, an image is represented by a JSON-encoded data structure (the image schema) and its raw binary data (the image file).</dd> <dt>schema</dt> <dd>The Cloud Images API supplies JSON documents describing the JSON-encoded data structures that represent domain objects, so that a client knows exactly what to expect in an API response.</dd> <dt>tag</dt> <dd>An image tag is a string of characters used to identify a specific image or images.</dd> </dl> </div></blockquote> </div> <div class="section" id="further-links"> <h2>Further Links<a class="headerlink" href="#further-links" title="Permalink to this headline">¶</a></h2> <blockquote> <div><ul class="simple"> <li><a class="reference external" href="http://docs.rackspace.com/images/api/v2/ci-gettingstarted/content/ch_image_preface.html">Getting Started Guide for the API</a></li> <li><a class="reference external" href="http://docs.rackspace.com/images/api/v2/ci-devguide/content/ch_image_preface.html">API Developer Guide</a></li> </ul> </div></blockquote> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="images.html" class="btn btn-neutral float-right" title="Images"/>Next <span class="fa fa-arrow-circle-right"></span></a> <a href="../identity/tenants.html" class="btn btn-neutral" title="Tenants"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2015, Jamie Hannaford, Shaunak Kashyap. </p> </div> <a href="https://github.com/snide/sphinx_rtd_theme">Sphinx theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a> </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../../', VERSION:'1.12.1', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <script type="text/javascript" src="../../_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>