CINXE.COM

<!DOCTYPE html> <html lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>Messaging Service API v2 — zaqar documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=639405c8" /> <link rel="stylesheet" type="text/css" href="_static/basic.css?v=fb9458d3" /> <link rel="stylesheet" type="text/css" href="_static/api-site.css" /> <script src="_static/documentation_options.js?v=5929fcd5"></script> <script src="_static/doctools.js?v=9a2dae69"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/api-site.js"></script> <script src="_static/combobox.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <meta name="viewport" content="width=device-width, initial-scale=1">  <link href="_static/css/bootstrap.min.css" rel="stylesheet">  <link href="_static/css/font-awesome.min.css" rel="stylesheet">  <link href="_static/css/combined.css" rel="stylesheet">  <link href="_static/css/search.css" rel="stylesheet">  <link href="_static/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>  </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> </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> </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" 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" 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://openinfra.dev/summit" class="drop" id="dropdownMenuEvents">Events <i class="fa fa-caret-down"></i></a> <ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenuEvents"> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://openinfra.dev/summit">OpenInfra Summit</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" 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">OpenInfra Foundation</a></li> </ul> </li> <li> <a href="https://www.openstack.org/marketplace/" 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 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>Messaging Service API v2</h1> </div> <div class="docs-actions"> <a id="logABugLink1" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a> </div> </div> <div class="row"> <div class="col-lg-12"> <div class="docs-body" role="main"> <section id="messaging-service-api-v2"> <h1>Messaging Service API v2<a class="headerlink" href="#messaging-service-api-v2" title="Link to this heading">¶</a></h1> <p>This is a reference for the OpenStack Messaging Service API which is provided by the Zaqar project.</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="#api-versions" title="Link to this heading">¶</a></h1> <p>The Zaqar API only supports ‘’major versions’’ expressed in request URLs.</p> <section class="detail-control" id="list-major-versions"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-major-versions" class="operation-anchor" href="#list-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 major versions</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-major-versions-detail" data-toggle="collapse" id="list-major-versions-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-major-versions-detail"> <p>Gets the home document.</p> <p>This operation gets the home document.</p> <p>The entire API is discoverable from a single starting point, the home document. To explore the entire API, you need to know only this one URI. This document is cacheable.</p> <p>The home document lets you write clients by using relational links, so clients do not have to construct their own URLs. You can click through and view the JSON doc in your browser.</p> <p>For more information about home documents, see <a class="reference external" href="http://tools.ietf.org/html/draft-nottingham-json-home-02">http://tools.ietf.org/html/draft-nottingham-json-home-02</a>.</p> <section id="response-codes"> <h3>Response codes<a class="headerlink" href="#response-codes" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="response-parameters"> <h3>Response Parameters<a class="headerlink" href="#response-parameters" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>list</p></td> <td><p>A list of supported major API versions.</p></td> </tr> </tbody> </table> </section> <section id="response-example"> <h3>Response Example<a class="headerlink" href="#response-example" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"versions"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"status"</span><span class="o">:</span><span class="s2">"DEPRECATED"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"updated"</span><span class="o">:</span><span class="s2">"2014-9-11T17:47:05Z"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"media-types"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"base"</span><span class="o">:</span><span class="s2">"application/json"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"application/vnd.openstack.messaging-v1+json"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="s2">"1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"links"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v1/"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="s2">"self"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"status"</span><span class="o">:</span><span class="s2">"SUPPORTED"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"updated"</span><span class="o">:</span><span class="s2">"2014-9-24T04:06:47Z"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"media-types"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"base"</span><span class="o">:</span><span class="s2">"application/json"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"application/vnd.openstack.messaging-v1_1+json"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="s2">"1.1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"links"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v1.1/"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="s2">"self"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"status"</span><span class="o">:</span><span class="s2">"CURRENT"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"updated"</span><span class="o">:</span><span class="s2">"2014-9-24T04:06:47Z"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"media-types"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"base"</span><span class="o">:</span><span class="s2">"application/json"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"type"</span><span class="o">:</span><span class="s2">"application/vnd.openstack.messaging-v2+json"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="s2">"2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"links"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v2/"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="s2">"self"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> </section> <section id="queues-queues"> <h1>Queues (queues)<a class="headerlink" href="#queues-queues" title="Link to this heading">¶</a></h1> <p>Queue is a logical entity that groups messages. Ideally a queue is created per work type. For example, if you want to compress files, you would create a queue dedicated for this job. Any application that reads from this queue would only compress files.</p> <p>Nowadays, queue in Zaqar is most like a topic, it’s created lazily. User can post messages to a queue before creating the queue. Zaqar will create the queue/topic automatically.</p> <section class="detail-control" id="list-queues"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-queues" class="operation-anchor" href="#list-queues" 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">/v2/queues</div> <div class="row col-md-12"><p class="url-subtitle">List queues</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-queues-detail" data-toggle="collapse" id="list-queues-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-queues-detail"> <p>Lists queues.</p> <p>A request to list queues when you have no queues in your account returns 204, instead of 200, because there was no information to send back.</p> <p>This operation lists queues for the project. The queues are sorted alphabetically by name.</p> <p>When queue listing , we can add filter in query string parameter to filter queue, like name and metadata. If metadata or name of queue is consistent with the filter,the queue will be listed to the user, otherwise the queue will be filtered.</p> <section id="id1"> <h3>Response codes<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>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-parameters"> <h3>Request Parameters<a class="headerlink" href="#request-parameters" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>limit (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>Requests a page size of items. Returns a number of items up to a limit value. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-odd"><td><p>marker (Optional)</p></td> <td><p>query</p></td> <td><p>string</p></td> <td><p>The ID of the last-seen item. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-even"><td><p>detailed (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>The ‘detailed’ specifies if showing the detailed information when querying queues, flavors and pools.</p></td> </tr> <tr class="row-odd"><td><p>name (Optional)</p></td> <td><p>query</p></td> <td><p>string</p></td> <td><p>The ‘name’ specifies if filter the queues by queue’s name when querying queues.</p></td> </tr> <tr class="row-even"><td><p>with_count (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>The ‘with_count’ specifies if showing the amount of queues when querying them.</p></td> </tr> </tbody> </table> </section> <section id="id2"> <h3>Response Parameters<a class="headerlink" href="#id2" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queues</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the queues.</p></td> </tr> <tr class="row-odd"><td><p>links</p></td> <td><p>body</p></td> <td><p>array</p></td> <td><p>Links related to the queues. This is a list of dictionaries, each including keys <code class="docutils literal notranslate"><span class="pre">href</span></code> and <code class="docutils literal notranslate"><span class="pre">rel</span></code>.</p></td> </tr> <tr class="row-even"><td><p>count (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">count</span></code> attribute specifies how many queus in current project.</p></td> </tr> </tbody> </table> </section> <section id="id3"> <h3>Response Example<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"queues"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v2/queues/beijing"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="s2">"beijing"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v2/queues/london"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="s2">"london"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v2/queues/wellington"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="s2">"wellington"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"links"</span><span class="o">:</span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="s2">"/v2/queues?marker=wellington"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"count"</span><span class="o">:</span><span class="w"> </span><span class="mf">3</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="create-queue"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="create-queue" class="operation-anchor" href="#create-queue" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PUT">PUT</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Create queue</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#create-queue-detail" data-toggle="collapse" id="create-queue-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="create-queue-detail"> <p>Creates a queue.</p> <p>This operation creates a new queue.</p> <p>The body of the request is empty.</p> <p><code class="docutils literal notranslate"><span class="pre">queue_name</span></code> is the name that you give to the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.</p> <p>When create queue, user can specify metadata for the queue. Currently, Zaqar supports below metadata: _flavor, _max_claim_count, _dead_letter_queue, _dead_letter_queue_messages_ttl and _enable_encrypt_messages.</p> <p>In order to support the delayed queues, now add a metadata <code class="docutils literal notranslate"><span class="pre">_default_message_delay</span></code>.</p> <section id="id4"> <h3>Response codes<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> <tr class="row-odd"><td><code>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id5"> <h3>Request Parameters<a class="headerlink" href="#id5" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>_dead_letter_queue (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The target the message will be moved to when the message can’t processed successfully after meet the max claim count. It’s not supported to add queue C as the dead letter queue for queue B where queue B has been set as a dead letter queue for queue A. There is no default value for this attribute. If it’s not set explicitly, then that means there is no dead letter queue for current queue. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-even"><td><p>_dead_letter_queue_messages_ttl (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The new TTL setting for messages when moved to dead letter queue. If it’s not set, current TTL will be kept. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-odd"><td><p>_default_message_delay (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The delay of messages defined for a queue. When the messages send to the queue, it will be delayed for some times and means it can not be claimed until the delay expired. And user can define a queue’s level value for delay, also can define a message’s level. The latter has a higher priority. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-even"><td><p>_default_message_ttl</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The default TTL of messages defined for a queue, which will effect for any messages posted to the queue. So when there is no TTL defined for a message, the queue’s _default_message_ttl will be used. By default, the value is the same value defined as ‘’max_message_ttl’’ in zaqar.conf. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues. The value will be reverted to the default value after deleting it explicitly.</p></td> </tr> <tr class="row-odd"><td><p>_flavor (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The flavor name which can tell Zaqar which storage pool will be used to create the queue. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-even"><td><p>_max_claim_count (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The max number the message can be claimed. Generally, it means the message cannot be processed successfully. There is no default value for this attribute. If it’s not set, then that means this feature won’t be enabled for current queue. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-odd"><td><p>_max_messages_post_size</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The max post size of messages defined for a queue, which will effect for any messages posted to the queue. So user can define a queue’s level cap for post size which can’t bigger than the max_messages_post_size defined in zaqar.conf. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues. The value will be reverted to the default value after deleting it explicitly.</p></td> </tr> <tr class="row-even"><td><p>_enable_encrypt_messages (Optional)</p></td> <td><p>body</p></td> <td><p>boolean</p></td> <td><p>The switch of encrypting messages for a queue, which will effect for any messages posted to the queue. By default, the value is False. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> </tbody> </table> </section> <section id="request-example"> <h3>Request Example<a class="headerlink" href="#request-example" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"_max_messages_post_size"</span><span class="o">:</span><span class="w"> </span><span class="mf">262144</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_default_message_ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_default_message_delay"</span><span class="o">:</span><span class="w"> </span><span class="mf">30</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_dead_letter_queue"</span><span class="o">:</span><span class="w"> </span><span class="s2">"dead_letter"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_dead_letter_queue_messages_ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_max_claim_count"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_enable_encrypt_messages"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="s2">"description"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Queue for international traffic billing."</span> <span class="p">}</span> </pre></div> </div> <p>This operation does not return a response body.</p> </section> </section> <section class="detail-control" id="update-queue"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-queue" class="operation-anchor" href="#update-queue" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PATCH">PATCH</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Update queue</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-queue-detail" data-toggle="collapse" id="update-queue-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-queue-detail"> <p>Updates a queue.</p> <section id="id6"> <h3>Response codes<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id7"> <h3>Request Parameters<a class="headerlink" href="#id7" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> </tbody> </table> <p>When setting the request body of updating queue, the body must be a list which contains a series of json object which follows <a class="reference external" href="https://tools.ietf.org/html/draft-ietf-appsawg-json-patch-10">https://tools.ietf.org/html/draft-ietf-appsawg-json-patch-10</a>.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <ul class="simple"> <li><p>The “Content-Type” header should be “application/openstack-messaging-v2.0-json-patch”</p></li> <li><p>The ‘’path’’ must start with /metadata, for example, if the key is ‘’ttl’’, then the path should be /metadata/ttl</p></li> </ul> </div> </section> <section id="id8"> <h3>Request Example<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"op"</span><span class="o">:</span><span class="w"> </span><span class="s2">"replace"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"path"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/metadata/max_timeout"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"value"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span> <span class="w"> </span><span class="p">}</span> <span class="p">]</span> </pre></div> </div> </section> <section id="id9"> <h3>Response Example<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"max_timeout"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="show-queue-details"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-queue-details" class="operation-anchor" href="#show-queue-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">/v2/queues/<span class="path_parameter">{queue_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Show queue details</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-queue-details-detail" data-toggle="collapse" id="show-queue-details-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-queue-details-detail"> <p>Shows details for a queue.</p> <section id="id10"> <h3>Response codes<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id11"> <h3>Request Parameters<a class="headerlink" href="#id11" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> </tbody> </table> </section> <section id="id12"> <h3>Response Parameters<a class="headerlink" href="#id12" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>_max_messages_post_size</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The max post size of messages defined for a queue, which will effect for any messages posted to the queue. So user can define a queue’s level cap for post size which can’t bigger than the max_messages_post_size defined in zaqar.conf. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues. The value will be reverted to the default value after deleting it explicitly.</p></td> </tr> <tr class="row-odd"><td><p>_default_message_delay</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The delay of messages defined for a queue. When the messages send to the queue, it will be delayed for some times and means it can not be claimed until the delay expired. And user can define a queue’s level value for delay, also can define a message’s level. The latter has a higher priority. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar</p></td> </tr> <tr class="row-even"><td><p>_default_message_ttl</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The default TTL of messages defined for a queue, which will effect for any messages posted to the queue. So when there is no TTL defined for a message, the queue’s _default_message_ttl will be used. By default, the value is the same value defined as ‘’max_message_ttl’’ in zaqar.conf. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues. The value will be reverted to the default value after deleting it explicitly.</p></td> </tr> <tr class="row-odd"><td><p>_max_claim_count</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The max number the message can be claimed. Generally, it means the message cannot be processed successfully. There is no default value for this attribute. If it’s not set, then that means this feature won’t be enabled for current queue. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-even"><td><p>_dead_letter_queue</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The target the message will be moved to when the message can’t processed successfully after meet the max claim count. It’s not supported to add queue C as the dead letter queue for queue B where queue B has been set as a dead letter queue for queue A. There is no default value for this attribute. If it’s not set explicitly, then that means there is no dead letter queue for current queue. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code></p></td> </tr> <tr class="row-odd"><td><p>_dead_letter_queue_messages_ttl</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The new TTL setting for messages when moved to dead letter queue. If it’s not set, current TTL will be kept. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> <tr class="row-even"><td><p>_enable_encrypt_messages (Optional)</p></td> <td><p>body</p></td> <td><p>boolean</p></td> <td><p>The switch of encrypting messages for a queue, which will effect for any messages posted to the queue. By default, the value is False. It is one of the <code class="docutils literal notranslate"><span class="pre">reserved</span> <span class="pre">attributes</span></code> of Zaqar queues.</p></td> </tr> </tbody> </table> </section> <section id="id13"> <h3>Response Example<a class="headerlink" href="#id13" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"_max_messages_post_size"</span><span class="o">:</span><span class="w"> </span><span class="mf">262144</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_default_message_ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"description"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Queue used for billing."</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_max_claim_count"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_dead_letter_queue"</span><span class="o">:</span><span class="w"> </span><span class="s2">"dead_letter"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_dead_letter_queue_messages_ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"_enable_encrypt_messages"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="delete-queue"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-queue" class="operation-anchor" href="#delete-queue" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Delete queue</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-queue-detail" data-toggle="collapse" id="delete-queue-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-queue-detail"> <p>Deletes the specified queue.</p> <p>This operation immediately deletes a queue and all of its existing messages.</p> <p><code class="docutils literal notranslate"><span class="pre">queue_name</span></code> is the name that you give to the queue. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.</p> <section id="id14"> <h3>Response codes<a class="headerlink" href="#id14" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id15"> <h3>Request Parameters<a class="headerlink" href="#id15" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> </tbody> </table> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> <section class="detail-control" id="get-queue-stats"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="get-queue-stats" class="operation-anchor" href="#get-queue-stats" 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">/v2/queues/<span class="path_parameter">{queue_name}</span>/stats</div> <div class="row col-md-12"><p class="url-subtitle">Get queue stats</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#get-queue-stats-detail" data-toggle="collapse" id="get-queue-stats-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="get-queue-stats-detail"> <p>Returns statistics for the specified queue.</p> <p>This operation returns queue statistics, including how many messages are in the queue, categorized by status.</p> <p>If the value of the <code class="docutils literal notranslate"><span class="pre">total</span></code> attribute is 0, then <code class="docutils literal notranslate"><span class="pre">oldest</span></code> and <code class="docutils literal notranslate"><span class="pre">newest</span></code> message statistics are not included in the response.</p> <section id="id16"> <h3>Response codes<a class="headerlink" href="#id16" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id17"> <h3>Request Parameters<a class="headerlink" href="#id17" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> </tbody> </table> </section> <section id="id18"> <h3>Response Example<a class="headerlink" href="#id18" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"claimed"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total"</span><span class="o">:</span><span class="w"> </span><span class="mf">20</span><span class="p">,</span> <span class="w"> </span><span class="s2">"free"</span><span class="o">:</span><span class="w"> </span><span class="mf">10</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="pre-signed-queue"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="pre-signed-queue" class="operation-anchor" href="#pre-signed-queue" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-POST">POST</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/share</div> <div class="row col-md-12"><p class="url-subtitle">Pre-signed queue</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#pre-signed-queue-detail" data-toggle="collapse" id="pre-signed-queue-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="pre-signed-queue-detail"> <p>Create a pre-signed URL for a given queue.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>In the case of pre-signed URLs, the queue cannot be created lazily. This is to prevent cases where queues are deleted and users still have a valid URL. This is not a big issues in cases where there’s just 1 pool. However, if there’s a deployment using more than 1 type of pool, the lazily created queue may end up in an undesired pool and it’d be possible for an attacker to try a DoS on that pool. Therefore, whenever a pre-signed URL is created, if a pool doesn’t exist, it needs to be created.</p> </div> <section id="id19"> <h3>Response codes<a class="headerlink" href="#id19" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id20"> <h3>Request Parameters<a class="headerlink" href="#id20" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>paths (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of paths the pre-signed queue can support. It could be a set of <code class="docutils literal notranslate"><span class="pre">messages</span></code>, <code class="docutils literal notranslate"><span class="pre">subscriptions</span></code>, <code class="docutils literal notranslate"><span class="pre">claims</span></code>.</p></td> </tr> <tr class="row-even"><td><p>methods (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of HTTP methods. The HTTP method(s) this URL was created for. By selecting the HTTP method, it’s possible to give either read or read/write access to a specific resource.</p></td> </tr> <tr class="row-odd"><td><p>expires (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The time to indicate when the pre-signed will be expired.</p></td> </tr> </tbody> </table> </section> <section id="id21"> <h3>Request Example<a class="headerlink" href="#id21" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"paths"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"messages"</span><span class="p">,</span><span class="w"> </span><span class="s2">"claims"</span><span class="p">,</span><span class="w"> </span><span class="s2">"subscriptions"</span><span class="p">],</span> <span class="w"> </span><span class="s2">"methods"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"GET"</span><span class="p">,</span><span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span><span class="w"> </span><span class="s2">"PUT"</span><span class="p">,</span><span class="w"> </span><span class="s2">"PATCH"</span><span class="p">],</span> <span class="w"> </span><span class="s2">"expires"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2016-09-01T00:00:00"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id22"> <h3>Response Parameters<a class="headerlink" href="#id22" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>project</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The ID of current project/tenant.</p></td> </tr> <tr class="row-odd"><td><p>paths (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of paths the pre-signed queue can support. It could be a set of <code class="docutils literal notranslate"><span class="pre">messages</span></code>, <code class="docutils literal notranslate"><span class="pre">subscriptions</span></code>, <code class="docutils literal notranslate"><span class="pre">claims</span></code>.</p></td> </tr> <tr class="row-even"><td><p>methods (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of HTTP methods. The HTTP method(s) this URL was created for. By selecting the HTTP method, it’s possible to give either read or read/write access to a specific resource.</p></td> </tr> <tr class="row-odd"><td><p>expires (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The time to indicate when the pre-signed will be expired.</p></td> </tr> <tr class="row-even"><td><p>signature</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>The signature is generated after create the pre-signed URL. It can be consumed by adding below to HTTP headers:</p> <p>URL-Signature: 6a63d63242ebd18c3518871dda6fdcb6273db2672c599bf985469241e9a1c799 URL-Expires: 2015-05-31T19:00:17Z</p> </td> </tr> </tbody> </table> </section> <section id="id23"> <h3>Response Example<a class="headerlink" href="#id23" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"project"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2887aabf368046a3bb0070f1c0413470"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"paths"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"/v2/queues/test/messages"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"/v2/queues/test/claims"</span> <span class="w"> </span><span class="s2">"/v2/queues/test/subscriptions"</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"expires"</span><span class="o">:</span><span class="w"> </span><span class="s2">"2016-09-01T00:00:00"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"methods"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"GET"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"PATCH"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"POST"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"PUT"</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"signature"</span><span class="o">:</span><span class="w"> </span><span class="s2">"6a63d63242ebd18c3518871dda6fdcb6273db2672c599bf985469241e9a1c799"</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="purge-queue"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="purge-queue" class="operation-anchor" href="#purge-queue" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-POST">POST</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/purge</div> <div class="row col-md-12"><p class="url-subtitle">Purge queue</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#purge-queue-detail" data-toggle="collapse" id="purge-queue-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="purge-queue-detail"> <p>Purge particular resource of the queue.</p> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Now Zaqar supports to purge “messages” and “subscriptions” resource from a queue.</p> </div> <section id="id24"> <h3>Response codes<a class="headerlink" href="#id24" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id25"> <h3>Request Parameters<a class="headerlink" href="#id25" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>resource_types (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">resource_types</span></code> attribute allows user to purge particular resource of the queue.</p></td> </tr> </tbody> </table> </section> <section id="id26"> <h3>Request Example<a class="headerlink" href="#id26" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"resource_types"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"messages"</span><span class="p">,</span><span class="w"> </span><span class="s2">"subscriptions"</span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> </section> <section id="messages-messages"> <h1>Messages (messages)<a class="headerlink" href="#messages-messages" title="Link to this heading">¶</a></h1> <p>Message is sent through a queue and exists until it is deleted by a recipient or automatically by the system based on a TTL (time-to-live) value.</p> <p>All message-related operations require Client-Id to be included in the headers. This is to ensure that messages are not echoed back to the client that posted them unless the client explicitly requests this.</p> <section class="detail-control" id="post-message"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="post-message" class="operation-anchor" href="#post-message" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-POST">POST</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/messages</div> <div class="row col-md-12"><p class="url-subtitle">Post Message</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#post-message-detail" data-toggle="collapse" id="post-message-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="post-message-detail"> <p>Posts the message or messages for the specified queue.</p> <p>This operation posts the specified message or messages.</p> <p>You can submit up to 10 messages in a single request, but you must always encapsulate the messages in a collection container (an array in JSON, even for a single message - without the JSON array, you receive the “Invalid request body” message). The resulting value of the Location header or response body might be used to retrieve the created messages for further processing.</p> <p>The client specifies only the body and TTL for the message. The server inserts metadata, such as ID and age.</p> <p>The response body contains a list of resource paths that correspond to each message submitted in the request, in the order of the messages. If a server-side error occurs during the processing of the submitted messages, a partial list is returned, the partial attribute is set to true, and the client tries to post the remaining messages again. If the server cannot enqueue any messages, the server returns a <code class="docutils literal notranslate"><span class="pre">503</span> <span class="pre">Service</span> <span class="pre">Unavailable</span></code> error message.</p> <p>The <code class="docutils literal notranslate"><span class="pre">body</span></code> attribute specifies an arbitrary document that constitutes the body of the message being sent.</p> <p>.The following rules apply for the maximum size:</p> <p>The maximum size of posted messages is the maximum size of the entire request document (rather than the sum of the individual message body field values as it was in earlier releases). On error, the client will now be notified of how much it exceeded the limit.</p> <p>The size is limited to 256 KB, including whitespace.</p> <p>The document must be valid JSON. (The Message Queuing service validates it.)</p> <p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the server waits before marking the message as expired and removing it from the queue. The value of <code class="docutils literal notranslate"><span class="pre">ttl</span></code> must be between 60 and 1209600 seconds (14 days). Note that the server might not actually delete the message until its age has reached up to (ttl + 60) seconds, to allow for flexibility in storage implementations.</p> <p>The <code class="docutils literal notranslate"><span class="pre">delay</span></code> attribute specifies how long the message can be claimed. The value of <code class="docutils literal notranslate"><span class="pre">delay</span></code> must be between 0 and 900 seconds (15 mins).</p> <section id="id27"> <h3>Response codes<a class="headerlink" href="#id27" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id28"> <h3>Request Parameters<a class="headerlink" href="#id28" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> </tbody> </table> </section> <section id="id29"> <h3>Request Example<a class="headerlink" href="#id29" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span><span class="p">,</span> <span class="w"> </span><span class="s2">"delay"</span><span class="o">:</span><span class="w"> </span><span class="mf">20</span><span class="p">,</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupStarted"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"backup_id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"c378813c-3f0b-11e2-ad92-7823d2b0f3ce"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupProgress"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"current_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"0"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"99614720"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id30"> <h3>Response Parameters<a class="headerlink" href="#id30" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>resources (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the URL to messages.</p></td> </tr> </tbody> </table> </section> <section id="id31"> <h3>Response Example<a class="headerlink" href="#id31" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"resources"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"/v2/queues/demoqueue/messages/51db6f78c508f17ddc924357"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"/v2/queues/demoqueue/messages/51db6f78c508f17ddc924358"</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="list-messages"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-messages" class="operation-anchor" href="#list-messages" 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">/v2/queues/<span class="path_parameter">{queue_name}</span>/messages</div> <div class="row col-md-12"><p class="url-subtitle">List Messages</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-messages-detail" data-toggle="collapse" id="list-messages-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-messages-detail"> <p>List the messages in the specified queue.</p> <p>A request to list messages when the queue is not found or when messages are not found returns 204, instead of 200, because there was no information to send back. Messages with malformed IDs or messages that are not found by ID are ignored.</p> <p>This operation gets the message or messages in the specified queue.</p> <p>Message IDs and markers are opaque strings. Clients should make no assumptions about their format or length. Furthermore, clients should assume that there is no relationship between markers and message IDs (that is, one cannot be derived from the other). This allows for a wide variety of storage driver implementations.</p> <p>Results are ordered by age, oldest message first.</p> <section id="id32"> <h3>Response codes<a class="headerlink" href="#id32" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id33"> <h3>Request Parameters<a class="headerlink" href="#id33" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>marker (Optional)</p></td> <td><p>query</p></td> <td><p>string</p></td> <td><p>The ID of the last-seen item. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-even"><td><p>limit (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>Requests a page size of items. Returns a number of items up to a limit value. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-odd"><td><p>echo (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>Indicate if the messages can be echoed back to the client that posted them.</p></td> </tr> <tr class="row-even"><td><p>include_claimed (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>Indicate if the messages list should include the claimed messages.</p></td> </tr> <tr class="row-odd"><td><p>include_delayed (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>Indicate if the messages list should include the delayed messages.</p></td> </tr> </tbody> </table> </section> <section id="id34"> <h3>Response Parameters<a class="headerlink" href="#id34" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>messages</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the messages.</p></td> </tr> <tr class="row-odd"><td><p>links</p></td> <td><p>body</p></td> <td><p>array</p></td> <td><p>Links related to the queues. This is a list of dictionaries, each including keys <code class="docutils literal notranslate"><span class="pre">href</span></code> and <code class="docutils literal notranslate"><span class="pre">rel</span></code>.</p></td> </tr> </tbody> </table> </section> <section id="id35"> <h3>Response Example<a class="headerlink" href="#id35" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"current_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"0"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupProgress"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"99614720"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">482</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/beijing/messages/578edfe6508f153f256f717b"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"578edfe6508f153f256f717b"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"checksum"</span><span class="o">:</span><span class="w"> </span><span class="s2">"MD5:abf7213555626e29c3cb3e5dc58b3515"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"current_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"0"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupProgress"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"99614720"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">456</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/beijing/messages/578ee000508f153f256f717d"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"578ee000508f153f256f717d"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"checksum"</span><span class="o">:</span><span class="w"> </span><span class="s2">"MD5:abf7213555626e29c3cb3e5dc58b3515"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</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="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/beijing/messages?marker=17&echo=true"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="get-a-set-of-messages"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="get-a-set-of-messages" class="operation-anchor" href="#get-a-set-of-messages" 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">/v2/queues/<span class="path_parameter">{queue_name}</span>/messages</div> <div class="row col-md-12"><p class="url-subtitle">Get A Set Of Messages</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#get-a-set-of-messages-detail" data-toggle="collapse" id="get-a-set-of-messages-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="get-a-set-of-messages-detail"> <p>Gets a specified set of messages from the specified queue.</p> <p>This operation provides a more efficient way to query multiple messages compared to using a series of individual <code class="docutils literal notranslate"><span class="pre">GET</span></code> s. Note that the list of IDs cannot exceed 20. If a malformed ID or a nonexistent message ID is provided, it is ignored, and the remaining messages are returned.</p> <p>Unlike the Get Messages operation, a client’s own messages are always returned in this operation. If you use the ids parameter, the echo parameter is not used and is ignored if it is specified.</p> <p>The message attributes are defined as follows: <code class="docutils literal notranslate"><span class="pre">href</span></code> is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it. <code class="docutils literal notranslate"><span class="pre">ttl</span></code> is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds. <code class="docutils literal notranslate"><span class="pre">age</span></code> is the number of seconds relative to the server’s clock. <code class="docutils literal notranslate"><span class="pre">body</span></code> is the arbitrary document that was submitted with the original request to post the message. <code class="docutils literal notranslate"><span class="pre">checksum</span></code> is the hash digest of the <code class="docutils literal notranslate"><span class="pre">body</span></code>, default algorithm is MD5.</p> <section id="id36"> <h3>Response codes<a class="headerlink" href="#id36" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id37"> <h3>Request Parameters<a class="headerlink" href="#id37" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>ids (Optional)</p></td> <td><p>query</p></td> <td><p>list</p></td> <td><p>A list of the messages ids. <code class="docutils literal notranslate"><span class="pre">pop</span></code> & <code class="docutils literal notranslate"><span class="pre">ids</span></code> parameters are mutually exclusive. Using them together in a request will result in HTTP 400.</p> <p>NOTE: Actually, it’s not a real list, it’s string combined with many message ids separated with comma, for example: /messages?ids=578f0055508f153f256f717e,578f0055508f153f256f717f</p> </td> </tr> </tbody> </table> </section> <section id="id38"> <h3>Response Parameters<a class="headerlink" href="#id38" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>messages</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the messages.</p></td> </tr> </tbody> </table> </section> <section id="id39"> <h3>Response Example<a class="headerlink" href="#id39" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"current_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"0"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupProgress"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"99614720"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">443</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/beijing/messages/578f0055508f153f256f717f"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"578f0055508f153f256f717f"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="delete-a-set-of-messages"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-a-set-of-messages" class="operation-anchor" href="#delete-a-set-of-messages" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/messages</div> <div class="row col-md-12"><p class="url-subtitle">Delete A Set Of Messages</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-a-set-of-messages-detail" data-toggle="collapse" id="delete-a-set-of-messages-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-a-set-of-messages-detail"> <p>Provides a bulk delete for messages.</p> <p>This operation immediately deletes the specified messages. If any of the message IDs are malformed or non-existent, they are ignored. The remaining valid messages IDs are deleted. Please note that users should input either <code class="docutils literal notranslate"><span class="pre">ids</span></code> or <code class="docutils literal notranslate"><span class="pre">pop</span></code> parameter, otherwise this API will delete nothing. If <code class="docutils literal notranslate"><span class="pre">pop</span></code> is provided, the value must be at least 1 and may not be greater than <code class="docutils literal notranslate"><span class="pre">max_messages_per_claim_or_pop</span></code> in conf. If <code class="docutils literal notranslate"><span class="pre">ids</span></code> is provided, it should contain at least one id and not greater than <code class="docutils literal notranslate"><span class="pre">max_messages_per_page</span></code> in conf.</p> <section id="id40"> <h3>Response codes<a class="headerlink" href="#id40" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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> <tr class="row-odd"><td><code>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id41"> <h3>Request Parameters<a class="headerlink" href="#id41" title="Link to this heading">¶</a></h3> <p>This operation does not accept a request body.</p> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>ids (Optional)</p></td> <td><p>query</p></td> <td><p>list</p></td> <td><p>A list of the messages ids. <code class="docutils literal notranslate"><span class="pre">pop</span></code> & <code class="docutils literal notranslate"><span class="pre">ids</span></code> parameters are mutually exclusive. Using them together in a request will result in HTTP 400.</p> <p>NOTE: Actually, it’s not a real list, it’s string combined with many message ids separated with comma, for example: /messages?ids=578f0055508f153f256f717e,578f0055508f153f256f717f</p> </td> </tr> <tr class="row-even"><td><p>pop (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">pop</span></code> specifies how many messages will be popped up from the queue. <code class="docutils literal notranslate"><span class="pre">pop</span></code> & <code class="docutils literal notranslate"><span class="pre">ids</span></code> parameters are mutually exclusive. Using them together in a request will result in HTTP 400.</p></td> </tr> </tbody> </table> </section> <section id="id42"> <h3>Response Example<a class="headerlink" href="#id42" title="Link to this heading">¶</a></h3> <p>This operation only returns a response body when the <code class="docutils literal notranslate"><span class="pre">pop</span></code> query parameter is used.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"current_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"0"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupProgress"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"99614720"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">443</span><span class="p">,</span> <span class="w"> </span><span class="s2">"claim_count"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span><span class="p">,</span> <span class="w"> </span><span class="s2">"claim_id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"51db7067821e727dc24df754"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"578f0055508f153f256f717f"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="get-a-specific-message"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="get-a-specific-message" class="operation-anchor" href="#get-a-specific-message" 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">/v2/queues/<span class="path_parameter">{queue_name}</span>/messages/<span class="path_parameter">{message_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Get A Specific Message</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#get-a-specific-message-detail" data-toggle="collapse" id="get-a-specific-message-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="get-a-specific-message-detail"> <p>Gets the specified message from the specified queue.</p> <p>This operation gets the specified message from the specified queue.</p> <p>If either the message ID is malformed or nonexistent, no message is returned.</p> <p>Message fields are defined as follows: <code class="docutils literal notranslate"><span class="pre">href</span></code> is an opaque relative URI that the client can use to uniquely identify a message resource and interact with it. <code class="docutils literal notranslate"><span class="pre">ttl</span></code> is the TTL that was set on the message when it was posted. The message expires after (ttl - age) seconds. <code class="docutils literal notranslate"><span class="pre">age</span></code> is the number of seconds relative to the server’s clock. <code class="docutils literal notranslate"><span class="pre">body</span></code> is the arbitrary document that was submitted with the original request to post the message. <code class="docutils literal notranslate"><span class="pre">checksum</span></code> is the hash digest of the <code class="docutils literal notranslate"><span class="pre">body</span></code>, default algorithm is MD5.</p> <section id="id43"> <h3>Response codes<a class="headerlink" href="#id43" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id44"> <h3>Request Parameters<a class="headerlink" href="#id44" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>message_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The ID of the message.</p></td> </tr> </tbody> </table> </section> <section id="id45"> <h3>Response Example<a class="headerlink" href="#id45" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"current_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"0"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupProgress"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"total_bytes"</span><span class="o">:</span><span class="w"> </span><span class="s2">"99614720"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">1110</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/beijing/messages/578f0055508f153f256f717f"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"578f0055508f153f256f717f"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"checksum"</span><span class="o">:</span><span class="w"> </span><span class="s2">"MD5:abf7213555626e29c3cb3e5dc58b3515"</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="delete-a-specific-message"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-a-specific-message" class="operation-anchor" href="#delete-a-specific-message" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/messages/<span class="path_parameter">{message_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Delete A Specific Message</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-a-specific-message-detail" data-toggle="collapse" id="delete-a-specific-message-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-a-specific-message-detail"> <p>Deletes the specified message from the specified queue.</p> <p>This operation immediately deletes the specified message.</p> <p>The <code class="docutils literal notranslate"><span class="pre">claim_id</span></code> parameter specifies that the message is deleted only if it has the specified claim ID and that claim has not expired. This specification is useful for ensuring only one worker processes any given message. When a worker’s claim expires before it can delete a message that it has processed, the worker must roll back any actions it took based on that message because another worker can now claim and process the same message.</p> <p>If you do not specify <code class="docutils literal notranslate"><span class="pre">claim_id</span></code>, but the message is claimed, the operation fails. You can only delete claimed messages by providing an appropriate <code class="docutils literal notranslate"><span class="pre">claim_id</span></code>.</p> <section id="id46"> <h3>Response codes<a class="headerlink" href="#id46" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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"> <h3>Request<a class="headerlink" href="#request" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>message_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The ID of the message.</p></td> </tr> </tbody> </table> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> </section> <section id="claims-claims"> <h1>Claims (claims)<a class="headerlink" href="#claims-claims" title="Link to this heading">¶</a></h1> <p>Claim is a mechanism to mark messages so that other workers will not process the same message.</p> <section class="detail-control" id="claim-messages"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="claim-messages" class="operation-anchor" href="#claim-messages" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-POST">POST</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/claims</div> <div class="row col-md-12"><p class="url-subtitle">Claim messages</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#claim-messages-detail" data-toggle="collapse" id="claim-messages-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="claim-messages-detail"> <p>Claims a set of messages from the specified queue.</p> <p>This operation claims a set of messages (up to the value of the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter) from oldest to newest and skips any messages that are already claimed. If no unclaimed messages are available, the API returns a <code class="docutils literal notranslate"><span class="pre">204</span> <span class="pre">No</span> <span class="pre">Content</span></code> message.</p> <p>When a client (worker) finishes processing a message, it should delete the message before the claim expires to ensure that the message is processed only once. As part of the delete operation, workers should specify the claim ID (which is best done by simply using the provided href). If workers perform these actions, then if a claim simply expires, the server can return an error and notify the worker of the race condition. This action gives the worker a chance to roll back its own processing of the given message because another worker can claim the message and process it.</p> <p>The age given for a claim is relative to the server’s clock. The claim’s age is useful for determining how quickly messages are getting processed and whether a given message’s claim is about to expire.</p> <p>When a claim expires, it is released. If the original worker failed to process the message, another client worker can then claim the message.</p> <p>Note that claim creation is best-effort, meaning the worker may claim and return less than the requested number of messages.</p> <p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours). You must include a value for this attribute in your request.</p> <p>The <code class="docutils literal notranslate"><span class="pre">grace</span></code> attribute specifies the message grace period in seconds. The value of <code class="docutils literal notranslate"><span class="pre">grace</span></code> value must be between 60 and 43200 seconds (12 hours). You must include a value for this attribute in your request. To deal with workers that have stopped responding (for up to 1209600 seconds or 14 days, including claim lifetime), the server extends the lifetime of claimed messages to be at least as long as the lifetime of the claim itself, plus the specified grace period. If a claimed message would normally live longer than the claim’s live period, its expiration is not adjusted.</p> <section id="id47"> <h3>Response codes<a class="headerlink" href="#id47" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> <tr class="row-odd"><td><code>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id48"> <h3>Request Parameters<a class="headerlink" href="#id48" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>limit (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">limit</span></code> specifies up to 20 messages (configurable) to claim. If not specified, limit defaults to 10. Note that claim creation is best-effort, meaning the server may claim and return less than the requested number of messages.</p></td> </tr> <tr class="row-even"><td><p>ttl (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours). You must include a value for this attribute in your request.</p></td> </tr> <tr class="row-odd"><td><p>grace (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">grace</span></code> attribute specifies the message grace period in seconds. The value of <code class="docutils literal notranslate"><span class="pre">grace</span></code> value must be between 60 and 43200 seconds (12 hours). You must include a value for this attribute in your request. To deal with workers that have stopped responding (for up to 1209600 seconds or 14 days, including claim lifetime), the server extends the lifetime of claimed messages to be at least as long as the lifetime of the claim itself, plus the specified grace period. If a claimed message would normally live longer than the claim’s live period, its expiration is not adjusted.</p></td> </tr> </tbody> </table> <p><strong>Example Claim Messages: 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="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span><span class="p">,</span> <span class="w"> </span><span class="s2">"grace"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id49"> <h3>Response Parameters<a class="headerlink" href="#id49" title="Link to this heading">¶</a></h3> <p><strong>Example Claim Messages: JSON response</strong></p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupStarted"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">239</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/demoqueue/messages/51db6f78c508f17ddc924357?claim_id=51db7067821e727dc24df754"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span><span class="p">,</span> <span class="w"> </span><span class="s2">"checksum"</span><span class="o">:</span><span class="w"> </span><span class="s2">"MD5:82eb2714b7c0237d373947c046cac78d"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="query-claim"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="query-claim" class="operation-anchor" href="#query-claim" 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">/v2/queues/<span class="path_parameter">{queue_name}</span>/claims/<span class="path_parameter">{claim_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Query Claim</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#query-claim-detail" data-toggle="collapse" id="query-claim-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="query-claim-detail"> <p>Queries the specified claim for the specified queue.</p> <p>This operation queries the specified claim for the specified queue. Claims with malformed IDs or claims that are not found by ID are ignored.</p> <section id="id50"> <h3>Response codes<a class="headerlink" href="#id50" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id51"> <h3>Request Parameters<a class="headerlink" href="#id51" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>claim_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the claim.</p></td> </tr> </tbody> </table> </section> <section id="id52"> <h3>Response Parameters<a class="headerlink" href="#id52" title="Link to this heading">¶</a></h3> <p><strong>Example Query Claim: JSON response</strong></p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">57</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/demoqueue/claims/51db7067821e727dc24df754"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"messages"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"body"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"event"</span><span class="o">:</span><span class="w"> </span><span class="s2">"BackupStarted"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">296</span><span class="p">,</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/demoqueue/messages/51db6f78c508f17ddc924357?claim_id=51db7067821e727dc24df754"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="update-renew-claim"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-renew-claim" class="operation-anchor" href="#update-renew-claim" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PATCH">PATCH</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/claims/<span class="path_parameter">{claim_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Update(Renew) Claim</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-renew-claim-detail" data-toggle="collapse" id="update-renew-claim-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-renew-claim-detail"> <p>Updates the specified claim for the specified queue.</p> <p>This operation updates the specified claim for the specified queue. Claims with malformed IDs or claims that are not found by ID are ignored.</p> <p>Clients should periodically renew claims during long-running batches of work to avoid losing a claim while processing a message. The client can renew a claim by issuing a <code class="docutils literal notranslate"><span class="pre">PATCH</span></code> command to a specific claim resource and including a new TTL for the claim (which can be different from the original TTL). The server resets the age of the claim and applies the new TTL.</p> <section id="id53"> <h3>Response codes<a class="headerlink" href="#id53" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id54"> <h3>Request Parameters<a class="headerlink" href="#id54" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>claim_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the claim.</p></td> </tr> <tr class="row-even"><td><p>ttl (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the server waits before releasing the claim. The ttl value must be between 60 and 43200 seconds (12 hours). You must include a value for this attribute in your request.</p></td> </tr> <tr class="row-odd"><td><p>grace (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">grace</span></code> attribute specifies the message grace period in seconds. The value of <code class="docutils literal notranslate"><span class="pre">grace</span></code> value must be between 60 and 43200 seconds (12 hours). You must include a value for this attribute in your request. To deal with workers that have stopped responding (for up to 1209600 seconds or 14 days, including claim lifetime), the server extends the lifetime of claimed messages to be at least as long as the lifetime of the claim itself, plus the specified grace period. If a claimed message would normally live longer than the claim’s live period, its expiration is not adjusted.</p></td> </tr> </tbody> </table> <p><strong>Example Update Claim: 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="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span><span class="p">,</span> <span class="w"> </span><span class="s2">"grace"</span><span class="o">:</span><span class="w"> </span><span class="mf">300</span> <span class="p">}</span> </pre></div> </div> <p>This operation does not return a response body.</p> </section> </section> <section class="detail-control" id="delete-release-claim"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-release-claim" class="operation-anchor" href="#delete-release-claim" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/claims/<span class="path_parameter">{claim_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Delete(Release) Claim</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-release-claim-detail" data-toggle="collapse" id="delete-release-claim-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-release-claim-detail"> <p>Releases the specified claim for the specified queue.</p> <p>This operation immediately releases a claim, making any remaining, undeleted) messages that are associated with the claim available to other workers. Claims with malformed IDs or claims that are not found by ID are ignored.</p> <p>This operation is useful when a worker is performing a graceful shutdown, fails to process one or more messages, or is taking longer than expected to process messages, and wants to make the remainder of the messages available to other workers.</p> <section id="id55"> <h3>Response codes<a class="headerlink" href="#id55" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id56"> <h3>Request Parameters<a class="headerlink" href="#id56" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>claim_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the claim.</p></td> </tr> </tbody> </table> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> </section> <section id="subscriptions-subscriptions"> <h1>Subscriptions(subscriptions)<a class="headerlink" href="#subscriptions-subscriptions" title="Link to this heading">¶</a></h1> <p>Subscriptions are relationships between queue/topic and the targeted subscribers. After created subscriptions for a particular subscriber, like an email or a webhook, then when new messages posted to the queue, the subscriber will be notified automatically.</p> <section class="detail-control" id="list-subscriptions"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-subscriptions" class="operation-anchor" href="#list-subscriptions" 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">/v2/queues/<span class="path_parameter">{queue_name}</span>/subscriptions</div> <div class="row col-md-12"><p class="url-subtitle">List Subscriptions</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-subscriptions-detail" data-toggle="collapse" id="list-subscriptions-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-subscriptions-detail"> <p>Lists a queue’s subscriptions.</p> <p>This operation lists subscriptions for a queue. The subscriptions are sorted alphabetically by name.</p> <section id="id57"> <h3>Response codes<a class="headerlink" href="#id57" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id58"> <h3>Request Parameters<a class="headerlink" href="#id58" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> </tbody> </table> <section id="query-parameters"> <h4>Query Parameters<a class="headerlink" href="#query-parameters" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>limit (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>Requests a page size of items. Returns a number of items up to a limit value. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-odd"><td><p>marker (Optional)</p></td> <td><p>query</p></td> <td><p>string</p></td> <td><p>The ID of the last-seen item. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> </tbody> </table> </section> </section> <section id="id59"> <h3>Response Parameters<a class="headerlink" href="#id59" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>subscriptions (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the subscriptions.</p></td> </tr> <tr class="row-odd"><td><p>links</p></td> <td><p>body</p></td> <td><p>array</p></td> <td><p>Links related to the queues. This is a list of dictionaries, each including keys <code class="docutils literal notranslate"><span class="pre">href</span></code> and <code class="docutils literal notranslate"><span class="pre">rel</span></code>.</p></td> </tr> </tbody> </table> </section> <section id="id60"> <h3>Response Example<a class="headerlink" href="#id60" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</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="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/queues/test/subscriptions?marker=57692ab13990b48c644bb7e6"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"subscriptions"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">13</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"57692aa63990b48c644bb7e5"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"subscriber"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://10.229.49.117:5678"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"source"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">360</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="w"> </span><span class="p">{}</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">2</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"57692ab13990b48c644bb7e6"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"subscriber"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://10.229.49.117:5679"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"source"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">360</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="w"> </span><span class="p">{}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="create-subscription"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="create-subscription" class="operation-anchor" href="#create-subscription" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-POST">POST</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/subscriptions</div> <div class="row col-md-12"><p class="url-subtitle">Create Subscription</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#create-subscription-detail" data-toggle="collapse" id="create-subscription-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="create-subscription-detail"> <p>Creates a subscription.</p> <p>This operation creates a new subscription.</p> <section id="id61"> <h3>Response codes<a class="headerlink" href="#id61" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id62"> <h3>Request Parameters<a class="headerlink" href="#id62" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>subscriber</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">subscriber</span></code> attribute specifies the destination where the message notify to. It has been designed to match the Internet RFC on Relative Uniform Resource Locators. Zaqar now support two kinds of subscribers: http/https and email. The http/https subscriber should start with <code class="docutils literal notranslate"><span class="pre">http/https</span></code>. The email subscriber should start with <code class="docutils literal notranslate"><span class="pre">mailto</span></code>.</p></td> </tr> <tr class="row-even"><td><p>ttl (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the subscription be alive. The ttl value must be great than 60 seconds. The default value is 3600 seconds.</p></td> </tr> <tr class="row-odd"><td><p>options (Optional)</p></td> <td><p>body</p></td> <td><p>dict</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">options</span></code> attribute specifies the extra metadata for the subscription . The value must be a dict and could contain any key-value. If the subscriber is “mailto”. The <code class="docutils literal notranslate"><span class="pre">options</span></code> can contain <code class="docutils literal notranslate"><span class="pre">from</span></code> and <code class="docutils literal notranslate"><span class="pre">subject</span></code> to indicate the email’s author and title.</p></td> </tr> </tbody> </table> </section> <section id="id63"> <h3>Request Example<a class="headerlink" href="#id63" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"subscriber"</span><span class="o">:</span><span class="s2">"http://10.229.49.117:5679"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{}</span> <span class="p">}</span> </pre></div> </div> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"subscriber"</span><span class="o">:</span><span class="s2">"mailto:test@gmail.com"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"from"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Jack"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"subject"</span><span class="o">:</span><span class="w"> </span><span class="s2">"Hello"</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id64"> <h3>Response Parameters<a class="headerlink" href="#id64" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>subscription_id (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The id of the subscription.</p></td> </tr> </tbody> </table> </section> <section id="id65"> <h3>Response Example<a class="headerlink" href="#id65" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"subscription_id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"57692ab13990b48c644bb7e6"</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="update-subscription"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-subscription" class="operation-anchor" href="#update-subscription" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PATCH">PATCH</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/subscriptions/<span class="path_parameter">{subscription_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Update Subscription</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-subscription-detail" data-toggle="collapse" id="update-subscription-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-subscription-detail"> <p>Updates a subscription.</p> <section id="id66"> <h3>Response codes<a class="headerlink" href="#id66" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id67"> <h3>Request Parameters<a class="headerlink" href="#id67" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>subscription_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the subscription.</p></td> </tr> <tr class="row-even"><td><p>subscriber</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">subscriber</span></code> attribute specifies the destination where the message notify to. It has been designed to match the Internet RFC on Relative Uniform Resource Locators. Zaqar now support two kinds of subscribers: http/https and email. The http/https subscriber should start with <code class="docutils literal notranslate"><span class="pre">http/https</span></code>. The email subscriber should start with <code class="docutils literal notranslate"><span class="pre">mailto</span></code>.</p></td> </tr> <tr class="row-odd"><td><p>ttl (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the subscription be alive. The ttl value must be great than 60 seconds. The default value is 3600 seconds.</p></td> </tr> <tr class="row-even"><td><p>options (Optional)</p></td> <td><p>body</p></td> <td><p>dict</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">options</span></code> attribute specifies the extra metadata for the subscription . The value must be a dict and could contain any key-value. If the subscriber is “mailto”. The <code class="docutils literal notranslate"><span class="pre">options</span></code> can contain <code class="docutils literal notranslate"><span class="pre">from</span></code> and <code class="docutils literal notranslate"><span class="pre">subject</span></code> to indicate the email’s author and title.</p></td> </tr> </tbody> </table> </section> <section id="id68"> <h3>Request Example<a class="headerlink" href="#id68" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"subscriber"</span><span class="o">:</span><span class="s2">"http://10.229.49.117:1234"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="mf">360</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test"</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> <p>This operation does not return a response body.</p> </section> </section> <section class="detail-control" id="show-subscription-details"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-subscription-details" class="operation-anchor" href="#show-subscription-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">/v2/queues/<span class="path_parameter">{queue_name}</span>/subscriptions/<span class="path_parameter">{subscription_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Show Subscription Details</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-subscription-details-detail" data-toggle="collapse" id="show-subscription-details-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-subscription-details-detail"> <p>Shows details for a subscription.</p> <section id="id69"> <h3>Response codes<a class="headerlink" href="#id69" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id70"> <h3>Request Parameters<a class="headerlink" href="#id70" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>subscription_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the subscription.</p></td> </tr> </tbody> </table> </section> <section id="id71"> <h3>Response Parameters<a class="headerlink" href="#id71" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>age (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>How long the subscription has be existed.</p></td> </tr> <tr class="row-odd"><td><p>id (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The id of the subscription.</p></td> </tr> <tr class="row-even"><td><p>subscriber</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">subscriber</span></code> attribute specifies the destination where the message notify to. It has been designed to match the Internet RFC on Relative Uniform Resource Locators. Zaqar now support two kinds of subscribers: http/https and email. The http/https subscriber should start with <code class="docutils literal notranslate"><span class="pre">http/https</span></code>. The email subscriber should start with <code class="docutils literal notranslate"><span class="pre">mailto</span></code>.</p></td> </tr> <tr class="row-odd"><td><p>source (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The queue name which the subscription is registered on.</p></td> </tr> <tr class="row-even"><td><p>ttl (Optional)</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">ttl</span></code> attribute specifies how long the subscription be alive. The ttl value must be great than 60 seconds. The default value is 3600 seconds.</p></td> </tr> <tr class="row-odd"><td><p>options (Optional)</p></td> <td><p>body</p></td> <td><p>dict</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">options</span></code> attribute specifies the extra metadata for the subscription . The value must be a dict and could contain any key-value. If the subscriber is “mailto”. The <code class="docutils literal notranslate"><span class="pre">options</span></code> can contain <code class="docutils literal notranslate"><span class="pre">from</span></code> and <code class="docutils literal notranslate"><span class="pre">subject</span></code> to indicate the email’s author and title.</p></td> </tr> </tbody> </table> </section> <section id="id72"> <h3>Response Example<a class="headerlink" href="#id72" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"age"</span><span class="o">:</span><span class="w"> </span><span class="mf">1632</span><span class="p">,</span> <span class="w"> </span><span class="s2">"id"</span><span class="o">:</span><span class="w"> </span><span class="s2">"576b54963990b48c644bb7e7"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"subscriber"</span><span class="o">:</span><span class="w"> </span><span class="s2">"http://10.229.49.117:5679"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"source"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ttl"</span><span class="o">:</span><span class="w"> </span><span class="mf">3600</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test"</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="delete-subscription"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-subscription" class="operation-anchor" href="#delete-subscription" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/subscriptions/<span class="path_parameter">{subscription_id}</span></div> <div class="row col-md-12"><p class="url-subtitle">Delete Subscription</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-subscription-detail" data-toggle="collapse" id="delete-subscription-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-subscription-detail"> <p>Deletes the specified subscription.</p> <section id="id73"> <h3>Response codes<a class="headerlink" href="#id73" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id74"> <h3>Request Parameters<a class="headerlink" href="#id74" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>subscription_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the subscription.</p></td> </tr> </tbody> </table> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> <section class="detail-control" id="confirm-subscription"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="confirm-subscription" class="operation-anchor" href="#confirm-subscription" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-POST">POST</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/queues/<span class="path_parameter">{queue_name}</span>/subscriptions/<span class="path_parameter">{subscription_id}</span>/confirm</div> <div class="row col-md-12"><p class="url-subtitle">Confirm Subscription</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#confirm-subscription-detail" data-toggle="collapse" id="confirm-subscription-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="confirm-subscription-detail"> <p>Confirm a subscription.</p> <p>This operation can confirm or cancel a subscription.</p> <section id="id75"> <h3>Response codes<a class="headerlink" href="#id75" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id76"> <h3>Request Parameters<a class="headerlink" href="#id76" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>queue_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the queue.</p></td> </tr> <tr class="row-odd"><td><p>subscription_id</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The id of the subscription.</p></td> </tr> <tr class="row-even"><td><p>confirmed</p></td> <td><p>body</p></td> <td><p>boolean</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">confirmed</span></code> attribute specifies whether to confirm a subscription.</p></td> </tr> </tbody> </table> </section> <section id="id77"> <h3>Request Example<a class="headerlink" href="#id77" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"confirmed"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="p">}</span> </pre></div> </div> <p>This operation does not return a response body.</p> </section> </section> </section> <section id="health-health"> <h1>Health (health)<a class="headerlink" href="#health-health" title="Link to this heading">¶</a></h1> <p>With health API, user or operator can get a general idea about the status of Zaqar server. Those information can be used for basic validation, performance checking, etc.</p> <section class="detail-control" id="ping"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="ping" class="operation-anchor" href="#ping" 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">/v2/ping</div> <div class="row col-md-12"><p class="url-subtitle">Ping</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#ping-detail" data-toggle="collapse" id="ping-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="ping-detail"> <p>Simple health check for end user.</p> <p>A request to ping Zaqar server when server is working returns 204, otherwise returns 503. This can be a handy API for end user to check if the messaging service is in working status.</p> <section id="id78"> <h3>Response codes<a class="headerlink" href="#id78" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> <section class="detail-control" id="health"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="health" class="operation-anchor" href="#health" 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">/v2/health</div> <div class="row col-md-12"><p class="url-subtitle">Health</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#health-detail" data-toggle="collapse" id="health-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="health-detail"> <p>Detailed health check for cloud operator/admin.</p> <p>This is an <code class="docutils literal notranslate"><span class="pre">admin</span> <span class="pre">only</span></code> API. A request to get detailed health information of Zaqar server.</p> <p>The response body will depend on the storage setting of Zaqar server. By default, there is no pool created. Then the response body will only contain the <code class="docutils literal notranslate"><span class="pre">catalog_reachable</span></code>. Otherwise, the response body will have <code class="docutils literal notranslate"><span class="pre">catalog_reachable</span></code> and the health status for each pool.</p> <section id="id79"> <h3>Response codes<a class="headerlink" href="#id79" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</p></td> </tr> <tr class="row-even"><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="id80"> <h3>Response Parameters<a class="headerlink" href="#id80" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>catalog_reachable</p></td> <td><p>body</p></td> <td><p>boolean</p></td> <td><p>A boolean value to indicate if the management(catalog) datatabse is reachable or not.</p></td> </tr> <tr class="row-odd"><td><p>storage_reachable (Optional)</p></td> <td><p>body</p></td> <td><p>boolean</p></td> <td><p>A boolean value to indicate if the messages(pool) datatabse is reachable or not.</p></td> </tr> <tr class="row-even"><td><p>operation_status (Optional)</p></td> <td><p>body</p></td> <td><p>dict</p></td> <td><p>A dict which will contain the status for many different actions/operations. For example, post_messages, delete_messages, delete queue, etc. And each status is a dict which contains three items: <code class="docutils literal notranslate"><span class="pre">seconds</span></code>, <code class="docutils literal notranslate"><span class="pre">ref</span></code> and <code class="docutils literal notranslate"><span class="pre">succeeded</span></code>. Seconds means how long the operation took and succeeded will indicate if the actions was successful or not. Ref may contain the information if the succeeded is False, otherwise it’s null.</p></td> </tr> </tbody> </table> </section> <section id="id81"> <h3>Response Example<a class="headerlink" href="#id81" title="Link to this heading">¶</a></h3> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"catalog_reachable"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="s2">"redis"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"storage_reachable"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span> <span class="w"> </span><span class="s2">"operation_status"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"post_messages"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.027673959732055664</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"delete_messages"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.0028481483459472656</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"delete_queue"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.017709016799926758</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"bulk_delete_messages"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.03959178924560547</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"create_queue"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.021075963973999023</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"list_messages"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.00003504753112792969</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"delete_claim"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.0006170272827148438</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"claim_messages"</span><span class="o">:</span><span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"seconds"</span><span class="o">:</span><span class="w"> </span><span class="mf">0.008388042449951172</span><span class="p">,</span> <span class="w"> </span><span class="s2">"ref"</span><span class="o">:</span><span class="w"> </span><span class="kc">null</span><span class="p">,</span> <span class="w"> </span><span class="s2">"succeeded"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">}</span> <span class="p">}</span> </pre></div> </div> </section> </section> </section> <section id="pools-pools"> <h1>Pools (pools)<a class="headerlink" href="#pools-pools" title="Link to this heading">¶</a></h1> <p>If pooling is enabled, queuing service uses multiple queues databases in order to scale horizontally. A pool (queues database) can be added any time without stopping the service. Each pool has a weight that is assigned during the creation time but can be changed later. Pooling is done by queue which indicates that all messages for a particular queue can be found in the same pool (queues database).</p> <section class="detail-control" id="list-pools"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-pools" class="operation-anchor" href="#list-pools" 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">/v2/pools</div> <div class="row col-md-12"><p class="url-subtitle">List pools</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-pools-detail" data-toggle="collapse" id="list-pools-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-pools-detail"> <p>Lists pools.</p> <p>This operation lists pools for the project. The pools are sorted alphabetically by name.</p> <section id="id82"> <h3>Response codes<a class="headerlink" href="#id82" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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> </tbody> </table> </section> </section> <section id="id83"> <h3>Query Parameters<a class="headerlink" href="#id83" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>limit (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>Requests a page size of items. Returns a number of items up to a limit value. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-odd"><td><p>marker (Optional)</p></td> <td><p>query</p></td> <td><p>string</p></td> <td><p>The ID of the last-seen item. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-even"><td><p>detailed (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>The ‘detailed’ specifies if showing the detailed information when querying queues, flavors and pools.</p></td> </tr> </tbody> </table> </section> <section id="id84"> <h3>Response Parameters<a class="headerlink" href="#id84" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>pools (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the pools.</p></td> </tr> <tr class="row-odd"><td><p>links</p></td> <td><p>body</p></td> <td><p>array</p></td> <td><p>Links related to the pools. This is a list of dictionaries, each including keys <code class="docutils literal notranslate"><span class="pre">href</span></code> and <code class="docutils literal notranslate"><span class="pre">rel</span></code>.</p></td> </tr> </tbody> </table> </section> <section id="id85"> <h3>Response Example<a class="headerlink" href="#id85" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config flavor in stead of group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"pools"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">"poolflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">60</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://192.168.1.10:27017"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">"poolflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">40</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://192.168.1.20:27017"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</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="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools?marker=test_pool2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id86"> <h3>Response Example<a class="headerlink" href="#id86" title="Link to this heading">¶</a></h3> <p>NOTE: Remove group in Rocky release and use flavor instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"pools"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"poolgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">60</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://192.168.1.10:27017"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"poolgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">40</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://192.168.1.20:27017"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</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="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools?marker=test_pool2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="create-pool"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="create-pool" class="operation-anchor" href="#create-pool" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PUT">PUT</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/pools/<span class="path_parameter">{pool_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Create pool</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#create-pool-detail" data-toggle="collapse" id="create-pool-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="create-pool-detail"> <p>Creates a pool.</p> <p>This operation creates a new pool.</p> <p><code class="docutils literal notranslate"><span class="pre">pool_name</span></code> is the name that you give to the pool. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.</p> <section id="id87"> <h3>Response codes<a class="headerlink" href="#id87" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>409 - Conflict</code></td> <td><p>This resource has an action in progress that would conflict with this request.</p></td> </tr> </tbody> </table> </section> </section> <section id="id88"> <h3>Request Parameters<a class="headerlink" href="#id88" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>pool_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the pool.</p></td> </tr> <tr class="row-odd"><td><p>weight</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">weight</span></code> attribute specifies the likelihood that this pool will be selected for the next queue allocation. The value must be an integer greater than -1.</p></td> </tr> <tr class="row-even"><td><p>uri</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">uri</span></code> attribute specifies a connection string compatible with a storage client (e.g., pymongo) attempting to connect to that pool.</p></td> </tr> <tr class="row-odd"><td><p>group (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">group</span></code> attribute specifies a tag to given to more than one pool so that it keeps user remind the purpose/capabilities of all pools that falls under that group. NOTE: Remove group in Rocky release and use flavor instead for pool.</p></td> </tr> <tr class="row-even"><td><p>flavor (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">flavor</span></code> attribute specifies a tag to given to more than one pool so that it keeps user remind the purpose/capabilities of all pools that falls under that flavor. NOTE: Suggest config flavor in stead of group from the beginning of queen.</p></td> </tr> <tr class="row-odd"><td><p>options (Optional)</p></td> <td><p>body</p></td> <td><p>dict</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">options</span></code> attribute gives storage-specific options used by storage driver implementations. The value must be a dict and valid key-value come from the registered options for a given storage backend.</p></td> </tr> </tbody> </table> </section> <section id="id89"> <h3>Request Example<a class="headerlink" href="#id89" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config flavor in stead of group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"max_retry_sleep"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">"poolflavor"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id90"> <h3>Request Example<a class="headerlink" href="#id90" title="Link to this heading">¶</a></h3> <p>NOTE: Remove group in Rocky release and use flavor instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"max_retry_sleep"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"poolgroup"</span> <span class="p">}</span> </pre></div> </div> <p>This operation does not return a response body.</p> </section> </section> <section class="detail-control" id="update-pool"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-pool" class="operation-anchor" href="#update-pool" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PATCH">PATCH</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/pools/<span class="path_parameter">{pool_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Update pool</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-pool-detail" data-toggle="collapse" id="update-pool-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-pool-detail"> <p>Updates a pool.</p> <section id="id91"> <h3>Response codes<a class="headerlink" href="#id91" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</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="id92"> <h3>Request Parameters<a class="headerlink" href="#id92" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>pool_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the pool.</p></td> </tr> <tr class="row-odd"><td><p>weight</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">weight</span></code> attribute specifies the likelihood that this pool will be selected for the next queue allocation. The value must be an integer greater than -1.</p></td> </tr> <tr class="row-even"><td><p>uri</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">uri</span></code> attribute specifies a connection string compatible with a storage client (e.g., pymongo) attempting to connect to that pool.</p></td> </tr> <tr class="row-odd"><td><p>group (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">group</span></code> attribute specifies a tag to given to more than one pool so that it keeps user remind the purpose/capabilities of all pools that falls under that group. NOTE: Remove group in Rocky release and use flavor instead for pool.</p></td> </tr> <tr class="row-even"><td><p>flavor (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">flavor</span></code> attribute specifies a tag to given to more than one pool so that it keeps user remind the purpose/capabilities of all pools that falls under that flavor. NOTE: Suggest config flavor in stead of group from the beginning of queen.</p></td> </tr> <tr class="row-odd"><td><p>options (Optional)</p></td> <td><p>body</p></td> <td><p>dict</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">options</span></code> attribute gives storage-specific options used by storage driver implementations. The value must be a dict and valid key-value come from the registered options for a given storage backend.</p></td> </tr> </tbody> </table> </section> <section id="id93"> <h3>Request Example<a class="headerlink" href="#id93" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config flavor in stead of group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">60</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"max_retry_sleep"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">"newpoolflavor"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id94"> <h3>Response Example<a class="headerlink" href="#id94" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config flavor in stead of group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">"newpoolflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">60</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id95"> <h3>Request Example<a class="headerlink" href="#id95" title="Link to this heading">¶</a></h3> <p>NOTE: Remove group in Rocky release and use flavor instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">60</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"options"</span><span class="o">:</span><span class="p">{</span> <span class="w"> </span><span class="s2">"max_retry_sleep"</span><span class="o">:</span><span class="w"> </span><span class="mf">1</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"newpoolgroup"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id96"> <h3>Response Example<a class="headerlink" href="#id96" title="Link to this heading">¶</a></h3> <p>NOTE: Remove group in Rocky release and use flavor instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"newpoolgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">60</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="show-pool-details"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-pool-details" class="operation-anchor" href="#show-pool-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">/v2/pools/<span class="path_parameter">{pool_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Show pool details</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-pool-details-detail" data-toggle="collapse" id="show-pool-details-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-pool-details-detail"> <p>Shows details for a pool.</p> <section id="id97"> <h3>Response codes<a class="headerlink" href="#id97" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>503 - Service Unavailable</code></td> <td><p>The service cannot handle the request right now.</p></td> </tr> </tbody> </table> </section> </section> <section id="id98"> <h3>Request Parameters<a class="headerlink" href="#id98" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>pool_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the pool.</p></td> </tr> </tbody> </table> </section> <section id="id99"> <h3>Response Parameters<a class="headerlink" href="#id99" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>name (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The name of the pool.</p></td> </tr> <tr class="row-odd"><td><p>weight</p></td> <td><p>body</p></td> <td><p>integer</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">weight</span></code> attribute specifies the likelihood that this pool will be selected for the next queue allocation. The value must be an integer greater than -1.</p></td> </tr> <tr class="row-even"><td><p>uri</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">uri</span></code> attribute specifies a connection string compatible with a storage client (e.g., pymongo) attempting to connect to that pool.</p></td> </tr> <tr class="row-odd"><td><p>group (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">group</span></code> attribute specifies a tag to given to more than one pool so that it keeps user remind the purpose/capabilities of all pools that falls under that group. NOTE: Remove group in Rocky release and use flavor instead for pool.</p></td> </tr> <tr class="row-even"><td><p>flavor (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">flavor</span></code> attribute specifies a tag to given to more than one pool so that it keeps user remind the purpose/capabilities of all pools that falls under that flavor. NOTE: Suggest config flavor in stead of group from the beginning of queen.</p></td> </tr> <tr class="row-odd"><td><p>href (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The url of the pool.</p></td> </tr> </tbody> </table> </section> <section id="id100"> <h3>Response Example<a class="headerlink" href="#id100" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config flavor in stead of group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testpoolflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id101"> <h3>Response Example<a class="headerlink" href="#id101" title="Link to this heading">¶</a></h3> <p>NOTE: Remove group in Rocky release and use flavor instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/pools/test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testpoolgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"flavor"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_pool"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"weight"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span><span class="p">,</span> <span class="w"> </span><span class="s2">"uri"</span><span class="o">:</span><span class="w"> </span><span class="s2">"mongodb://127.0.0.1:27017"</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="delete-pool"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-pool" class="operation-anchor" href="#delete-pool" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/pools/<span class="path_parameter">{pool_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Delete pool</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-pool-detail" data-toggle="collapse" id="delete-pool-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-pool-detail"> <p>Deletes the specified pool.</p> <p>This operation immediately deletes a pool.</p> <p><code class="docutils literal notranslate"><span class="pre">pool_name</span></code> is the name that you give to the pool. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.</p> <section id="id102"> <h3>Response codes<a class="headerlink" href="#id102" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</p></td> </tr> <tr class="row-even"><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="id103"> <h3>Request Parameters<a class="headerlink" href="#id103" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>pool_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the pool.</p></td> </tr> </tbody> </table> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> </section> <section id="flavors-flavors"> <h1>Flavors (flavors)<a class="headerlink" href="#flavors-flavors" title="Link to this heading">¶</a></h1> <p>Queue flavors allow users to have different types of queues based on the storage capabilities. By using flavors, it’s possible to allow consumers of the service to choose between durable storage, fast storage, etc. Flavors must be created by service administrators and they rely on the existence of pools.</p> <section class="detail-control" id="list-flavors"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-flavors" class="operation-anchor" href="#list-flavors" 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">/v2/flavors</div> <div class="row col-md-12"><p class="url-subtitle">List flavors</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-flavors-detail" data-toggle="collapse" id="list-flavors-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-flavors-detail"> <p>Lists flavors.</p> <p>This operation lists flavors for the project. The flavors are sorted alphabetically by name.</p> <section id="id104"> <h3>Response codes<a class="headerlink" href="#id104" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><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="id105"> <h3>Query Parameters<a class="headerlink" href="#id105" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>limit (Optional)</p></td> <td><p>query</p></td> <td><p>integer</p></td> <td><p>Requests a page size of items. Returns a number of items up to a limit value. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-odd"><td><p>marker (Optional)</p></td> <td><p>query</p></td> <td><p>string</p></td> <td><p>The ID of the last-seen item. Use the <code class="docutils literal notranslate"><span class="pre">limit</span></code> parameter to make an initial limited request and use the ID of the last-seen item from the response as the <code class="docutils literal notranslate"><span class="pre">marker</span></code> parameter value in a subsequent limited request.</p></td> </tr> <tr class="row-even"><td><p>detailed (Optional)</p></td> <td><p>query</p></td> <td><p>boolean</p></td> <td><p>The ‘detailed’ specifies if showing the detailed information when querying queues, flavors and pools.</p></td> </tr> </tbody> </table> </section> <section id="id106"> <h3>Response Parameters<a class="headerlink" href="#id106" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>flavors (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of the flaovrs.</p></td> </tr> <tr class="row-odd"><td><p>links</p></td> <td><p>body</p></td> <td><p>array</p></td> <td><p>Links related to the flavors. This is a list of dictionaries, each including keys <code class="docutils literal notranslate"><span class="pre">href</span></code> and <code class="docutils literal notranslate"><span class="pre">rel</span></code>.</p></td> </tr> </tbody> </table> </section> <section id="id107"> <h3>Response Example<a class="headerlink" href="#id107" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"flavors"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/test_flavor1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">"[testpool1, testpool2]"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_flavor1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/test_flavor2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">"[testpool3, testpool4]"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_flavor2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</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="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors?marker=test_flavor2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id108"> <h3>Response Example<a class="headerlink" href="#id108" title="Link to this heading">¶</a></h3> <p>NOTE: Remove pool_group in Rocky release and use pool_list instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"flavors"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/test_flavor1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_flavor1"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span> <span class="w"> </span><span class="p">},</span> <span class="w"> </span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/test_flavor2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"test_flavor2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">],</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="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors?marker=test_flavor2"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"rel"</span><span class="o">:</span><span class="w"> </span><span class="s2">"next"</span> <span class="w"> </span><span class="p">}</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="create-flavor"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="create-flavor" class="operation-anchor" href="#create-flavor" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PUT">PUT</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/flavors/<span class="path_parameter">{flavor_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Create flavor</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#create-flavor-detail" data-toggle="collapse" id="create-flavor-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="create-flavor-detail"> <p>Creates a flavor.</p> <p>This operation creates a new flavor.</p> <p><code class="docutils literal notranslate"><span class="pre">flavor_name</span></code> is the name that you give to the flavor. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.</p> <section id="id109"> <h3>Response codes<a class="headerlink" href="#id109" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>201 - Created</code></td> <td><p>Request has been fulfilled and new resource created.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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> </tbody> </table> </section> </section> <section id="id110"> <h3>Request Parameters<a class="headerlink" href="#id110" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>flavor_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the flavor.</p></td> </tr> <tr class="row-odd"><td><p>pool_group</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">pool_group</span></code> attribute specifies the name of the pool group this flavor sits on top of. NOTE: Remove pool_group in Rocky release and use pool_list instead for flavor.</p></td> </tr> <tr class="row-even"><td><p>pool_list (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of pools in the flavor. NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p></td> </tr> </tbody> </table> </section> <section id="id111"> <h3>Request Example<a class="headerlink" href="#id111" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">"[testpool1, testpool2]"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id112"> <h3>Request Example<a class="headerlink" href="#id112" title="Link to this heading">¶</a></h3> <p>NOTE: Remove pool_group in Rocky release and use pool_list instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span> <span class="p">}</span> </pre></div> </div> <p>This operation does not return a response body.</p> </section> </section> <section class="detail-control" id="update-flavor"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-flavor" class="operation-anchor" href="#update-flavor" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-PATCH">PATCH</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/flavors/<span class="path_parameter">{flavor_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Update flavor</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-flavor-detail" data-toggle="collapse" id="update-flavor-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-flavor-detail"> <p>Updates a flavor.</p> <section id="id113"> <h3>Response codes<a class="headerlink" href="#id113" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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> <section id="id114"> <h3>Request Parameters<a class="headerlink" href="#id114" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>flavor_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the flavor.</p></td> </tr> <tr class="row-odd"><td><p>pool_group</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">pool_group</span></code> attribute specifies the name of the pool group this flavor sits on top of. NOTE: Remove pool_group in Rocky release and use pool_list instead for flavor.</p></td> </tr> <tr class="row-even"><td><p>pool_list (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of pools in the flavor. NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p></td> </tr> </tbody> </table> </section> <section id="id115"> <h3>Request Example<a class="headerlink" href="#id115" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">"[testpool1, testpool3]"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id116"> <h3>Response Example<a class="headerlink" href="#id116" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/testflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">"[testpool1, testpool3]"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"capabilities"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"FIFO"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"CLAIMS"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"DURABILITY"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"AOD"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"HIGH_THROUGHPUT"</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id117"> <h3>Request Example<a class="headerlink" href="#id117" title="Link to this heading">¶</a></h3> <p>NOTE: Remove pool_group in Rocky release and use pool_list instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id118"> <h3>Response Example<a class="headerlink" href="#id118" title="Link to this heading">¶</a></h3> <p>NOTE: Remove pool_group in Rocky release and use pool_list instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/testflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"capabilities"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"FIFO"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"CLAIMS"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"DURABILITY"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"AOD"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"HIGH_THROUGHPUT"</span> <span class="w"> </span><span class="p">]</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="show-flavor-details"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-flavor-details" class="operation-anchor" href="#show-flavor-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">/v2/flavors/<span class="path_parameter">{flavor_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Show flavor details</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-flavor-details-detail" data-toggle="collapse" id="show-flavor-details-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-flavor-details-detail"> <p>Shows details for a flavor.</p> <section id="id119"> <h3>Response codes<a class="headerlink" href="#id119" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>404 - Not Found</code></td> <td><p>The requested resource could not be found.</p></td> </tr> <tr class="row-even"><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="id120"> <h3>Request Parameters<a class="headerlink" href="#id120" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>flavor_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the flavor.</p></td> </tr> </tbody> </table> </section> <section id="id121"> <h3>Response Parameters<a class="headerlink" href="#id121" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>name</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The name of the flavor.</p></td> </tr> <tr class="row-odd"><td><p>capabilities (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>Capabilities describe what this flavor is capable of base on the storage capabilities. They are used to inform the final user such capabilities.</p></td> </tr> <tr class="row-even"><td><p>pool_group</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The <code class="docutils literal notranslate"><span class="pre">pool_group</span></code> attribute specifies the name of the pool group this flavor sits on top of. NOTE: Remove pool_group in Rocky release and use pool_list instead for flavor.</p></td> </tr> <tr class="row-odd"><td><p>pool_list (Optional)</p></td> <td><p>body</p></td> <td><p>list</p></td> <td><p>A list of pools in the flavor. NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p></td> </tr> <tr class="row-even"><td><p>href (Optional)</p></td> <td><p>body</p></td> <td><p>string</p></td> <td><p>The url of the flavor.</p></td> </tr> </tbody> </table> </section> <section id="id122"> <h3>Response Example<a class="headerlink" href="#id122" title="Link to this heading">¶</a></h3> <p>NOTE: Suggest config pool_list in stead of pool_group from the beginning of Queens.</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/testflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"capabilities"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"FIFO"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"CLAIMS"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"DURABILITY"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"AOD"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"HIGH_THROUGHPUT"</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">"[testpool1, testpool2]"</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testflavor"</span> <span class="p">}</span> </pre></div> </div> </section> <section id="id123"> <h3>Response Example<a class="headerlink" href="#id123" title="Link to this heading">¶</a></h3> <p>NOTE: Remove pool_group in Rocky release and use pool_list instead for pool</p> <div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="w"> </span><span class="s2">"href"</span><span class="o">:</span><span class="w"> </span><span class="s2">"/v2/flavors/testflavor"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"capabilities"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span> <span class="w"> </span><span class="s2">"FIFO"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"CLAIMS"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"DURABILITY"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"AOD"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"HIGH_THROUGHPUT"</span> <span class="w"> </span><span class="p">],</span> <span class="w"> </span><span class="s2">"pool_group"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testgroup"</span><span class="p">,</span> <span class="w"> </span><span class="s2">"pool_list"</span><span class="o">:</span><span class="w"> </span><span class="s2">""</span> <span class="w"> </span><span class="s2">"name"</span><span class="o">:</span><span class="w"> </span><span class="s2">"testflavor"</span> <span class="p">}</span> </pre></div> </div> </section> </section> <section class="detail-control" id="delete-flavor"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-flavor" class="operation-anchor" href="#delete-flavor" onclick="window.location.hash = hash;" > <span class="glyphicon glyphicon-link"></span></a> <span class="label label-DELETE">DELETE</span> </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v2/flavors/<span class="path_parameter">{flavor_name}</span></div> <div class="row col-md-12"><p class="url-subtitle">Delete flavor</p></div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-flavor-detail" data-toggle="collapse" id="delete-flavor-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-flavor-detail"> <p>Deletes the specified flavor.</p> <p>This operation immediately deletes a flavor.</p> <p><code class="docutils literal notranslate"><span class="pre">flavor_name</span></code> is the name that you give to the flavor. The name must not exceed 64 bytes in length, and it is limited to US-ASCII letters, digits, underscores, and hyphens.</p> <section id="id124"> <h3>Response codes<a class="headerlink" href="#id124" title="Link to this heading">¶</a></h3> <section id="Success"> <h4>Success<a class="headerlink" href="#Success" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>204 - No Content</code></td> <td><p>Request fulfilled but service does not return anything.</p></td> </tr> </tbody> </table> </section> <section id="Error"> <h4>Error<a class="headerlink" href="#Error" title="Link to this heading">¶</a></h4> <table class="docutils align-default"> <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>401 - Unauthorized</code></td> <td><p>User must authenticate before making a request.</p></td> </tr> <tr class="row-odd"><td><code>403 - Forbidden</code></td> <td><p>Policy does not allow current user to do this operation.</p></td> </tr> <tr class="row-even"><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="id125"> <h3>Request Parameters<a class="headerlink" href="#id125" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <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>flavor_name</p></td> <td><p>path</p></td> <td><p>string</p></td> <td><p>The name of the flavor.</p></td> </tr> </tbody> </table> <p>This operation does not accept a request body and does not return a response body.</p> </section> </section> </section> </div> </div> </div> <div class="docs-actions"> <a id="logABugLink3" href="" target="_blank" title="Found an error? Report a bug against this page"><i class="fa fa-bug" data-toggle="tooltip" data-placement="top" title="Report a Bug"></i></a> </div> <div class="row docs-byline bottom"> <div class="docs-updated">this page last updated: 2021-06-15 10:11:51</div> </div> <div class="row"> <div class="col-lg-8 col-md-8 col-sm-8 docs-license"> <a href="https://creativecommons.org/licenses/by/3.0/"> <img src="_static/images/docs/license.png" alt="Creative Commons Attribution 3.0 License"/> </a> <p> Except where otherwise noted, this document is licensed under <a href="https://creativecommons.org/licenses/by/3.0/">Creative Commons Attribution 3.0 License</a>. See all <a href="https://www.openstack.org/legal"> OpenStack Legal Documents</a>. </p> </div> <div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper">  <a href="#" id="logABugLink2" class="docs-footer-actions"><i class="fa fa-bug"></i> found an error? report a bug</a> </div> </div> </div> <div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar"> <div class="btn-group docs-sidebar-releases"> <button onclick="location.href='/'" class="btn docs-sidebar-home" data-toggle="tooltip" data-placement="top" title="OpenStack Docs Home"><i class="fa fa-arrow-circle-o-left"></i></button> <button type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation<i class="fa fa-caret-down"></i></button> <ul class="dropdown-menu docs-sidebar-dropdown" role="menu"> <li role="presentation" class="dropdown-header">Guides</li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#install-guides">Install Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#user-guides">User Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#configuration-guides">Configuration Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#ops-and-admin-guides">Operations and Administration Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#api-guides">API Guides</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/index.html#contributor-guides">Contributor Guides</a></li> <li role="presentation" class="dropdown-header">Languages</li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/de/">Deutsch (German)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/fr/">Français (French)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/id/">Bahasa Indonesia (Indonesian)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/it/">Italiano (Italian)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ja/">日本語 (Japanese)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/ko_KR/">한국어 (Korean)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/pt_BR/">Português (Portuguese)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/tr_TR/">Türkçe (Türkiye)</a></li> <li role="presentation"><a role="menuitem" tabindex="-1" href="https://docs.openstack.org/zh_CN/">简体中文 (Simplified Chinese)</a></li> </ul> </div> <div class="docs-sidebar-toc"> <div class="docs-sidebar-section" id="table-of-contents"> <a href="#" class="docs-sidebar-section-title"><h4>zaqar </h4></a> <ul> <li><a class="reference internal" href="#">Messaging Service API v2</a></li> <li><a class="reference internal" href="#api-versions">API Versions</a><ul> <li><a class="reference internal" href="#list-major-versions">List major versions</a></li> </ul> </li> <li><a class="reference internal" href="#queues-queues">Queues (queues)</a><ul> <li><a class="reference internal" href="#list-queues">List queues</a></li> <li><a class="reference internal" href="#create-queue">Create queue</a></li> <li><a class="reference internal" href="#update-queue">Update queue</a></li> <li><a class="reference internal" href="#show-queue-details">Show queue details</a></li> <li><a class="reference internal" href="#delete-queue">Delete queue</a></li> <li><a class="reference internal" href="#get-queue-stats">Get queue stats</a></li> <li><a class="reference internal" href="#pre-signed-queue">Pre-signed queue</a></li> <li><a class="reference internal" href="#purge-queue">Purge queue</a></li> </ul> </li> <li><a class="reference internal" href="#messages-messages">Messages (messages)</a><ul> <li><a class="reference internal" href="#post-message">Post Message</a></li> <li><a class="reference internal" href="#list-messages">List Messages</a></li> <li><a class="reference internal" href="#get-a-set-of-messages">Get A Set Of Messages</a></li> <li><a class="reference internal" href="#delete-a-set-of-messages">Delete A Set Of Messages</a></li> <li><a class="reference internal" href="#get-a-specific-message">Get A Specific Message</a></li> <li><a class="reference internal" href="#delete-a-specific-message">Delete A Specific Message</a></li> </ul> </li> <li><a class="reference internal" href="#claims-claims">Claims (claims)</a><ul> <li><a class="reference internal" href="#claim-messages">Claim messages</a></li> <li><a class="reference internal" href="#query-claim">Query Claim</a></li> <li><a class="reference internal" href="#update-renew-claim">Update(Renew) Claim</a></li> <li><a class="reference internal" href="#delete-release-claim">Delete(Release) Claim</a></li> </ul> </li> <li><a class="reference internal" href="#subscriptions-subscriptions">Subscriptions(subscriptions)</a><ul> <li><a class="reference internal" href="#list-subscriptions">List Subscriptions</a></li> <li><a class="reference internal" href="#create-subscription">Create Subscription</a></li> <li><a class="reference internal" href="#update-subscription">Update Subscription</a></li> <li><a class="reference internal" href="#show-subscription-details">Show Subscription Details</a></li> <li><a class="reference internal" href="#delete-subscription">Delete Subscription</a></li> <li><a class="reference internal" href="#confirm-subscription">Confirm Subscription</a></li> </ul> </li> <li><a class="reference internal" href="#health-health">Health (health)</a><ul> <li><a class="reference internal" href="#ping">Ping</a></li> <li><a class="reference internal" href="#health">Health</a></li> </ul> </li> <li><a class="reference internal" href="#pools-pools">Pools (pools)</a><ul> <li><a class="reference internal" href="#list-pools">List pools</a></li> <li><a class="reference internal" href="#create-pool">Create pool</a></li> <li><a class="reference internal" href="#update-pool">Update pool</a></li> <li><a class="reference internal" href="#show-pool-details">Show pool details</a></li> <li><a class="reference internal" href="#delete-pool">Delete pool</a></li> </ul> </li> <li><a class="reference internal" href="#flavors-flavors">Flavors (flavors)</a><ul> <li><a class="reference internal" href="#list-flavors">List flavors</a></li> <li><a class="reference internal" href="#create-flavor">Create flavor</a></li> <li><a class="reference internal" href="#update-flavor">Update flavor</a></li> <li><a class="reference internal" href="#show-flavor-details">Show flavor details</a></li> <li><a class="reference internal" href="#delete-flavor">Delete flavor</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> <footer> <div class="container"> <div class="row footer-links"> <div class="col-lg-2 col-sm-2"> <h3>OpenStack</h3> <ul> <li><a href="https://www.openstack.org/software/project-navigator/">Projects</a></li> <li><a href="https://security.openstack.org/">OpenStack Security</a></li> <li><a href="https://openstack.org/blog/">Blog</a></li> <li><a href="https://openstack.org/news/">News</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Community</h3> <ul> <li><a href="https://www.meetup.com/pro/openinfradev/">User Groups</a></li> <li><a href="https://openstack.org/community/events/">Events</a></li> <li><a href="https://openstack.org/community/jobs/">Jobs</a></li> <li><a href="https://openinfra.dev/members/">Companies</a></li> <li><a href="https://docs.openstack.org/contributors">Contribute</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Documentation</h3> <ul> <li><a href="https://docs.openstack.org">OpenStack Manuals</a></li> <li><a href="https://openstack.org/software/start/">Getting Started</a></li> <li><a href="https://developer.openstack.org">API Documentation</a></li> <li><a href="https://wiki.openstack.org">Wiki</a></li> </ul> </div> <div class="col-lg-2 col-sm-2"> <h3>Branding & Legal</h3> <ul> <li><a href="https://openinfra.dev/legal">Legal Docs</a></li> <li><a href="https://openstack.org/brand/">Logos & Guidelines</a></li> <li><a href="https://openinfra.dev/legal/trademark-policy">Trademark Policy</a></li> <li><a href="https://openinfra.dev/privacy-policy">Privacy Policy</a></li> <li><a href="https://docs.openstack.org/contributors/common/setup-gerrit.html#individual-contributor-license-agreement">OpenInfra CLA</a></li> </ul> </div> <div class="col-lg-4 col-sm-4"> <h3>Stay In Touch</h3> <a href="https://twitter.com/OpenStack" target="_blank" class="social-icons footer-twitter"></a> <a href="https://www.facebook.com/openinfradev" target="_blank" class="social-icons footer-facebook"></a> <a href="https://www.linkedin.com/company/open-infrastructure-foundation" target="_blank" class="social-icons footer-linkedin"></a> <a href="https://www.youtube.com/user/OpenStackFoundation" target="_blank" class="social-icons footer-youtube"></a> <p class="fine-print"> The OpenStack project is provided under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0 license</a>. Docs.openstack.org is powered by <a href="https://rackspace.com" target="_blank">Rackspace Cloud Computing</a>. </p> </div> </div> </div> </footer>  <script src="_static/js/jquery-3.2.1.min.js"></script>  <script src="_static/js/bootstrap.min.js"></script>  <script src="_static/js/navigation.js"></script>  <script src="_static/js/docs.js"></script>  <script> /* Build a description of this page including SHA, source location on git * repo, build time and the project's launchpad bug tag. Set the HREF of the * bug buttons */ var lineFeed = "%0A"; var gitURL = "Source: Can't derive source file URL"; /* there have been cases where "pagename" wasn't set; better check for it */ /* "giturl" is the URL of the source file on Git and is auto-generated by * openstackdocstheme. * * "pagename" is a standard sphinx parameter containing the name of * the source file, without extension. */ var sourceFile = "index" + ".rst"; gitURL = "Source: https://opendev.org/openstack/zaqar/src/api-ref/source" + "/" + sourceFile; /* gitsha, project and bug_tag rely on variables in conf.py */ var gitSha = "SHA: 486fa3d09c39589b8afd0fb7e409207800a5451a"; var repositoryName = "openstack/zaqar"; var bugProject = "zaqar"; var bugTitle = "Messaging Service API v2 in zaqar"; var fieldTags = "api-ref"; var useStoryboard = ""; /* "last_updated" is the build date and time. It relies on the conf.py variable "html_last_updated_fmt", which should include year/month/day as well as hours and minutes */ var buildstring = "Release: on 2021-06-15 10:11:51"; var fieldComment = encodeURI(buildstring) + lineFeed + encodeURI(gitSha) + lineFeed + encodeURI(gitURL) ; logABug(bugTitle, bugProject, fieldComment, fieldTags, repositoryName, useStoryboard); </script> </body> </html>