@itentialopensource/adapter-openstack_cinder
Version:
This adapter integrates with system described as: Openstack Block Storage (Cinder) Service
1,027 lines (956 loc) • 1.61 MB
HTML
<!DOCTYPE html>
<!-- saved from url=(0072)https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded= -->
<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>Block Storage API V3 (CURRENT) — cinder documentation</title>
<link rel="stylesheet" type="text/css" href="./BlockStorageAPIV3-cinder-documentation_files/pygments.css">
<link rel="stylesheet" type="text/css" href="./BlockStorageAPIV3-cinder-documentation_files/basic.css">
<link rel="stylesheet" type="text/css" href="./BlockStorageAPIV3-cinder-documentation_files/api-site.css">
<script src="./BlockStorageAPIV3-cinder-documentation_files/embed.min.js.pobierz"></script><script async="" src="./BlockStorageAPIV3-cinder-documentation_files/analytics.js.pobierz"></script><script data-url_root="../" id="documentation_options" src="./BlockStorageAPIV3-cinder-documentation_files/documentation_options.js.pobierz"></script>
<script src="./BlockStorageAPIV3-cinder-documentation_files/jquery.js.pobierz"></script>
<script src="./BlockStorageAPIV3-cinder-documentation_files/underscore.js.pobierz"></script>
<script src="./BlockStorageAPIV3-cinder-documentation_files/doctools.js.pobierz"></script>
<script src="./BlockStorageAPIV3-cinder-documentation_files/api-site.js.pobierz"></script>
<script src="./BlockStorageAPIV3-cinder-documentation_files/combobox.js.pobierz"></script>
<link rel="index" title="Index" href="https://docs.openstack.org/api-ref/block-storage/genindex.html">
<link rel="search" title="Search" href="https://docs.openstack.org/api-ref/block-storage/search.html">
<link rel="next" title="Block Storage API V2 (REMOVED)" href="https://docs.openstack.org/api-ref/block-storage/v2/index.html">
<link rel="prev" title="REST API Version History" href="https://docs.openstack.org/api-ref/block-storage/api_microversion_history.html">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!-- Bootstrap CSS -->
<link href="./BlockStorageAPIV3-cinder-documentation_files/bootstrap.min.css" rel="stylesheet">
<!-- Fonts -->
<link href="./BlockStorageAPIV3-cinder-documentation_files/font-awesome.min.css" rel="stylesheet">
<!-- Custom CSS -->
<link href="./BlockStorageAPIV3-cinder-documentation_files/combined.css" rel="stylesheet">
<!-- Search CSS -->
<link href="./BlockStorageAPIV3-cinder-documentation_files/search.css" rel="stylesheet">
<!-- Pygments CSS -->
<link href="./BlockStorageAPIV3-cinder-documentation_files/pygments.css" rel="stylesheet">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Google Analytics -->
<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>
<!-- End Google Analytics -->
<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>
<!-- SOURCE_FILE: https://opendev.org/openstack/cinder/src/api-ref/source/v3/index.rst -->
<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">
<!-- Brand and toggle get grouped for better mobile display -->
<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> <!--Software -->
<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> <!-- Use Cases -->
<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> <!-- Events -->
<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><!-- Community -->
<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><!-- Marketplace -->
<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><!-- Blog -->
<a href="https://www.openstack.org/blog/">Blog</a>
</li>
<li><!-- Docs -->
<a href="http://docs.openstack.org/">Docs</a>
</li>
<li> <!-- Join -->
</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>
<!-- /.container -->
</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>Block Storage API V3 (CURRENT)</h1>
</div>
<div class="docs-actions">
<a href="https://docs.openstack.org/api-ref/block-storage/api_microversion_history.html"><i class="fa fa-angle-double-left" data-toggle="tooltip" data-placement="top" title="" data-original-title="Previous: REST API Version History"></i></a>
<a href="https://docs.openstack.org/api-ref/block-storage/v2/index.html"><i class="fa fa-angle-double-right" data-toggle="tooltip" data-placement="top" title="" data-original-title="Next: Block Storage API V2 (REMOVED)"></i></a>
<a id="logABugLink1" href="https://bugs.launchpad.net/cinder/+filebug?field.title=Block%20Storage%20API%20V3%20(CURRENT)%20in%20cinder&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%202022-07-11%2018:19:02%0ASHA:%208a82d164b5f1dc63a7e5ea557d500f2e0e9d5628%0ASource:%20https://opendev.org/openstack/cinder/src/api-ref/source/v3/index.rst%0AURL:%20https://docs.openstack.org/api-ref/block-storage/v3/index.html" 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="block-storage-api-v3-current">
<h1>Block Storage API V3 (CURRENT)<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#block-storage-api-v3-current" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="admonition-title"><div class="fa fa-fw fa-check-circle"> </div>Note</p>
<p>The URL for most API methods includes a {project_id} placeholder that
represents the caller’s project ID. As of V3.67, the project_id is optional
in the URL, and the following are equivalent:</p>
<blockquote>
<div><ul class="simple">
<li><p>GET /v3/{project_id}/volumes</p></li>
<li><p>GET /v3/volumes</p></li>
</ul>
</div></blockquote>
<p>In both instances, the actual project_id used by the API method is the one
in the caller’s keystone context. For that reason, including a project_id
in the URL is redundant.</p>
<p>The V3.67 microversion is only used as an indicator that the API accepts a
URL without a project_id, and this applies to all requests regardless of
the microversion in the request. For example, an API node serving V3.67 or
greater will accept a URL without a project_id even if the request asks for
V3.0. Likewise, it will accept a URL containing a project_id even if the
request asks for V3.67.</p>
</div>
<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 id="api-versions">
<h2>API versions<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#api-versions" title="Permalink to this headline">¶</a></h2>
<section class="detail-control" id="list-all-api-versions">
<div class="operation-grp ">
<div class="row">
<div class="col-md-2">
<div class="operation">
<a name="list-all-api-versions" class="operation-anchor" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-all-api-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 Api Versions</p></div>
</div>
</div>
</div>
<div class="col-md-1">
<button class="btn btn-sm btn-detail btn-info collapsed" data-target="#list-all-api-versions-detail" data-toggle="collapse" id="list-all-api-versions-detail-btn" aria-expanded="false">detail</button>
</div>
</div>
</div></section>
<section class="api-detail collapse" id="list-all-api-versions-detail" aria-expanded="false" style="height: 0px;">
<p>Lists information for all Block Storage API versions.</p>
<section id="response-codes">
<h4>Response codes<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#response-codes" title="Permalink to this headline">¶</a></h4>
<section id="Success">
<h5>Success<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#Success" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%">
<col style="width: 70%">
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Code</p></th>
<th class="head"><p>Reason</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code>300 - Multiple Choices</code></td>
<td><p>The resource corresponds to more than one representation.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="Error">
<h5>Error<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#Error" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%">
<col style="width: 70%">
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Code</p></th>
<th class="head"><p>Reason</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code>400 - Bad Request</code></td>
<td><p>Some content in the request was invalid.</p></td>
</tr>
<tr class="row-odd"><td><code>401 - Unauthorized</code></td>
<td><p>User must authenticate before making a request.</p></td>
</tr>
<tr class="row-even"><td><code>403 - Forbidden</code></td>
<td><p>Policy does not allow current user to do this operation.</p></td>
</tr>
<tr class="row-odd"><td><code>405 - Method Not Allowed</code></td>
<td><p>Method is not valid for this endpoint and resource.</p></td>
</tr>
<tr class="row-even"><td><code>404 - Not Found</code></td>
<td><p>The requested resource could not be found.</p></td>
</tr>
<tr class="row-odd"><td><code>409 - Conflict</code></td>
<td><p>This resource has an action in progress that would conflict with this request.</p></td>
</tr>
<tr class="row-even"><td><code>500 - Internal Server Error</code></td>
<td><p>Something went wrong with the service which prevents it from fulfilling
the request.</p></td>
</tr>
<tr class="row-odd"><td><code>503 - Service Unavailable</code></td>
<td><p>The service cannot handle the request right now.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="request">
<h4>Request<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#request" title="Permalink to this headline">¶</a></h4>
</section>
<section id="response">
<h4>Response<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#response" title="Permalink to this headline">¶</a></h4>
<p><strong>Example List Api Versions: JSON request</strong></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">"v3.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">"https://docs.openstack.org/"</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">"describedby"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"text/html"</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">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://127.0.0.1:45697/v3/"</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">"media-types"</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">"base"</span><span class="o">:</span><span class="w"> </span><span class="s2">"application/json"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"application/vnd.openstack.volume+json;version=3"</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">"min_version"</span><span class="o">:</span><span class="w"> </span><span class="s2">"3.0"</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">"updated"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-03-30T00:00:00Z"</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">"3.68"</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>
<section id="api-version-details">
<h2>API version details<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#api-version-details" title="Permalink to this headline">¶</a></h2>
<section class="detail-control" id="show-api-v3-details">
<div class="operation-grp ">
<div class="row">
<div class="col-md-2">
<div class="operation">
<a name="show-api-v3-details" class="operation-anchor" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#show-api-v3-details" 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">/v3/</div>
<div class="row col-md-12"><p class="url-subtitle">Show API v3 details</p></div>
</div>
</div>
</div>
<div class="col-md-1">
<button class="btn btn-sm btn-detail btn-info collapsed" data-target="#show-api-v3-details-detail" data-toggle="collapse" id="show-api-v3-details-detail-btn" aria-expanded="false">detail</button>
</div>
</div>
</div></section>
<section class="api-detail collapse" id="show-api-v3-details-detail" aria-expanded="false" style="height: 0px;">
<p>Shows details for Block Storage API v3.</p>
<section id="id1">
<h4>Response codes<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#id1" title="Permalink to this headline">¶</a></h4>
<section id="Success">
<h5>Success<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#Success" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%">
<col style="width: 70%">
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Code</p></th>
<th class="head"><p>Reason</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code>200 - OK</code></td>
<td><p>Request was successful.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="Error">
<h5>Error<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#Error" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%">
<col style="width: 70%">
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Code</p></th>
<th class="head"><p>Reason</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code>403 - Forbidden</code></td>
<td><p>Policy does not allow current user to do this operation.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="id2">
<h4>Request<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#id2" title="Permalink to this headline">¶</a></h4>
</section>
<section id="response-parameters">
<h4>Response Parameters<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#response-parameters" title="Permalink to this headline">¶</a></h4>
<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>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">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 that API version updates.</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.</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>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>
<tr class="row-odd"><td><p>media-types</p></td>
<td><p>body</p></td>
<td><p>array</p></td>
<td><p>The <a class="reference external" href="https://www.iana.org/assignments/media-types/media-types.xhtml">media types</a>.
It is an array of a fixed dict.</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 provide no useful information.
It will be deprecated and removed in the future.</p>
</div>
</td>
</tr>
<tr class="row-even"><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>
</tbody>
</table>
</section>
<section id="response-example">
<h4>Response Example<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#response-example" title="Permalink to this headline">¶</a></h4>
<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">"v3.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">"https://docs.openstack.org/"</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">"describedby"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"text/html"</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">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://127.0.0.1:44895/v3/"</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">"media-types"</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">"base"</span><span class="o">:</span><span class="w"> </span><span class="s2">"application/json"</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="w"> </span><span class="s2">"application/vnd.openstack.volume+json;version=3"</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">"min_version"</span><span class="o">:</span><span class="w"> </span><span class="s2">"3.0"</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">"updated"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2022-03-30T00:00:00Z"</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">"3.68"</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>
<section id="api-extensions-extensions">
<h2>API extensions (extensions)<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#api-extensions-extensions" title="Permalink to this headline">¶</a></h2>
<section class="detail-control" id="list-known-api-extensions">
<div class="operation-grp ">
<div class="row">
<div class="col-md-2">
<div class="operation">
<a name="list-known-api-extensions" class="operation-anchor" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#list-known-api-extensions" 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">/v3/<span class="path_parameter">{project_id}</span>/extensions</div>
<div class="row col-md-12"><p class="url-subtitle">List Known API extensions</p></div>
</div>
</div>
</div>
<div class="col-md-1">
<button class="btn btn-sm btn-detail btn-info collapsed" data-target="#list-known-api-extensions-detail" data-toggle="collapse" id="list-known-api-extensions-detail-btn" aria-expanded="false">detail</button>
</div>
</div>
</div></section>
<section class="api-detail collapse" id="list-known-api-extensions-detail" aria-expanded="false" style="height: 0px;">
<p>Lists Block Storage API extensions.</p>
<section id="id3">
<h4>Response codes<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#id3" title="Permalink to this headline">¶</a></h4>
<section id="Success">
<h5>Success<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#Success" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%">
<col style="width: 70%">
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Code</p></th>
<th class="head"><p>Reason</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code>200 - OK</code></td>
<td><p>Request was successful.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="Error">
<h5>Error<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#Error" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 30%">
<col style="width: 70%">
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Code</p></th>
<th class="head"><p>Reason</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code>300 - Multiple Choices</code></td>
<td><p>The resource corresponds to more than one representation.</p></td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="id4">
<h4>Request<a class="headerlink" href="https://docs.openstack.org/api-ref/block-storage/v3/index.html?expanded=#id4" title="Permalink to this headline">¶</a></h4>
<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>
<