@itentialopensource/adapter-openstack_nova

<!DOCTYPE html>  <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/"> <title>Compute API — nova documentation</title> <link rel="stylesheet" type="text/css" href="./ComputeAPI-nova-documentation_files/pygments.css"> <link rel="stylesheet" type="text/css" href="./ComputeAPI-nova-documentation_files/basic.css"> <link rel="stylesheet" type="text/css" href="./ComputeAPI-nova-documentation_files/api-site.css"> <script src="./ComputeAPI-nova-documentation_files/embed.min.js.pobierz"></script> <script async="" src="./ComputeAPI-nova-documentation_files/analytics.js.pobierz"></script> <script data-url_root="./" id="documentation_options" src="./ComputeAPI-nova-documentation_files/documentation_options.js.pobierz"></script> <script src="./ComputeAPI-nova-documentation_files/jquery.js.pobierz"></script> <script src="./ComputeAPI-nova-documentation_files/underscore.js.pobierz"></script> <script src="./ComputeAPI-nova-documentation_files/doctools.js.pobierz"></script> <script src="./ComputeAPI-nova-documentation_files/api-site.js.pobierz"></script> <script src="./ComputeAPI-nova-documentation_files/combobox.js.pobierz"></script> <link rel="index" title="Index" href="https://docs.openstack.org/api-ref/compute/genindex.html"> <link rel="search" title="Search" href="https://docs.openstack.org/api-ref/compute/search.html"> <meta name="viewport" content="width=device-width, initial-scale=1">  <link href="./ComputeAPI-nova-documentation_files/bootstrap.min.css" rel="stylesheet">  <link href="./ComputeAPI-nova-documentation_files/font-awesome.min.css" rel="stylesheet">  <link href="./ComputeAPI-nova-documentation_files/combined.css" rel="stylesheet">  <link href="./ComputeAPI-nova-documentation_files/search.css" rel="stylesheet">  <link href="./ComputeAPI-nova-documentation_files/pygments.css" rel="stylesheet">     <script> (function (i, s, o, g, r, a, m) { i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () { (i[r].q = i[r].q || []).push(arguments) }, i[r].l = 1 * new Date(); a = s.createElement(o), m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) })(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga'); ga('create', 'UA-17511903-1', 'auto'); ga('send', 'pageview'); </script>  <style type="text/css"> .ossw-search-bar-wrapper { position: relative; } #search-bar-input { width: 100%; border: 2px solid #dae5ee; border-radius: 4px; height: 37px; padding: 0 0 0 10px; background: #fff; color: #30739C; font-size: 12px; text-transform: lowercase; font-weight: 400; } #search-bar-input::placeholder { color: #C7CAE0; } #search-bar-input:focus { border-color: #30739C; outline: none; } .ossw-search-bar-close { cursor: pointer; position: absolute; top: 10px; right: 15px; color: #dae5ee; z-index: 1001; font-size: 16px; } .ossw-search-bar-close:hover { color: #30739C; } .ossw-no-results { font-size: 12px; font-weight: 500; line-height: 1; color: #8B9BAD; } .ossw-search-suggestions-wrapper { display: none; } .ossw-search-suggestions { border: 1px solid #DDDDDD; padding: 5px; position: relative; top: 10px; z-index: 9999; background: white; width: 100%; } .ossw-result-item { padding: 10px 5px; display: block; position: relative; cursor: pointer; border-bottom: 1px solid #E9EDF2; text-align: left; text-decoration: none } .ossw-result-item:before { right: 22px; top: 50%; margin-top: -3px; width: 6px; height: 6px; border-style: solid; border-width: 1px 1px 0 0; border-color: #C5D1DE; -webkit-transform: rotate(45deg); -moz-transform: rotate(45deg); -ms-transform: rotate(45deg); transform: rotate(45deg); display: block; position: absolute; content: "" } .ossw-result-item:after { display: table; content: ""; width: 0; height: 0; clear: both } .ossw-result-item:hover { background-color: rgba(0, 0, 0, 0.05); } .ossw-result-item:hover:before { border-color: #8B9BAD } .ossw-result-item:hover .ossw-result-detail { color: #3B454F } .ossw-result-item em { font-style: normal; -webkit-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.1); -moz-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.1); box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.1); font-weight: bold; background-color: #f6fcfe; } .ossw-result-heading { width: 90%; font-weight: 500; font-size: 13px; line-height: 1.2; margin-bottom: 4px; color: #258BF8; white-space: nowrap; overflow: hidden; -ms-text-overflow: ellipsis; text-overflow: ellipsis; } .ossw-result-detail { width: 90%; max-height: 31px; overflow: hidden; font-size: 12px; font-weight: 400; line-height: 1.4; color: #8B9BAD } .ossw-search-results { display: none; } .ossw-search-results .ossw-overlay { position: fixed; top: 0; left: 0; width: 100%; height: 100%; background: rgba(0, 0, 0, 0.5); z-index: 99999991 } .ossw-search-results .ossw-overlay.ossw-dismiss { display: none } .ossw-search-results .ossw-overlay.ossw-dismiss .ossw-container { opacity: 0; -webkit-animation: st-ui-fade-out ease-in-out 0.5s; -moz-animation: st-ui-fade-out ease-in-out 0.5s; animation: st-ui-fade-out ease-in-out 0.5s } .ossw-search-results .ossw-container { position: fixed; top: 0; margin: 64px 0 0 0; width: 60%; height: 80%; max-width: 800px; -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; background: #fff; z-index: 99999992; -webkit-animation: st-ui-fade-in ease-in-out 0.5s; -moz-animation: st-ui-fade-in ease-in-out 0.5s; animation: st-ui-fade-in ease-in-out 0.5s; overflow: hidden; -webkit-text-size-adjust: none; -ms-text-size-adjust: none; text-size-adjust: none; -webkit-border-radius: 5px; -moz-border-radius: 5px; border-radius: 5px; font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif; } @media (max-width: 660px) { .ossw-pagination .ossw-page-link:not(.ossw-active):not(.next) { display: none !important; } } @media only screen and (orientation: portrait) { .ossw-search-results .ossw-container { height: 60%; } } .ossw-search-results .ossw-container .ossw-header-wrapper { margin: 0; padding: 0; border: 0; -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; -webkit-font-smoothing: antialiased; -webkit-text-size-adjust: none; -ms-text-size-adjust: none; text-size-adjust: none; font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header { position: relative; width: 100%; height: 49px; border-bottom: 1px solid rgba(0, 0, 0, 0.1); z-index: 99999997; background: #F9FAFB; -moz-background-clip: padding-box; background-clip: padding-box; -webkit-backface-visibility: hidden; -moz-backface-visibility: hidden; backface-visibility: hidden; -webkit-border-radius: 5px 5px 0 0; -moz-border-radius: 5px 5px 0 0; border-radius: 5px 5px 0 0; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header input { padding: 0 120px 0 36px; width: 100%; height: 48px; background: transparent; border: 0; outline: none; color: #3B454F; font-size: 15px; font-weight: 500; line-height: 19px; -webkit-border-radius: 5px 5px 0 0; -moz-border-radius: 5px 5px 0 0; border-radius: 5px 5px 0 0; font-family: system, -apple-system, BlinkMacSystemFont, "Helvetica Neue", "Lucida Grande", sans-serif; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header input:focus { height: 50px; border-bottom: 2px solid #33AAFF } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-search-icon { display: block; position: absolute; top: 18px; left: 15px; width: 13px; height: 13px; pointer-events: none; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-search-icon .fa { opacity: 0.6; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-close-icon { display: block; position: absolute; top: 16px; right: 14px; width: 16px; height: 16px; cursor: pointer; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-close-icon .fa { opacity: 0.6; } .ossw-search-results .ossw-container .ossw-header-wrapper .ossw-header .ossw-close-icon .fa:hover { opacity: 1; } .ossw-search-results .ossw-suggestions-wrapper { position: absolute; top: 0; left: 0; margin: 0; padding: 68px 10px; width: 50%; height: 100%; z-index: 99999995; background: #fff; -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; border: 0; -webkit-animation: st-ui-slide-in ease-in-out 0.5s; -moz-animation: st-ui-slide-in ease-in-out 0.5s; animation: st-ui-slide-in ease-in-out 0.5s; -webkit-box-shadow: 1px 0 3px rgba(0, 0, 0, 0.2); -moz-box-shadow: 1px 0 3px rgba(0, 0, 0, 0.2); box-shadow: 1px 0 3px rgba(0, 0, 0, 0.2); -webkit-border-radius: 5px; -moz-border-radius: 5px; border-radius: 5px; } .ossw-search-results .ossw-suggestions-wrapper .ossw-heading { margin-bottom: 0; padding: 6px 18px 14px 0; border-bottom: 1px solid #E9EDF2; color: rgba(0, 0, 0, 0.4); } .ossw-search-results .ossw-results-wrapper { position: absolute; top: 0; left: 0; padding: 50px 0px; width: 100%; height: 100%; overflow: auto; -webkit-overflow-scrolling: touch; -webkit-border-radius: 5px; -moz-border-radius: 5px; border-radius: 5px; } .ossw-search-results .ossw-results-wrapper .ossw-results { padding: 0 10px 50px 10px; } .ossw-search-results .ossw-footer-wrapper .ossw-footer { position: absolute; bottom: 0; left: 0; width: 100%; height: 49px; border-top: 1px solid rgba(0, 0, 0, 0.1); background: #F9FAFB; z-index: 99999996; -moz-background-clip: padding-box; background-clip: padding-box; -webkit-backface-visibility: hidden; -moz-backface-visibility: hidden; backface-visibility: hidden; -webkit-border-radius: 0 0 5px 5px; -moz-border-radius: 0 0 5px 5px; border-radius: 0 0 5px 5px; } .ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-summary { display: block; position: absolute; width: 65%; top: 18px; left: 16px; float: left; font-size: 12px; font-weight: 500; line-height: 1; color: #8B9BAD; } .ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination { display: block; padding-right: 9px; float: right; text-align: right; font-size: 12px; font-weight: 500; color: #8B9BAD; line-height: 1; } .ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination .ossw-page-link { display: inline-block; padding: 18px 7px; text-decoration: none; color: #258BF8; text-transform: uppercase; } .ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination .ossw-page-link.ossw-active { color: #8B9BAD; } .ossw-search-results .ossw-footer-wrapper .ossw-footer .ossw-pagination .ossw-page-link .ossw-right-arrow { display: inline-block; position: relative; width: 6px; height: 6px; margin: 0 0 0 2px; } </style> </head> <body>  <script> (function (window, document) { var loader = function () { var script = document.createElement("script"), tag = document.getElementsByTagName("script")[0]; script.src = "https://search.openstack.org/widget/embed.min.js?t=" + Date.now(); tag.parentNode.insertBefore(script, tag); }; window.addEventListener ? window.addEventListener("load", loader, false) : window.attachEvent("onload", loader); })(window, document); </script> <nav class="navbar navbar-default" role="navigation"> <div class="container">  <div class="navbar-header"> <button class="navbar-toggle" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <div class="brand-wrapper"> <a class="navbar-brand" href="https://www.openstack.org/"></a> </div> <div class="search-icon show"><i class="fa fa-search"></i> Search</div> </div> <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1"> <div class="search-container tiny"> <div class="openstack-search-bar" data-baseurl="search.openstack.org" data-context="docs-openstack"> <div class="ossw-search-wrapper"> <div class="ossw-search-bar-wrapper"><input type="text" id="search-bar-input" placeholder="Search OpenStack" value=""> <i class="fa fa-times ossw-search-bar-close"></i></div> <div class="ossw-search-suggestions-wrapper"></div> <div class="ossw-search-results"> <div class="ossw-overlay"></div> <div class="ossw-container"> <div class="ossw-header-wrapper"> <section class="ossw-header"><input type="text" placeholder="Search OpenStack" id="search-popup-input" value=""> <span class="ossw-search-icon"><i class="fa fa-search"></i></span> <a class="ossw-close-icon"><i class="fa fa-times"></i></a> </section> </div> <div> <section style="display: none;" class="ossw-suggestions-wrapper"> <div class="ossw-heading">suggested results</div> <div class="ossw-suggestions"></div> </section> <section class="ossw-results-wrapper"> <div style="display: block;" class="ossw-results"></div> </section> </div> <div class="ossw-footer-wrapper"> <section class="ossw-footer"><span class="ossw-summary"> <div>No results found for “”</div> </span></section> </div> </div> </div> </div> </div> </div> <ul class="nav navbar-nav navbar-main show"> <li class="search-container-mobile"> <div class="openstack-search-bar" data-baseurl="search.openstack.org" data-context="docs-openstack"> <div class="ossw-search-wrapper"> <div class="ossw-search-bar-wrapper"><input type="text" id="search-bar-input" placeholder="Search OpenStack" value=""> <i class="fa fa-times ossw-search-bar-close"></i></div> <div class="ossw-search-suggestions-wrapper"></div> <div class="ossw-search-results"> <div class="ossw-overlay"></div> <div class="ossw-container"> <div class="ossw-header-wrapper"> <section class="ossw-header"><input type="text" placeholder="Search OpenStack" id="search-popup-input" value=""> <span class="ossw-search-icon"><i class="fa fa-search"></i></span> <a class="ossw-close-icon"><i class="fa fa-times"></i></a> </section> </div> <div> <section style="display: none;" class="ossw-suggestions-wrapper"> <div class="ossw-heading">suggested results</div> <div class="ossw-suggestions"></div> </section> <section class="ossw-results-wrapper"> <div style="display: block;" class="ossw-results"></div> </section> </div> <div class="ossw-footer-wrapper"> <section class="ossw-footer"><span class="ossw-summary"> <div>No results found for “”</div> </span></section> </div> </div> </div> </div> </div> </li> <li>  <a href="https://www.openstack.org/software/" class="drop" id="dropdownMenuSoftware">Software <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuSoftware"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/">Overview</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/openstack-components">OpenStack Components</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/sdks">SDKs</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/project-navigator/deployment-tools">Deployment Tools</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/assets/software/projectmap/openstack-map.pdf" target="_blank">OpenStack Map</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/software/sample-configs/">Sample Configs</a></li> </ul> </li> <li>  <a href="https://www.openstack.org/use-cases/" class="drop" id="dropdownMenuUsers">Use Cases <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuUsers"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/">Users in Production</a></li> <li role="presentation" class="divider"></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/bare-metal/">Ironic Bare Metal</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/edge-computing/">Edge Computing</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/telecoms-and-nfv/">Telecom & NFV</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/science/">Science and HPC</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/containers/">Containers</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/use-cases/enterprise/">Enterprise</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/surveys/landing">User Survey</a></li> </ul> </li> <li>  <a href="https://www.openstack.org/events/" class="drop" id="dropdownMenuEvents">Events <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/summit/">Open Infrastructure Summits</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/ptg/">Project Teams Gathering</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/opendev-2020/">OpenDev</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/community-events/">Community Events</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/events/openstackdays">OpenStack & OpenInfra Days</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/videos/">Summit Videos</a></li> </ul> </li> <li>  <a href="https://www.openstack.org/community/" class="drop" id="dropdownMenuCommunity">Community <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuCommunity"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/">Welcome! Start Here</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/tech-committee">OpenStack Technical Committee</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/speakers/">Speakers Bureau</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="http://wiki.openstack.org/">OpenStack Wiki</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/coa/">Get Certified (COA)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/jobs/">Jobs</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketing/">Marketing Resources</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/news/">Community News</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="http://superuser.openstack.org/">Superuser Magazine</a></li> <li role="presentation" class="divider"></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/community/supporting-organizations/">OpenInfra Foundation Supporting Organizations</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/">Open Infrastructure Foundation (OpenInfra Foundation)</a></li> </ul> </li> <li>  <a href="https://www.openstack.orgmarketplace/" class="drop" id="dropdownMenuLearn">Marketplace <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/training/">Training</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/distros/">Distros & Appliances</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/public-clouds/">Public Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/hosted-private-clouds/">Hosted Private Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/remotely-managed-private-clouds/">Remotely Managed Private Clouds</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/consulting/">Consulting & Integrators</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://www.openstack.org/marketplace/drivers/">Drivers</a></li> </ul> </li> <li>  <a href="https://www.openstack.org/blog/">Blog</a> </li> <li>  <a href="http://docs.openstack.org/">Docs</a> </li> <li>  </li> <li class="join-nav-section"> <a href="https://openinfra.dev/join/" id="dropdownMenuJoin">Join <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu dropdown-hover" role="menu" aria-labelledby="dropdownMenuJoin" style="display: none;"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sign up for Foundation Membership</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/join/">Sponsor the Foundation</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/">More about the Foundation</a></li> </ul> </li> <li> <a href="https://www.openstack.org/Security/login/?BackURL=/home/" class="sign-in-btn">Log In</a> </li> </ul> </div> </div>  </nav> <div class="container docs-book-wrapper"> <div class="row"> <div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4"> <div class="row docs-title"> <div class="col-lg-8"> <h1>Compute API</h1> </div> <div class="docs-actions"> <a id="logABugLink1" href="https://bugs.launchpad.net/nova/+filebug?field.title=Compute%20API%20in%20nova&field.tags=api-ref&field.comment=%0A%0A%0AThis%20bug%20tracker%20is%20for%20errors%20with%20the%20documentation,%20use%20the%20following%20as%20a%20template%20and%20remove%20or%20add%20fields%20as%20you%20see%20fit.%20Convert%20[%20]%20into%20[x]%20to%20check%20boxes:%0A%0A-%20[%20]%20This%20doc%20is%20inaccurate%20in%20this%20way:%20______%0A-%20[%20]%20This%20is%20a%20doc%20addition%20request.%0A-%20[%20]%20I%20have%20a%20fix%20to%20the%20document%20that%20I%20can%20paste%20below%20including%20example:%20input%20and%20output.%20%0A%0AIf%20you%20have%20a%20troubleshooting%20or%20support%20issue,%20use%20the%20following%20%20resources:%0A%0A%20-%20The%20mailing%20list:%20https://lists.openstack.org%0A%20-%20IRC:%20%27openstack%27%20channel%20on%20OFTC%0A%0A-----------------------------------%0ARelease:%20%20on%202021-11-09%2014:55:54%0ASHA:%2093a61f7bd318fe5e7e2619261aaa67889d44e8c5%0ASource:%20https://opendev.org/openstack/nova/src/api-ref/source/index.rst%0AURL:%20https://docs.openstack.org/api-ref/compute/" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="" data-original-title="Report a Bug"></i></a> </div> </div> <div class="row"> <div class="col-lg-12"> <div class="docs-body" role="main"> <section id="compute-api"> <h1>Compute API<a class="headerlink" href="https://docs.openstack.org/api-ref/compute/#compute-api" title="Permalink to this headline">¶</a></h1> <p>This is a reference for the OpenStack Compute API which is provided by the Nova project. To learn more about the OpenStack Compute API concepts, please refer to the <a class="reference external" href="https://docs.openstack.org/api-guide/compute/index.html">API guide</a>.</p> <div class="row"> <div class="col-md-2 col-md-offset-9"> </div> <div class="col-md-1"> <button id="expand-all" data-toggle="collapse" class="btn btn-info btn-sm btn-expand-all">Show All</button> </div> </div> </section> <section id="api-versions"> <h1>API Versions<a class="headerlink" href="https://docs.openstack.org/api-ref/compute/#api-versions" title="Permalink to this headline">¶</a></h1> <p>In order to bring new features to users over time, the Nova API supports versioning. There are two kinds of versions in Nova.</p> <ul class="simple"> <li> <p>‘’major versions’’, which have dedicated urls</p> </li> <li> <p>‘’microversions’’, which can be requested through the use of the <code class="docutils literal notranslate"><span class="pre">X-OpenStack-Nova-API-Version</span></code> header, or since microversion 2.27 the <code class="docutils literal notranslate"><span class="pre">OpenStack-API-Version</span></code> header may also be used. </p> </li> </ul> <p>For more details about Microversions, please reference: <a class="reference external" href="https://docs.openstack.org/api-guide/compute/microversions.html">Microversions</a> </p> <div class="admonition note"> <p class="admonition-title"> <div class="fa fa-fw fa-check-circle"> </div>Note</p> <p>The maximum microversion supported by each release varies. Please reference: <a class="reference external" href="https://docs.openstack.org/nova/latest/reference/api-microversion-history.html">API Microversion History</a> for API microversion history details. </p> </div> <p>The Version APIs work differently from other APIs as they <em>do not</em> require authentication.</p> <section class="detail-control" id="list-all-major-versions"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-all-major-versions" class="operation-anchor" href="https://docs.openstack.org/api-ref/compute/#list-all-major-versions" onclick="window.location.hash = hash;"> <span class="glyphicon glyphicon-link"></span></a> <span class="label label-GET">GET</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/</div> <div class="row col-md-12"> <p class="url-subtitle">List All Major Versions</p> </div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-all-major-versions-detail" data-toggle="collapse" id="list-all-major-versions-detail-btn">detail</button> </div> </div> </div> </section> <section class="api-detail collapse" id="list-all-major-versions-detail"> <p>This fetches all the information about all known major API versions in the deployment. Links to more specific information will be provided for each API version, as well as information about supported min and max microversions.</p> <p>Normal Response Codes: 200</p> <section id="response"> <h3>Response<a class="headerlink" href="https://docs.openstack.org/api-ref/compute/#response" title="Permalink to this headline">¶</a></h3> <table class="docutils align-default"> <colgroup> <col style="width: 20%"> <col style="width: 10%"> <col style="width: 10%"> <col style="width: 60%"> </colgroup> <thead> <tr class="row-odd"> <th class="head"> <p>Name</p> </th> <th class="head"> <p>In</p> </th> <th class="head"> <p>Type</p> </th> <th class="head"> <p>Description</p> </th> </tr> </thead> <tbody> <tr class="row-even"> <td> <p>versions</p> </td> <td> <p>body</p> </td> <td> <p>array</p> </td> <td> <p>A list of version objects that describe the API versions available.</p> </td> </tr> <tr class="row-odd"> <td> <p>id</p> </td> <td> <p>body</p> </td> <td> <p>string</p> </td> <td> <p>A common name for the version in question. Informative only, it has no real semantic meaning.</p> </td> </tr> <tr class="row-even"> <td> <p>links</p> </td> <td> <p>body</p> </td> <td> <p>array</p> </td> <td> <p>Links to the resources in question. See <a class="reference external" href="https://docs.openstack.org/api-guide/compute/links_and_references.html">API Guide / Links and References</a> for more info.</p> </td> </tr> <tr class="row-odd"> <td> <p>min_version</p> </td> <td> <p>body</p> </td> <td> <p>string</p> </td> <td> <p>If this version of the API supports microversions, the minimum microversion that is supported. This will be the empty string if microversions are not supported.</p> </td> </tr> <tr class="row-even"> <td> <p>status</p> </td> <td> <p>body</p> </td> <td> <p>string</p> </td> <td> <p>The status of this API version. This can be one of:</p> <ul class="simple"> <li> <p><code class="docutils literal notranslate"><span class="pre">CURRENT</span></code>: this is the preferred version of the API to use</p> </li> <li> <p><code class="docutils literal notranslate"><span class="pre">SUPPORTED</span></code>: this is an older, but still supported version of the API</p> </li> <li> <p><code class="docutils literal notranslate"><span class="pre">DEPRECATED</span></code>: a deprecated version of the API that is slated for removal</p> </li> </ul> </td> </tr> <tr class="row-odd"> <td> <p>updated</p> </td> <td> <p>body</p> </td> <td> <p>string</p> </td> <td> <p>This is a fixed string. It is <code class="docutils literal notranslate"><span class="pre">2011-01-21T11:33:21Z</span></code> in version 2.0, <code class="docutils literal notranslate"><span class="pre">2013-07-23T11:33:21Z</span></code> in version 2.1. </p> <div class="admonition note"> <p class="admonition-title"> <div class="fa fa-fw fa-check-circle"> </div>Note</p> <p>It is vestigial and provides no useful information. It will be deprecated and removed in the future.</p> </div> </td> </tr> <tr class="row-even"> <td> <p>version</p> </td> <td> <p>body</p> </td> <td> <p>string</p> </td> <td> <p>If this version of the API supports microversions, the maximum microversion that is supported. This will be the empty string if microversions are not supported.</p> </td> </tr> </tbody> </table> </section> <section id="response-example"> <h3>Response Example<a class="headerlink" href="https://docs.openstack.org/api-ref/compute/#response-example" title="Permalink to this headline">¶</a></h3> <p>This demonstrates the expected response from a bleeding edge server that supports up to the current microversion. When querying OpenStack environments you will typically find the current microversion on the v2.1 API is lower than listed below.</p> <div class="highlight-javascript notranslate"> <div class="highlight"> <pre><span></span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="s2">"versions"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span> <span class="w"> </span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"v2.0"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"links"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span> <span class="w"> </span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://openstack.example.com/v2/"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"self"</span><span class="w"></span> <span class="w"> </span><span class="p">}</span><span class="w"></span> <span class="w"> </span><span class="p">],</span><span class="w"></span> <span class="w"> </span><span class="s2">"status"</span><span class="o">:</span><span class="w"> </span><span class="s2">"SUPPORTED"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"version"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"min_version"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"updated"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2011-01-21T11:33:21Z"</span><span class="w"></span> <span class="w"> </span><span class="p">},</span><span class="w"></span> <span class="w"> </span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"v2.1"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"links"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="w"></span> <span class="w"> </span><span class="p">{</span><span class="w"></span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://openstack.example.com/v2.1/"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"self"</span><span class="w"></span> <span class="w"> </span><span class="p">}</span><span class="w"></span> <span class="w"> </span><span class="p">],</span><span class="w"></span> <span class="w"> </span><span class="s2">"status"</span><span class="o">:</span><span class="w"> </span><span class="s2">"CURRENT"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"version"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2.90"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"min_version"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2.1"</span><span class="p">,</span><span class="w"></span> <span class="w"> </span><span class="s2">"updated"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2013-07-23T11:33:21Z"</span><span class="w"></span> <span class="w"> </span><span class="p">}</span><span class="w"></span> <span class="w"> </span><span class="p">]</span><span class="w"></span> <span class="p">}</span><span class="w"></span> </pre> </div> </div> </section> </section> <section class="detail-control" id="show-details-of-specific-api-version"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-details-of-specific-api-version" class="operation-anchor" href="https://docs.openstack.org/api-ref/compute/#show-details-of-specific-api-version" onclick="window.location.hash = hash;"> <span class="glyphicon glyphicon-link"></span></a> <span class="label label-GET">GET</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/<span class="path_parameter">{api_version}</span>/</div> <div class="row col-md-12"> <p class="url-subtitle">Show Details of Specific API Version</p> </div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-details-of-specific-api-version-detail" data-toggle="collapse" id="show-details-of-specific-api-version-detail-btn">detail</button> </div> </div> </div> </section> <section class="api-detail collapse" id="show-details-of-specific-api-version-detail"> <p>This gets the details of a specific API at its root. Nearly all this information exists at the API root, so this is mostl