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>Watcher API — Infrastructure Optimization API Reference documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fe63c2af" /> <link rel="stylesheet" type="text/css" href="_static/basic.css?v=5c69cfe2" /> <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=9bcbadda"></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"> Toggle navigation </button> <div class="brand-wrapper"> <a class="navbar-brand" href="https://www.openstack.org/"></a> </div> <div class="search-icon show"> 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 </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 </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 </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 </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 </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 </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>Watcher API</h1> </div> <div class="docs-actions"> <a id="logABugLink1" href="" target="_blank" title="Found an error? Report a bug against this page"></a> </div> </div> <div class="row"> <div class="col-lg-12"> <div class="docs-body" role="main"> <section id="watcher-api"> <h1>Watcher API<a class="headerlink" href="#watcher-api" title="Link to this heading">¶</a></h1> <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> In order to bring new features to users over time, the Watcher API supports versioning. There are two kinds of versions in Watcher. <ul class="simple"> <li>‘’major versions’’, which have dedicated URLs.</li> <li>‘’microversions’’, which can be requested using the <code class="docutils literal notranslate">OpenStack-API-Version</code> header.</li> </ul> <div class="admonition note"> Note The maximum microversion depends on release. Please reference: <a class="reference external" href="https://docs.openstack.org/watcher/latest/contributor/api_microversion_history.html">API Microversion History</a> for API microversion history details. </div> The Version API resource works differently from other API resources as they do not require authentication. If Watcher receives a request with unsupported version, it responds with a 406 Not Acceptable, along with the -Min- and -Max- headers that it can support. <section class="detail-control" id="list-api-versions"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-api-versions" class="operation-anchor" href="#list-api-versions" onclick="window.location.hash = hash;" > </a> GET </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">List API versions</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-api-versions-detail" data-toggle="collapse" id="list-api-versions-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-api-versions-detail"> This fetches all the information about all known major API versions in the deployment. Links to more specific information will be provided for each major API version, as well as information about supported min and max microversions. Normal response codes: 200 <section id="request"> <h3>Request<a class="headerlink" href="#request" title="Link to this heading">¶</a></h3> </section> <section id="response-example"> <h3>Response Example<a class="headerlink" href="#response-example" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>description</td> <td>body</td> <td>string</td> <td>Descriptive text about the Watcher service.</td> </tr> <tr class="row-odd"><td>versions</td> <td>body</td> <td>array</td> <td>Array of information about currently supported versions.</td> </tr> <tr class="row-even"><td>version</td> <td>body</td> <td>string</td> <td>Versioning of this API response, eg. “1.1”.</td> </tr> <tr class="row-odd"><td>id</td> <td>body</td> <td>string</td> <td>Major API version, eg, “v1”</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-odd"><td>min_version</td> <td>header</td> <td>string</td> <td>Minimum API microversion supported by this endpoint, eg. “1.0”</td> </tr> <tr class="row-even"><td>max_version</td> <td>header</td> <td>string</td> <td>Maximum API microversion supported by this endpoint, eg. “1.1”</td> </tr> </tbody> </table> <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "default_version": { "id": "v1", "links": [ { "href": "http://controller:9322/v1/", "rel": "self" } ], "min_version": "1.0", "status": "CURRENT", "max_version": "1.1" }, "description": "Watcher is an OpenStack project which aims to improve physical resources usage through better VM placement.", "name": "OpenStack Watcher API", "versions": [ { "id": "v1", "links": [ { "href": "http://controller:9322/v1/", "rel": "self" } ], "min_version": "1.0", "status": "CURRENT", "max_version": "1.1" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-v1-api"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-v1-api" class="operation-anchor" href="#show-v1-api" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/</div> <div class="row col-md-12">Show v1 API</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-v1-api-detail" data-toggle="collapse" id="show-v1-api-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-v1-api-detail"> Show all the resources within the Watcher v1 API. Normal response codes: 200 <section id="id1"> <h3>Request<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3> </section> <section id="id2"> <h3>Response Example<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>id</td> <td>body</td> <td>string</td> <td>Major API version, eg, “v1”</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>OpenStack-API-Version</td> <td>header</td> <td>string</td> <td>Specific API microversion used to generate this response.</td> </tr> <tr class="row-odd"><td>OpenStack-API-Minimum-Version</td> <td>header</td> <td>string</td> <td>Minimum API microversion supported by this endpoint, eg. “1.0”</td> </tr> <tr class="row-even"><td>OpenStack-API-Maximum-Version</td> <td>header</td> <td>string</td> <td>Maximum API microversion supported by this endpoint, eg. “1.1”</td> </tr> </tbody> </table> <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "scoring_engines": [ { "href": "http://controller:9322/v1/scoring_engines/", "rel": "self" }, { "href": "http://controller:9322/scoring_engines/", "rel": "bookmark" } ], "media_types": [ { "base": "application/json", "type": "application/vnd.openstack.watcher.v1+json" } ], "links": [ { "href": "http://controller:9322/v1/", "rel": "self" }, { "href": "http://docs.openstack.org/developer/watcher/dev/api-spec-v1.html", "type": "text/html", "rel": "describedby" } ], "actions": [ { "href": "http://controller:9322/v1/actions/", "rel": "self" }, { "href": "http://controller:9322/actions/", "rel": "bookmark" } ], "audit_templates": [ { "href": "http://controller:9322/v1/audit_templates/", "rel": "self" }, { "href": "http://controller:9322/audit_templates/", "rel": "bookmark" } ], "action_plans": [ { "href": "http://controller:9322/v1/action_plans/", "rel": "self" }, { "href": "http://controller:9322/action_plans/", "rel": "bookmark" } ], "services": [ { "href": "http://controller:9322/v1/services/", "rel": "self" }, { "href": "http://controller:9322/services/", "rel": "bookmark" } ], "audits": [ { "href": "http://controller:9322/v1/audits/", "rel": "self" }, { "href": "http://controller:9322/audits/", "rel": "bookmark" } ], "id": "v1" } </pre></div> </div> </section> </section> </section> <section id="audit-templates"> <h1>Audit Templates<a class="headerlink" href="#audit-templates" title="Link to this heading">¶</a></h1> There are creating, listing, updating and deleting methods of Watcher Audit Template resources which are implemented via the <code class="docutils literal notranslate">/v1/audit_templates</code> resource. An Audit may be launched several times with the same settings (Goal, thresholds, …). Therefore it makes sense to save those settings in some sort of Audit preset object, which is known as an Audit Template. An Audit Template contains at least the Goal of the Audit. <section class="detail-control" id="create-audit-template"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="create-audit-template" class="operation-anchor" href="#create-audit-template" onclick="window.location.hash = hash;" > </a> POST </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audit_templates</div> <div class="row col-md-12">Create Audit Template</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#create-audit-template-detail" data-toggle="collapse" id="create-audit-template-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="create-audit-template-detail"> Creates a new Audit Template resource. It requires <code class="docutils literal notranslate">name</code> and <code class="docutils literal notranslate">goal</code> attributes to be supplied in the request body. Normal response codes: 201 Error codes: 400,404,409 <section id="id3"> <h3>Request<a class="headerlink" href="#id3" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>name</td> <td>body</td> <td>string</td> <td>The name of the Audit template.</td> </tr> <tr class="row-odd"><td>goal</td> <td>body</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-even"><td>strategy (Optional)</td> <td>body</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-odd"><td>description (Optional)</td> <td>body</td> <td>string</td> <td>Short description of the Audit Template.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> </tbody> </table> Example Audit Template creation request without a specified strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "name": "at2", "goal": "dummy" } </pre></div> </div> Example Audit Template creation request with a specified strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "name": "at2", "goal": "dummy", "strategy": "dummy", "description": "the second audit template", "scope": [] } </pre></div> </div> </section> <section id="response"> <h3>Response<a class="headerlink" href="#response" title="Link to this heading">¶</a></h3> The list and example below are representative of the response as of API version 1: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the Audit template.</td> </tr> <tr class="row-even"><td>description (Optional)</td> <td>body</td> <td>string</td> <td>Short description of the Audit Template.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Audit Template: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "description": null, "strategy_uuid": null, "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "at3", "uuid": "b4041d8c-85d7-4224-851d-649fe48b7196", "goal_name": "dummy", "scope": [], "created_at": "2018-04-04T08:38:33.110432+00:00", "deleted_at": null, "links": [ { "rel": "self", "href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196" }, { "rel": "bookmark", "href": "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196" } ], "strategy_name": null, "updated_at": null } </pre></div> </div> </section> </section> <section class="detail-control" id="list-audit-template"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-audit-template" class="operation-anchor" href="#list-audit-template" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audit_templates</div> <div class="row col-md-12">List Audit Template</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-audit-template-detail" data-toggle="collapse" id="list-audit-template-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-audit-template-detail"> Returns a list of Audit Template resources. Normal response codes: 200 Error codes: 400,401 <section id="id4"> <h3>Request<a class="headerlink" href="#id4" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-odd"><td>strategy (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id5"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the Audit template.</td> </tr> <tr class="row-even"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-odd"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-odd"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Audit Template: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "audit_templates":[ { "strategy_uuid": null, "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "at3", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196" }, { "rel": "bookmark", "href": "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196" } ], "strategy_name": null, "uuid": "b4041d8c-85d7-4224-851d-649fe48b7196", "goal_name": "dummy", "scope": [] } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-audit-template-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-audit-template-detailed" class="operation-anchor" href="#list-audit-template-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audit_templates/detail</div> <div class="row col-md-12">List Audit Template Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-audit-template-detailed-detail" data-toggle="collapse" id="list-audit-template-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-audit-template-detailed-detail"> Returns a list of Audit Template resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id6"> <h3>Request<a class="headerlink" href="#id6" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-odd"><td>strategy (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id7"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the Audit template.</td> </tr> <tr class="row-even"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-odd"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-odd"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>description (Optional)</td> <td>body</td> <td>string</td> <td>Short description of the Audit Template.</td> </tr> </tbody> </table> Example JSON representation of an Audit Template: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "audit_templates":[ { "strategy_uuid": null, "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "at3", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196" }, { "rel": "bookmark", "href": "http://controller:9322/audit_templates/b4041d8c-85d7-4224-851d-649fe48b7196" } ], "strategy_name": null, "uuid": "b4041d8c-85d7-4224-851d-649fe48b7196", "goal_name": "dummy", "scope": [], "description": null } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-audit-template"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-audit-template" class="operation-anchor" href="#show-audit-template" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audit_templates/{audittemplate_ident}</div> <div class="row col-md-12">Show Audit Template</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-audit-template-detail" data-toggle="collapse" id="show-audit-template-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-audit-template-detail"> Shows details for an Audit Template. Normal response codes: 200 Error codes: 404 <section id="id8"> <h3>Request<a class="headerlink" href="#id8" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audittemplate_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit Template.</td> </tr> </tbody> </table> </section> <section id="id9"> <h3>Response<a class="headerlink" href="#id9" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the Audit template.</td> </tr> <tr class="row-even"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-odd"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-odd"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>description (Optional)</td> <td>body</td> <td>string</td> <td>Short description of the Audit Template.</td> </tr> </tbody> </table> Example JSON representation of an Audit Template: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "description": "test 1", "strategy_uuid": null, "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "at1", "uuid": "0d100c27-14af-4962-86fb-f6079287c9c6", "goal_name": "dummy", "scope": [], "created_at": "2018-04-04T07:48:36.175472+00:00", "deleted_at": null, "links": [ { "rel": "self", "href": "http://controller:9322/v1/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6" }, { "rel": "bookmark", "href": "http://controller:9322/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6" } ], "strategy_name": null, "updated_at": "2018-04-05T07:57:55.803650+00:00" } </pre></div> </div> </section> </section> <section class="detail-control" id="update-audit-template"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-audit-template" class="operation-anchor" href="#update-audit-template" onclick="window.location.hash = hash;" > </a> PATCH </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audit_templates/{audittemplate_ident}</div> <div class="row col-md-12">Update Audit Template</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-audit-template-detail" data-toggle="collapse" id="update-audit-template-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-audit-template-detail"> Updates an Audit Template with the given information. Normal response codes: 200 Error codes: 400,404 <section id="id10"> <h3>Request<a class="headerlink" href="#id10" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audittemplate_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit Template.</td> </tr> </tbody> </table> Example PATCH document updating Audit Template: <div class="highlight-javascript notranslate"><div class="highlight"><pre>[ { "op": "replace", "value": "PENDING", "path": "/state" } ] </pre></div> </div> </section> <section id="id11"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the Audit template.</td> </tr> <tr class="row-even"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-odd"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-odd"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>description (Optional)</td> <td>body</td> <td>string</td> <td>Short description of the Audit Template.</td> </tr> </tbody> </table> Example JSON representation of an Audit Template: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "description": "test 1", "strategy_uuid": null, "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "at11", "uuid": "0d100c27-14af-4962-86fb-f6079287c9c6", "goal_name": "dummy", "scope": [], "created_at": "2018-04-04T07:48:36.175472+00:00", "deleted_at": null, "links": [ { "rel": "self", "href": "http://controller:9322/v1/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6" }, { "rel": "bookmark", "href": "http://controller:9322/audit_templates/0d100c27-14af-4962-86fb-f6079287c9c6" } ], "strategy_name": null, "updated_at": "2018-04-05T07:57:42.139127+00:00" } </pre></div> </div> </section> </section> <section class="detail-control" id="delete-audit-template"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-audit-template" class="operation-anchor" href="#delete-audit-template" onclick="window.location.hash = hash;" > </a> DELETE </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audit_templates/{audittemplate_ident}</div> <div class="row col-md-12">Delete Audit Template</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-audit-template-detail" data-toggle="collapse" id="delete-audit-template-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-audit-template-detail"> Deletes an Audit Template. Normal response codes: 204 Error codes: 404 <section id="id12"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audittemplate_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit Template.</td> </tr> </tbody> </table> </section> </section> </section> <section id="audits"> <h1>Audits<a class="headerlink" href="#audits" title="Link to this heading">¶</a></h1> There are creating, listing, updating and deleting methods of Watcher Audit resources which are implemented via the <code class="docutils literal notranslate">/v1/audits</code> resource. In the Watcher system, an <code class="docutils literal notranslate">Audit</code> is a request for optimizing a <code class="docutils literal notranslate">Cluster</code>. The optimization is done in order to satisfy one <code class="docutils literal notranslate">Goal</code> on a given <code class="docutils literal notranslate">Cluster</code>. For each <code class="docutils literal notranslate">Audit</code>, the Watcher system generates an <code class="docutils literal notranslate">Action Plan</code>. <section class="detail-control" id="create-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="create-audit" class="operation-anchor" href="#create-audit" onclick="window.location.hash = hash;" > </a> POST </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits</div> <div class="row col-md-12">Create Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#create-audit-detail" data-toggle="collapse" id="create-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="create-audit-detail"> Creates a new Audit resource. Mandatory attribute to be supplied: <code class="docutils literal notranslate">audit_type</code>. <code class="docutils literal notranslate">Audit</code> can be created either based on existed <code class="docutils literal notranslate">Audit Template</code> or by itself. In the first case, there also should be supplied <code class="docutils literal notranslate">audit_template_uuid</code>. If <code class="docutils literal notranslate">Audit</code> is created without <code class="docutils literal notranslate">Audit Template</code>, <code class="docutils literal notranslate">goal</code> should be provided. Normal response codes: 201 Error codes: 400,404 <section id="id13"> <h3>Request<a class="headerlink" href="#id13" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_template_uuid</td> <td>body</td> <td>string</td> <td>The UUID of the Audit template.</td> </tr> <tr class="row-odd"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-even"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-odd"><td>goal (Optional)</td> <td>body</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-even"><td>strategy (Optional)</td> <td>body</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-odd"><td>parameters (Optional)</td> <td>body</td> <td>JSON</td> <td>The strategy parameters for this audit.</td> </tr> <tr class="row-even"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="rp_min_ver_1_1 row-even"><td>start_time (Optional)</td> <td>body</td> <td>string</td> <td>The local time after which audit can be executed in accordance with interval. It will be converted to UTC time by Watcher. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_1 row-odd"><td>end_time (Optional)</td> <td>body</td> <td>string</td> <td>The local time after which audit can’t be executed. It will be converted to UTC time by Watcher. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_2 row-even"><td>force (Optional)</td> <td>body</td> <td>boolean</td> <td>Launch audit even if action plan is ongoing. New in version 1.2 </td> </tr> </tbody> </table> Example ONESHOT Audit creation request: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "audit_type": "ONESHOT", "auto_trigger": false, "force": true, "audit_template_uuid": "5e70a156-ced7-4012-b1c6-88fcb02ee0c1" } </pre></div> </div> Example CONTINUOUS Audit creation request with a specified strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "auto_trigger": false, "force": false, "audit_template_uuid": "76fddfee-a9c4-40b0-8da0-c19ad6904f09", "name": "test_audit", "parameters": { "metrics": [ "cpu_util" ] }, "audit_type": "CONTINUOUS", "interval": "*/2 * * * *", "start_time":"2018-04-02 20:30:00", "end_time": "2018-04-04 20:30:00" } </pre></div> </div> </section> <section id="id14"> <h3>Response<a class="headerlink" href="#id14" title="Link to this heading">¶</a></h3> The list and example below are representative of the response as of API version 1: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-even"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-even"><td>next_run_time (Optional)</td> <td>body</td> <td>string</td> <td>The next time audit launch. Defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>parameters (Optional)</td> <td>body</td> <td>JSON</td> <td>The strategy parameters for this audit.</td> </tr> <tr class="row-even"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="row-odd"><td>state</td> <td>body</td> <td>string</td> <td>State of this audit. To get more information about states and audit’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine">Audit State Machine page</a>.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the audit is running on</td> </tr> <tr class="rp_min_ver_1_1 row-odd"><td>start_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can be executed in accordance with interval. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_1 row-even"><td>end_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can’t be executed. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_2 row-odd"><td>force (Optional)</td> <td>body</td> <td>boolean</td> <td>Launch audit even if action plan is ongoing. New in version 1.2 </td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "interval": "*/2 * * * *", "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086", "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "name": "test_audit", "parameters": { "host_choice": "retry", "granularity": 300, "thresholds": { "cpu_util": 0.2, "memory.resident": 0.2 }, "periods": { "node": 600, "instance": 720 }, "retry_count": 1, "metrics": [ "cpu_util" ], "weights": { "cpu_util_weight": 1.0, "memory.resident_weight": 1.0 }, "instance_metrics": { "cpu_util": "compute.node.cpu.percent", "memory.resident": "hardware.memory.used" } }, "auto_trigger": false, "force": false, "uuid": "65a5da84-5819-4aea-8278-a28d2b489028", "goal_name": "workload_balancing", "scope": [], "created_at": "2018-04-06T07:27:27.820460+00:00", "deleted_at": null, "state": "PENDING", "audit_type": "CONTINUOUS", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028" }, { "rel": "bookmark", "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028" } ], "strategy_name": "workload_stabilization", "next_run_time": null, "updated_at": null, "hostname": null, "start_time": null, "end_time": null } </pre></div> </div> </section> </section> <section class="detail-control" id="list-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-audit" class="operation-anchor" href="#list-audit" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits</div> <div class="row col-md-12">List Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-audit-detail" data-toggle="collapse" id="list-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-audit-detail"> Returns a list of Audit resources. Normal response codes: 200 Error codes: 400,401 <section id="id15"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-odd"><td>strategy (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id16"> <h3>Response<a class="headerlink" href="#id16" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-even"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-even"><td>next_run_time (Optional)</td> <td>body</td> <td>string</td> <td>The next time audit launch. Defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="row-even"><td>state</td> <td>body</td> <td>string</td> <td>State of this audit. To get more information about states and audit’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine">Audit State Machine page</a>.</td> </tr> <tr class="row-odd"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "audits": [ { "interval": null, "strategy_uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25", "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "dummy-2018-03-26T11:56:07.950400", "auto_trigger": false, "uuid": "ccc69a5f-114e-46f4-b15e-a77eaa337b01", "goal_name": "dummy", "scope": [], "state": "SUCCEEDED", "audit_type": "ONESHOT", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audits/ccc69a5f-114e-46f4-b15e-a77eaa337b01" }, { "rel": "bookmark", "href": "http://controller:9322/audits/ccc69a5f-114e-46f4-b15e-a77eaa337b01" } ], "strategy_name": "dummy", "next_run_time": null } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-audit-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-audit-detailed" class="operation-anchor" href="#list-audit-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits/detail</div> <div class="row col-md-12">List Audit Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-audit-detailed-detail" data-toggle="collapse" id="list-audit-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-audit-detailed-detail"> Returns a list of Audit resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id18"> <h3>Request<a class="headerlink" href="#id18" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-odd"><td>strategy (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id19"> <h3>Response<a class="headerlink" href="#id19" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-even"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-even"><td>next_run_time (Optional)</td> <td>body</td> <td>string</td> <td>The next time audit launch. Defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>parameters (Optional)</td> <td>body</td> <td>JSON</td> <td>The strategy parameters for this audit.</td> </tr> <tr class="row-even"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="row-odd"><td>state</td> <td>body</td> <td>string</td> <td>State of this audit. To get more information about states and audit’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine">Audit State Machine page</a>.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the audit is running on</td> </tr> <tr class="rp_min_ver_1_1 row-odd"><td>start_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can be executed in accordance with interval. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_1 row-even"><td>end_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can’t be executed. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_2 row-odd"><td>force (Optional)</td> <td>body</td> <td>boolean</td> <td>Launch audit even if action plan is ongoing. New in version 1.2 </td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "audits": [ { "interval": "*/2 * * * *", "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086", "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "name": "test_audit", "parameters": { "host_choice": "retry", "instance_metrics": { "cpu_util": "compute.node.cpu.percent", "memory.resident": "hardware.memory.used" }, "granularity": 300, "weights": { "cpu_util_weight": 1.0, "memory.resident_weight": 1.0 }, "retry_count": 1, "metrics": [ "cpu_util" ], "periods": { "instance": 720, "node": 600 }, "thresholds": { "cpu_util": 0.2, "memory.resident": 0.2 } }, "auto_trigger": false, "force": false, "uuid": "65a5da84-5819-4aea-8278-a28d2b489028", "goal_name": "workload_balancing", "scope": [], "created_at": "2018-04-06T07:27:27.820460+00:00", "deleted_at": null, "state": "ONGOING", "audit_type": "CONTINUOUS", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028" }, { "rel": "bookmark", "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028" } ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T09:46:00", "updated_at": "2018-04-06T09:44:01.604146+00:00", "hostname": "controller", "start_time": null, "end_time": null } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-audit" class="operation-anchor" href="#show-audit" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits/{audit_ident}</div> <div class="row col-md-12">Show Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-audit-detail" data-toggle="collapse" id="show-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-audit-detail"> Shows details for an Audit. Normal response codes: 200 Error codes: 404 <section id="id21"> <h3>Request<a class="headerlink" href="#id21" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit.</td> </tr> </tbody> </table> </section> <section id="id22"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-even"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-even"><td>next_run_time (Optional)</td> <td>body</td> <td>string</td> <td>The next time audit launch. Defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>parameters (Optional)</td> <td>body</td> <td>JSON</td> <td>The strategy parameters for this audit.</td> </tr> <tr class="row-even"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="row-odd"><td>state</td> <td>body</td> <td>string</td> <td>State of this audit. To get more information about states and audit’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine">Audit State Machine page</a>.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the audit is running on</td> </tr> <tr class="rp_min_ver_1_1 row-odd"><td>start_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can be executed in accordance with interval. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_1 row-even"><td>end_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can’t be executed. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_2 row-odd"><td>force (Optional)</td> <td>body</td> <td>boolean</td> <td>Launch audit even if action plan is ongoing. New in version 1.2 </td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "interval": "*/2 * * * *", "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086", "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "name": "test_audit", "parameters": { "host_choice": "retry", "instance_metrics": { "cpu_util": "compute.node.cpu.percent", "memory.resident": "hardware.memory.used" }, "granularity": 300, "weights": { "cpu_util_weight": 1.0, "memory.resident_weight": 1.0 }, "retry_count": 1, "metrics": [ "cpu_util" ], "periods": { "instance": 720, "node": 600 }, "thresholds": { "cpu_util": 0.2, "memory.resident": 0.2 } }, "auto_trigger": false, "force": false, "uuid": "65a5da84-5819-4aea-8278-a28d2b489028", "goal_name": "workload_balancing", "scope": [], "created_at": "2018-04-06T07:27:27.820460+00:00", "deleted_at": null, "state": "ONGOING", "audit_type": "CONTINUOUS", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028" }, { "rel": "bookmark", "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028" } ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T11:56:00", "updated_at": "2018-04-06T11:54:01.266447+00:00", "hostname": "controller", "start_time": null, "end_time": null } </pre></div> </div> </section> </section> <section class="detail-control" id="cancel-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="cancel-audit" class="operation-anchor" href="#cancel-audit" onclick="window.location.hash = hash;" > </a> PATCH </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits/{audit_ident}</div> <div class="row col-md-12">Cancel Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#cancel-audit-detail" data-toggle="collapse" id="cancel-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="cancel-audit-detail"> Cancels an ONGOING Audit resource. Normal response codes: 200 Error codes: 400,404 <section id="id24"> <h3>Request<a class="headerlink" href="#id24" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit.</td> </tr> </tbody> </table> Example Audit cancelling request: <div class="highlight-javascript notranslate"><div class="highlight"><pre>[ { "op": "replace", "value": "CANCELLED", "path": "/state" } ] </pre></div> </div> </section> <section id="id25"> <h3>Response<a class="headerlink" href="#id25" title="Link to this heading">¶</a></h3> The list and example below are representative of the response as of API version 1: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-even"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-even"><td>next_run_time (Optional)</td> <td>body</td> <td>string</td> <td>The next time audit launch. Defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>parameters (Optional)</td> <td>body</td> <td>JSON</td> <td>The strategy parameters for this audit.</td> </tr> <tr class="row-even"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="row-odd"><td>state</td> <td>body</td> <td>string</td> <td>State of this audit. To get more information about states and audit’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine">Audit State Machine page</a>.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the audit is running on</td> </tr> <tr class="rp_min_ver_1_1 row-odd"><td>start_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can be executed in accordance with interval. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_1 row-even"><td>end_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can’t be executed. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_2 row-odd"><td>force (Optional)</td> <td>body</td> <td>boolean</td> <td>Launch audit even if action plan is ongoing. New in version 1.2 </td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "interval": "*/2 * * * *", "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086", "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "name": "audit1", "parameters": { "host_choice": "retry", "instance_metrics": { "cpu_util": "compute.node.cpu.percent", "memory.resident": "hardware.memory.used" }, "granularity": 300, "weights": { "cpu_util_weight": 1.0, "memory.resident_weight": 1.0 }, "retry_count": 1, "metrics": [ "cpu_util" ], "periods": { "instance": 720, "node": 600 }, "thresholds": { "cpu_util": 0.2, "memory.resident": 0.2 } }, "auto_trigger": false, "force": false, "uuid": "65a5da84-5819-4aea-8278-a28d2b489028", "goal_name": "workload_balancing", "scope": [], "created_at": "2018-04-06T07:27:27.820460+00:00", "deleted_at": null, "state": "CANCELLED", "audit_type": "CONTINUOUS", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028" }, { "rel": "bookmark", "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028" } ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T11:56:00", "updated_at": "2018-04-06T11:54:01.266447+00:00", "hostname": "controller", "start_time": null, "end_time": null } </pre></div> </div> </section> </section> <section class="detail-control" id="update-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="update-audit" class="operation-anchor" href="#update-audit" onclick="window.location.hash = hash;" > </a> PATCH </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits/{audit_ident}</div> <div class="row col-md-12">Update Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#update-audit-detail" data-toggle="collapse" id="update-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="update-audit-detail"> Updates an Audit with the given information. Normal response codes: 200 Error codes: 400,404 <section id="id27"> <h3>Request<a class="headerlink" href="#id27" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit.</td> </tr> </tbody> </table> Example PATCH document updating Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>[ { "value": "CANCELLED", "path": "/state", "op": "replace" }, { "value": "audit1", "path": "/name", "op": "replace" } ] </pre></div> </div> </section> <section id="id28"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name (Optional)</td> <td>body</td> <td>string</td> <td>Name of this audit.</td> </tr> <tr class="row-even"><td>audit_type</td> <td>body</td> <td>string</td> <td>Type of this audit. Can only be either ONESHOT or CONTINUOUS.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>interval (Optional)</td> <td>body</td> <td>string</td> <td>Time interval between audit’s execution. Can be set either in seconds or cron syntax. Should be defined only for CONTINUOUS audits.</td> </tr> <tr class="row-even"><td>next_run_time (Optional)</td> <td>body</td> <td>string</td> <td>The next time audit launch. Defined only for CONTINUOUS audits.</td> </tr> <tr class="row-odd"><td>parameters (Optional)</td> <td>body</td> <td>JSON</td> <td>The strategy parameters for this audit.</td> </tr> <tr class="row-even"><td>auto_trigger (Optional)</td> <td>body</td> <td>boolean</td> <td>Auto execute action plan once audit is succeeded.</td> </tr> <tr class="row-odd"><td>state</td> <td>body</td> <td>string</td> <td>State of this audit. To get more information about states and audit’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#audit-state-machine">Audit State Machine page</a>.</td> </tr> <tr class="row-even"><td>scope (Optional)</td> <td>body</td> <td>JSON</td> <td>Audit Scope.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the audit is running on</td> </tr> <tr class="rp_min_ver_1_1 row-odd"><td>start_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can be executed in accordance with interval. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_1 row-even"><td>end_time (Optional)</td> <td>body</td> <td>string</td> <td>The UTC time after which audit can’t be executed. New in version 1.1 </td> </tr> <tr class="rp_min_ver_1_2 row-odd"><td>force (Optional)</td> <td>body</td> <td>boolean</td> <td>Launch audit even if action plan is ongoing. New in version 1.2 </td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "interval": "*/2 * * * *", "strategy_uuid": "6b3b3902-8508-4cb0-bb85-67f32866b086", "goal_uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "name": "audit1", "parameters": { "host_choice": "retry", "instance_metrics": { "cpu_util": "compute.node.cpu.percent", "memory.resident": "hardware.memory.used" }, "granularity": 300, "weights": { "cpu_util_weight": 1.0, "memory.resident_weight": 1.0 }, "retry_count": 1, "metrics": [ "cpu_util" ], "periods": { "instance": 720, "node": 600 }, "thresholds": { "cpu_util": 0.2, "memory.resident": 0.2 } }, "auto_trigger": false, "force": false, "uuid": "65a5da84-5819-4aea-8278-a28d2b489028", "goal_name": "workload_balancing", "scope": [], "created_at": "2018-04-06T07:27:27.820460+00:00", "deleted_at": null, "state": "CANCELLED", "audit_type": "CONTINUOUS", "links": [ { "rel": "self", "href": "http://controller:9322/v1/audits/65a5da84-5819-4aea-8278-a28d2b489028" }, { "rel": "bookmark", "href": "http://controller:9322/audits/65a5da84-5819-4aea-8278-a28d2b489028" } ], "strategy_name": "workload_stabilization", "next_run_time": "2018-04-06T11:56:00", "updated_at": "2018-04-06T11:54:01.266447+00:00", "hostname": "controller", "start_time": null, "end_time": null } </pre></div> </div> </section> </section> <section class="detail-control" id="delete-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-audit" class="operation-anchor" href="#delete-audit" onclick="window.location.hash = hash;" > </a> DELETE </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/audits/{audit_ident}</div> <div class="row col-md-12">Delete Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-audit-detail" data-toggle="collapse" id="delete-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-audit-detail"> Deletes an Audit. Audit can be deleted only from FAILED, SUCCEEDED, CANCELLED, SUSPENDED states. Normal response codes: 204 Error codes: 404 <section id="id30"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit.</td> </tr> </tbody> </table> </section> </section> </section> <section id="action-plans"> <h1>Action Plans<a class="headerlink" href="#action-plans" title="Link to this heading">¶</a></h1> An <code class="docutils literal notranslate">Action Plan</code> specifies a flow of <code class="docutils literal notranslate">Actions</code> that should be executed in order to satisfy a given <code class="docutils literal notranslate">Goal</code>. It also contains an estimated <code class="docutils literal notranslate">global efficacy</code> alongside a set of <code class="docutils literal notranslate">efficacy indicators</code>. An <code class="docutils literal notranslate">Action Plan</code> is generated by Watcher when an <code class="docutils literal notranslate">Audit</code> is successful which implies that the <code class="docutils literal notranslate">Strategy</code> which was used has found a <code class="docutils literal notranslate">Solution</code> to achieve the <code class="docutils literal notranslate">Goal</code> of this <code class="docutils literal notranslate">Audit</code>. In the default implementation of Watcher, an action plan is composed of a graph of linked <code class="docutils literal notranslate">Actions</code>. Each action may have parent actions, which should be executed prior to child action. <section class="detail-control" id="start-action-plan"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="start-action-plan" class="operation-anchor" href="#start-action-plan" onclick="window.location.hash = hash;" > </a> POST </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/action_plans/{actionplan_ident}/start</div> <div class="row col-md-12">Start Action Plan</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#start-action-plan-detail" data-toggle="collapse" id="start-action-plan-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="start-action-plan-detail"> Starts a created Action Plan resource. Normal response codes: 200 Error codes: 400,404 <section id="id31"> <h3>Request<a class="headerlink" href="#id31" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>actionplan_ident</td> <td>path</td> <td>string</td> <td>The UUID of the Action Plan.</td> </tr> </tbody> </table> </section> <section id="id32"> <h3>Response<a class="headerlink" href="#id32" title="Link to this heading">¶</a></h3> The list and example below are representative of the response as of API version 1: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>state (Optional)</td> <td>body</td> <td>string</td> <td>State of this action plan. To get more information about states and action plan’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine">Action Plan State Machine page</a>.</td> </tr> <tr class="row-even"><td>audit_uuid (Optional)</td> <td>body</td> <td>string</td> <td>The UUID of the audit this acton plan belongs to.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>efficacy_indicators (Optional)</td> <td>body</td> <td>array</td> <td>The list of efficacy indicators associated to this action plan.</td> </tr> <tr class="row-even"><td>global_efficacy (Optional)</td> <td>body</td> <td>array</td> <td>The global efficacy of this action plan.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the actionplan is running on</td> </tr> </tbody> </table> Example JSON representation of an Action Plan: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "state": "PENDING", "efficacy_indicators": [], "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242", "global_efficacy": [], "links": [ { "rel": "self", "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" }, { "rel": "bookmark", "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" } ], "updated_at": "2018-04-10T11:59:41.602430+00:00", "strategy_name": "dummy_with_resize", "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", "created_at": "2018-04-10T11:59:12.592729+00:00", "deleted_at": null, "hostname": null } </pre></div> </div> </section> </section> <section class="detail-control" id="list-action-plan"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-action-plan" class="operation-anchor" href="#list-action-plan" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/action_plans</div> <div class="row col-md-12">List Action Plan</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-action-plan-detail" data-toggle="collapse" id="list-action-plan-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-action-plan-detail"> Returns a list of Action Plan resources. Normal response codes: 200 Error codes: 400,401 <section id="id33"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_uuid (Optional)</td> <td>query</td> <td>string</td> <td>Optional UUID of an audit, to get only actions for that audit.</td> </tr> <tr class="row-odd"><td>strategy (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id34"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>state (Optional)</td> <td>body</td> <td>string</td> <td>State of this action plan. To get more information about states and action plan’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine">Action Plan State Machine page</a>.</td> </tr> <tr class="row-even"><td>audit_uuid (Optional)</td> <td>body</td> <td>string</td> <td>The UUID of the audit this acton plan belongs to.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>efficacy_indicators (Optional)</td> <td>body</td> <td>array</td> <td>The list of efficacy indicators associated to this action plan.</td> </tr> <tr class="row-even"><td>global_efficacy (Optional)</td> <td>body</td> <td>array</td> <td>The global efficacy of this action plan.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Action Plan: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "action_plans": [ { "state": "ONGOING", "efficacy_indicators": [], "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242", "global_efficacy": [], "links": [ { "rel": "self", "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" }, { "rel": "bookmark", "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" } ], "updated_at": "2018-04-10T11:59:52.640067+00:00", "strategy_name": "dummy_with_resize", "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-action-plan-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-action-plan-detailed" class="operation-anchor" href="#list-action-plan-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/action_plans/detail</div> <div class="row col-md-12">List Action Plan detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-action-plan-detailed-detail" data-toggle="collapse" id="list-action-plan-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-action-plan-detailed-detail"> Returns a list of Action Plan resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id36"> <h3>Request<a class="headerlink" href="#id36" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_uuid (Optional)</td> <td>query</td> <td>string</td> <td>Optional UUID of an audit, to get only actions for that audit.</td> </tr> <tr class="row-odd"><td>strategy (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id37"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>deleted_at</td> <td>body</td> <td>string</td> <td>The date and time when the resource was deleted. The date and time stamp format is <a class="reference external" href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a></td> </tr> <tr class="row-odd"><td>updated_at</td> <td>body</td> <td>string</td> <td>The date and time when the resource was updated. The date and time stamp format is <a class="reference external" href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a></td> </tr> <tr class="row-even"><td>created_at</td> <td>body</td> <td>string</td> <td>The date and time when the resource was created. The date and time stamp format is <a class="reference external" href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</a></td> </tr> <tr class="row-odd"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-even"><td>state (Optional)</td> <td>body</td> <td>string</td> <td>State of this action plan. To get more information about states and action plan’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine">Action Plan State Machine page</a>.</td> </tr> <tr class="row-odd"><td>audit_uuid (Optional)</td> <td>body</td> <td>string</td> <td>The UUID of the audit this acton plan belongs to.</td> </tr> <tr class="row-even"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-odd"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>efficacy_indicators (Optional)</td> <td>body</td> <td>array</td> <td>The list of efficacy indicators associated to this action plan.</td> </tr> <tr class="row-odd"><td>global_efficacy (Optional)</td> <td>body</td> <td>array</td> <td>The global efficacy of this action plan.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-odd"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the actionplan is running on</td> </tr> </tbody> </table> Example JSON representation of an Action Plan: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "action_plans": [ { "state": "ONGOING", "efficacy_indicators": [], "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242", "global_efficacy": [], "links": [ { "rel": "self", "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" }, { "rel": "bookmark", "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" } ], "updated_at": "2018-04-10T11:59:52.640067+00:00", "strategy_name": "dummy_with_resize", "deleted_at": null, "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", "created_at": "2018-04-10T11:59:52.640067+00:00", "hostname": "controller" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-action-plan"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-action-plan" class="operation-anchor" href="#show-action-plan" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/action_plans/{actionplan_ident}</div> <div class="row col-md-12">Show Action Plan</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-action-plan-detail" data-toggle="collapse" id="show-action-plan-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-action-plan-detail"> Shows details for an Action Plan. Normal response codes: 200 Error codes: 404 <section id="id41"> <h3>Request<a class="headerlink" href="#id41" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>actionplan_ident</td> <td>path</td> <td>string</td> <td>The UUID of the Action Plan.</td> </tr> </tbody> </table> </section> <section id="id42"> <h3>Response<a class="headerlink" href="#id42" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>state (Optional)</td> <td>body</td> <td>string</td> <td>State of this action plan. To get more information about states and action plan’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine">Action Plan State Machine page</a>.</td> </tr> <tr class="row-even"><td>audit_uuid (Optional)</td> <td>body</td> <td>string</td> <td>The UUID of the audit this acton plan belongs to.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>efficacy_indicators (Optional)</td> <td>body</td> <td>array</td> <td>The list of efficacy indicators associated to this action plan.</td> </tr> <tr class="row-even"><td>global_efficacy (Optional)</td> <td>body</td> <td>array</td> <td>The global efficacy of this action plan.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the actionplan is running on</td> </tr> </tbody> </table> Example JSON representation of an Audit: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "state": "ONGOING", "efficacy_indicators": [], "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242", "global_efficacy": [], "links": [ { "rel": "self", "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" }, { "rel": "bookmark", "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" } ], "updated_at": "2018-04-10T11:59:52.640067+00:00", "strategy_name": "dummy_with_resize", "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", "hostname": "controller" } </pre></div> </div> </section> </section> <section class="detail-control" id="cancel-action-plan"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="cancel-action-plan" class="operation-anchor" href="#cancel-action-plan" onclick="window.location.hash = hash;" > </a> PATCH </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/action_plans/{actionplan_ident}</div> <div class="row col-md-12">Cancel Action Plan</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#cancel-action-plan-detail" data-toggle="collapse" id="cancel-action-plan-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="cancel-action-plan-detail"> Cancels a created Action Plan resource. Normal response codes: 200 Error codes: 400,404 <section id="id44"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>actionplan_ident</td> <td>path</td> <td>string</td> <td>The UUID of the Action Plan.</td> </tr> </tbody> </table> Example Action Plan ONGOING cancelling request: <div class="highlight-javascript notranslate"><div class="highlight"><pre>[ { "op": "replace", "value": "CANCELLING", "path": "/state" } ] </pre></div> </div> Example Action Plan PENDING cancelling request: <div class="highlight-javascript notranslate"><div class="highlight"><pre>[ { "op": "replace", "value": "CANCELLED", "path": "/state" } ] </pre></div> </div> </section> <section id="id45"> <h3>Response<a class="headerlink" href="#id45" title="Link to this heading">¶</a></h3> The list and example below are representative of the response as of API version 1: <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>state (Optional)</td> <td>body</td> <td>string</td> <td>State of this action plan. To get more information about states and action plan’s lifecycle, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/architecture.html#action-plan-state-machine">Action Plan State Machine page</a>.</td> </tr> <tr class="row-even"><td>audit_uuid (Optional)</td> <td>body</td> <td>string</td> <td>The UUID of the audit this acton plan belongs to.</td> </tr> <tr class="row-odd"><td>strategy_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this strategy.</td> </tr> <tr class="row-even"><td>strategy_name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-odd"><td>efficacy_indicators (Optional)</td> <td>body</td> <td>array</td> <td>The list of efficacy indicators associated to this action plan.</td> </tr> <tr class="row-even"><td>global_efficacy (Optional)</td> <td>body</td> <td>array</td> <td>The global efficacy of this action plan.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> <tr class="row-even"><td>hostname (Optional)</td> <td>body</td> <td>string</td> <td>Hostname the actionplan is running on</td> </tr> </tbody> </table> Example JSON representation of an Action Plan: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "state": "PENDING", "efficacy_indicators": [], "strategy_uuid": "7dae0eea-9df7-42b8-bb3e-313958ff2242", "global_efficacy": [], "links": [ { "rel": "self", "href": "http://controller:9322/v1/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" }, { "rel": "bookmark", "href": "http://controller:9322/action_plans/4cbc4ede-0d25-481b-b86e-998dbbd4f8bf" } ], "updated_at": "2018-04-10T11:59:41.602430+00:00", "strategy_name": "dummy_with_resize", "uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "audit_uuid": "7d100b05-0a86-491f-98a7-f93da19b272a", "created_at": "2018-04-10T11:59:12.592729+00:00", "deleted_at": null, "hostname": null } </pre></div> </div> </section> </section> <section class="detail-control" id="delete-action-plan"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="delete-action-plan" class="operation-anchor" href="#delete-action-plan" onclick="window.location.hash = hash;" > </a> DELETE </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/action_plans/{actionplan_ident}</div> <div class="row col-md-12">Delete Action Plan</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#delete-action-plan-detail" data-toggle="collapse" id="delete-action-plan-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="delete-action-plan-detail"> Deletes an Action Plan. Action Plan can be deleted only from SUCCEEDED, RECOMMENDED, FAILED, SUPERSEDED, CANCELLED states. Normal response codes: 204 Error codes: 404 <section id="id47"> <h3>Request<a class="headerlink" href="#id47" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>actionplan_ident</td> <td>path</td> <td>string</td> <td>The UUID of the Action Plan.</td> </tr> </tbody> </table> </section> </section> </section> <section id="actions"> <h1>Actions<a class="headerlink" href="#actions" title="Link to this heading">¶</a></h1> An <code class="docutils literal notranslate">Action</code> is what enables Watcher to transform the current state of a <code class="docutils literal notranslate">Cluster</code> after an <code class="docutils literal notranslate">Audit</code>. An <code class="docutils literal notranslate">Action</code> is an atomic task which changes the current state of a target Managed resource of the OpenStack <code class="docutils literal notranslate">Cluster</code> such as: <ul class="simple"> <li>Live migration of an instance from one compute node to another compute node with Nova</li> <li>Changing the power level of a compute node (ACPI level, …)</li> <li>Changing the current state of a compute node (enable or disable) with Nova</li> </ul> In most cases, an <code class="docutils literal notranslate">Action</code> triggers some concrete commands on an existing OpenStack module (Nova, Neutron, Cinder, Ironic, etc.). An <code class="docutils literal notranslate">Action</code> has a life-cycle and its current state may be one of the following: <ul class="simple"> <li>PENDING : the <code class="docutils literal notranslate">Action</code> has not been executed yet by the <code class="docutils literal notranslate">Watcher Applier</code>.</li> <li>ONGOING : the <code class="docutils literal notranslate">Action</code> is currently being processed by the <code class="docutils literal notranslate">Watcher Applier</code>.</li> <li>SUCCEEDED : the <code class="docutils literal notranslate">Action</code> has been executed successfully</li> <li>FAILED : an error occurred while trying to execute the <code class="docutils literal notranslate">Action</code>.</li> <li>DELETED : the <code class="docutils literal notranslate">Action</code> is still stored in the <code class="docutils literal notranslate">Watcher database</code> but is not returned any more through the Watcher APIs.</li> <li>CANCELLED : the <code class="docutils literal notranslate">Action</code> was in PENDING or ONGOING state and was cancelled by the <code class="docutils literal notranslate">Administrator</code></li> </ul> <code class="docutils literal notranslate">Actions</code> are created by <code class="docutils literal notranslate">Watcher Planner</code> as result of Audit’s execution. <code class="docutils literal notranslate">Action</code> can’t be created, modified or deleted by user. <section class="detail-control" id="list-action"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-action" class="operation-anchor" href="#list-action" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/actions</div> <div class="row col-md-12">List Action</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-action-detail" data-toggle="collapse" id="list-action-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-action-detail"> Returns a list of Action resources. Normal response codes: 200 Error codes: 400,401 <section id="id48"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>action_plan_uuid (Optional)</td> <td>query</td> <td>string</td> <td>UUID of the action plan used for filtering.</td> </tr> <tr class="row-odd"><td>audit_uuid (Optional)</td> <td>query</td> <td>string</td> <td>Optional UUID of an audit, to get only actions for that audit.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id49"> <h3>Response<a class="headerlink" href="#id49" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>action_type</td> <td>body</td> <td>string</td> <td>Action type based on specific API action. Actions in Watcher are pluggable, to see a list of supported action types visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions">Action plugins page</a>.</td> </tr> <tr class="row-even"><td>state</td> <td>body</td> <td>string</td> <td>State of Action.</td> </tr> <tr class="row-odd"><td>action_plan_uuid</td> <td>body</td> <td>string</td> <td>The action plan this action belongs to.</td> </tr> <tr class="row-even"><td>parents</td> <td>body</td> <td>array</td> <td>UUIDs of parent actions.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Action: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "actions": [ { "state": "PENDING", "parents": [ "8119d16e-b419-4729-b015-fc04c4e45783" ], "links": [ { "rel": "self", "href": "http://controller:9322/v1/actions/7182a988-e6c4-4152-a0d6-067119475c83" }, { "rel": "bookmark", "href": "http://controller:9322/actions/7182a988-e6c4-4152-a0d6-067119475c83" } ], "action_plan_uuid": "c6bba9ed-a7eb-4370-9993-d873e5e22cba", "uuid": "7182a988-e6c4-4152-a0d6-067119475c83", "action_type": "sleep" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-action-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-action-detailed" class="operation-anchor" href="#list-action-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/actions/detail</div> <div class="row col-md-12">List Action Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-action-detailed-detail" data-toggle="collapse" id="list-action-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-action-detailed-detail"> Returns a list of Action resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id50"> <h3>Request<a class="headerlink" href="#id50" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>action_plan_uuid (Optional)</td> <td>query</td> <td>string</td> <td>UUID of the action plan used for filtering.</td> </tr> <tr class="row-odd"><td>audit_uuid (Optional)</td> <td>query</td> <td>string</td> <td>Optional UUID of an audit, to get only actions for that audit.</td> </tr> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>marker (Optional)</td> <td>query</td> <td>string</td> <td>The ID of the last-seen item. Use the <code class="docutils literal notranslate">limit</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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id51"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>action_type</td> <td>body</td> <td>string</td> <td>Action type based on specific API action. Actions in Watcher are pluggable, to see a list of supported action types visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions">Action plugins page</a>.</td> </tr> <tr class="row-even"><td>state</td> <td>body</td> <td>string</td> <td>State of Action.</td> </tr> <tr class="row-odd"><td>action_plan_uuid</td> <td>body</td> <td>string</td> <td>The action plan this action belongs to.</td> </tr> <tr class="row-even"><td>parents</td> <td>body</td> <td>array</td> <td>UUIDs of parent actions.</td> </tr> <tr class="row-odd"><td>description</td> <td>body</td> <td>string</td> <td>Action description.</td> </tr> <tr class="row-even"><td>input_parameters</td> <td>body</td> <td>JSON</td> <td>Input parameters which are used by appropriate action type. For example, <code class="docutils literal notranslate">migration</code> action takes into account such parameters as <code class="docutils literal notranslate">migration_type</code>, <code class="docutils literal notranslate">destination_node</code>, <code class="docutils literal notranslate">resource_id</code> and <code class="docutils literal notranslate">source_node</code>. To see a list of supported action types and their input parameters visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions">Action plugins page</a>.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Action: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "actions": [ { "state": "PENDING", "description": "Wait for a given interval in seconds.", "parents": [ "8119d16e-b419-4729-b015-fc04c4e45783" ], "links": [ { "rel": "self", "href": "http://controller:9322/v1/actions/7182a988-e6c4-4152-a0d6-067119475c83" }, { "rel": "bookmark", "href": "http://controller:9322/actions/7182a988-e6c4-4152-a0d6-067119475c83" } ], "action_plan_uuid": "c6bba9ed-a7eb-4370-9993-d873e5e22cba", "uuid": "7182a988-e6c4-4152-a0d6-067119475c83", "deleted_at": null, "updated_at": null, "input_parameters": { "duration": 3.2 }, "action_type": "sleep", "created_at": "2018-03-26T11:56:08.235226+00:00" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-action"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-action" class="operation-anchor" href="#show-action" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/actions/{action_ident}</div> <div class="row col-md-12">Show Action</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-action-detail" data-toggle="collapse" id="show-action-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-action-detail"> Shows details for an Action. Normal response codes: 200 Error codes: 404 <section id="id54"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>action_ident</td> <td>path</td> <td>string</td> <td>The UUID of the Action.</td> </tr> </tbody> </table> </section> <section id="id55"> <h3>Response<a class="headerlink" href="#id55" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>action_type</td> <td>body</td> <td>string</td> <td>Action type based on specific API action. Actions in Watcher are pluggable, to see a list of supported action types visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions">Action plugins page</a>.</td> </tr> <tr class="row-even"><td>state</td> <td>body</td> <td>string</td> <td>State of Action.</td> </tr> <tr class="row-odd"><td>action_plan_uuid</td> <td>body</td> <td>string</td> <td>The action plan this action belongs to.</td> </tr> <tr class="row-even"><td>parents</td> <td>body</td> <td>array</td> <td>UUIDs of parent actions.</td> </tr> <tr class="row-odd"><td>description</td> <td>body</td> <td>string</td> <td>Action description.</td> </tr> <tr class="row-even"><td>input_parameters</td> <td>body</td> <td>JSON</td> <td>Input parameters which are used by appropriate action type. For example, <code class="docutils literal notranslate">migration</code> action takes into account such parameters as <code class="docutils literal notranslate">migration_type</code>, <code class="docutils literal notranslate">destination_node</code>, <code class="docutils literal notranslate">resource_id</code> and <code class="docutils literal notranslate">source_node</code>. To see a list of supported action types and their input parameters visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/contributor/plugin/plugins.html#actions">Action plugins page</a>.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of an Action: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "state": "SUCCEEDED", "description": "Logging a NOP message", "parents": [ "b4529294-1de6-4302-b57a-9b5d5dc363c6" ], "links": [ { "rel": "self", "href": "http://controller:9322/v1/actions/54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a" }, { "rel": "bookmark", "href": "http://controller:9322/actions/54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a" } ], "action_plan_uuid": "4cbc4ede-0d25-481b-b86e-998dbbd4f8bf", "uuid": "54acc7a0-91b0-46ea-a5f7-4ae2b9df0b0a", "deleted_at": null, "updated_at": "2018-04-10T11:59:44.026973+00:00", "input_parameters": { "message": "Welcome" }, "action_type": "nop", "created_at": "2018-04-10T11:59:12.725147+00:00" } </pre></div> </div> </section> </section> </section> <section id="goals"> <h1>Goals<a class="headerlink" href="#goals" title="Link to this heading">¶</a></h1> A <code class="docutils literal notranslate">Goal</code> is a human readable, observable and measurable end result having one objective to be achieved. Here are some examples of <code class="docutils literal notranslate">Goals</code>: <ul class="simple"> <li>minimize the energy consumption</li> <li>minimize the number of compute nodes (consolidation)</li> <li>balance the workload among compute nodes</li> <li>minimize the license cost (some software have a licensing model which is based on the number of sockets or cores where the software is deployed)</li> <li>find the most appropriate moment for a planned maintenance on a given group of host (which may be an entire availability zone): power supply replacement, cooling system replacement, hardware modification, …</li> </ul> <section class="detail-control" id="list-goal"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-goal" class="operation-anchor" href="#list-goal" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/goals</div> <div class="row col-md-12">List Goal</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-goal-detail" data-toggle="collapse" id="list-goal-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-goal-detail"> Returns a list of Goal resources. Normal response codes: 200 Error codes: 400,401 <section id="id58"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-even"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id59"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>efficacy_specification</td> <td>body</td> <td>array</td> <td>Efficacy specifications as result of stategy’s execution.</td> </tr> <tr class="row-even"><td>name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>display_name</td> <td>body</td> <td>string</td> <td>Localized name of the goal.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Goal: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "goals": [ { "efficacy_specification": [], "uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "links": [ { "rel": "self", "href": "http://controller:9322/v1/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a" }, { "rel": "bookmark", "href": "http://controller:9322/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a" } ], "name": "workload_balancing", "display_name": "Workload Balancing" }, { "efficacy_specification": [ { "description": "The total number of enabled compute nodes.", "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)", "name": "compute_nodes_count", "unit": null }, { "description": "The number of compute nodes to be released.", "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)", "name": "released_compute_nodes_count", "unit": null }, { "description": "The number of VM migrations to be performed.", "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)", "name": "instance_migrations_count", "unit": null } ], "uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b", "links": [ { "rel": "self", "href": "http://controller:9322/v1/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b" }, { "rel": "bookmark", "href": "http://controller:9322/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b" } ], "name": "server_consolidation", "display_name": "Server Consolidation" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-goal-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-goal-detailed" class="operation-anchor" href="#list-goal-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/goals/detail</div> <div class="row col-md-12">List Goal Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-goal-detailed-detail" data-toggle="collapse" id="list-goal-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-goal-detailed-detail"> Returns a list of Goal resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id60"> <h3>Request<a class="headerlink" href="#id60" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-even"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id61"> <h3>Response<a class="headerlink" href="#id61" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>efficacy_specification</td> <td>body</td> <td>array</td> <td>Efficacy specifications as result of stategy’s execution.</td> </tr> <tr class="row-even"><td>name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>display_name</td> <td>body</td> <td>string</td> <td>Localized name of the goal.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Goal: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "goals": [ { "efficacy_specification": [], "uuid": "e1a5a45b-f251-47cf-9c5f-fa1e66e1286a", "links": [ { "rel": "self", "href": "http://controller:9322/v1/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a" }, { "rel": "bookmark", "href": "http://controller:9322/goals/e1a5a45b-f251-47cf-9c5f-fa1e66e1286a" } ], "name": "workload_balancing", "display_name": "Workload Balancing" }, { "efficacy_specification": [ { "description": "The total number of enabled compute nodes.", "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)", "name": "compute_nodes_count", "unit": null }, { "description": "The number of compute nodes to be released.", "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)", "name": "released_compute_nodes_count", "unit": null }, { "description": "The number of VM migrations to be performed.", "schema": "Range(min=0, max=None, min_included=True, max_included=True, msg=None)", "name": "instance_migrations_count", "unit": null } ], "uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b", "links": [ { "rel": "self", "href": "http://controller:9322/v1/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b" }, { "rel": "bookmark", "href": "http://controller:9322/goals/cb9afa5e-aec7-4a8c-9261-c15c33f2262b" } ], "name": "server_consolidation", "display_name": "Server Consolidation" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-goal"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-goal" class="operation-anchor" href="#show-goal" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/goals/{goal_ident}</div> <div class="row col-md-12">Show Goal</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-goal-detail" data-toggle="collapse" id="show-goal-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-goal-detail"> Shows details for an Goal. Normal response codes: 200 Error codes: 404 <section id="id62"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> </tbody> </table> </section> <section id="id63"> <h3>Response<a class="headerlink" href="#id63" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>efficacy_specification</td> <td>body</td> <td>array</td> <td>Efficacy specifications as result of stategy’s execution.</td> </tr> <tr class="row-even"><td>name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>display_name</td> <td>body</td> <td>string</td> <td>Localized name of the goal.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Goal: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "efficacy_specification": [], "name": "saving_energy", "links": [ { "rel": "self", "href": "http://controller:9322/v1/goals/6f52889a-9dd4-4dbb-8e70-39b56c4836cc" }, { "rel": "bookmark", "href": "http://controller:9322/goals/6f52889a-9dd4-4dbb-8e70-39b56c4836cc" } ], "uuid": "6f52889a-9dd4-4dbb-8e70-39b56c4836cc", "updated_at": null, "display_name": "Saving Energy", "created_at": "2018-03-26T11:55:24.365584+00:00", "deleted_at": null } </pre></div> </div> </section> </section> </section> <section id="strategies"> <h1>Strategies<a class="headerlink" href="#strategies" title="Link to this heading">¶</a></h1> A <code class="docutils literal notranslate">Strategy</code> is an algorithm implementation which is able to find a <code class="docutils literal notranslate">Solution</code> for a given <code class="docutils literal notranslate">Goal</code>. To get more information about strategies that are shipped along with Watcher, visit <a class="reference external" href="https://docs.openstack.org/watcher/latest/strategies/index.html">strategies page</a>. There may be several potential strategies which are able to achieve the same <code class="docutils literal notranslate">Goal</code>. This is why it is possible to configure which specific <code class="docutils literal notranslate">Strategy</code> should be used for each goal. Some strategies may provide better optimization results but may take more time to find an optimal <code class="docutils literal notranslate">Solution</code>. <section class="detail-control" id="list-strategy"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-strategy" class="operation-anchor" href="#list-strategy" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/strategies</div> <div class="row col-md-12">List Strategy</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-strategy-detail" data-toggle="collapse" id="list-strategy-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-strategy-detail"> Returns a list of Strategy resources. Normal response codes: 200 Error codes: 400,401 <section id="id64"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-odd"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id65"> <h3>Response<a class="headerlink" href="#id65" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>display_name</td> <td>body</td> <td>string</td> <td>Localized name of the strategy.</td> </tr> <tr class="row-odd"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-even"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "strategies": [ { "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "dummy", "links": [ { "rel": "self", "href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25" }, { "rel": "bookmark", "href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25" } ], "uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25", "goal_name": "dummy", "display_name": "Dummy strategy" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-strategy-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-strategy-detailed" class="operation-anchor" href="#list-strategy-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/strategies/detail</div> <div class="row col-md-12">List Strategy Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-strategy-detailed-detail" data-toggle="collapse" id="list-strategy-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-strategy-detailed-detail"> Returns a list of Strategy resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id66"> <h3>Request<a class="headerlink" href="#id66" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>goal (Optional)</td> <td>query</td> <td>string</td> <td>The UUID or name of the Goal.</td> </tr> <tr class="row-odd"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-even"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-odd"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id67"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>display_name</td> <td>body</td> <td>string</td> <td>Localized name of the strategy.</td> </tr> <tr class="row-odd"><td>parameters_spec</td> <td>body</td> <td>JSON</td> <td>Parameters specifications for this strategy.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "strategies": [ { "goal_uuid": "cb9afa5e-aec7-4a8c-9261-c15c33f2262b", "name": "vm_workload_consolidation", "links": [ { "rel": "self", "href": "http://controller:9322/v1/strategies/6382b2d7-259e-487d-88db-78c852ffea54" }, { "rel": "bookmark", "href": "http://controller:9322/strategies/6382b2d7-259e-487d-88db-78c852ffea54" } ], "parameters_spec": { "properties": { "granularity": { "default": 300, "type": "number", "description": "The time between two measures in an aggregated timeseries of a metric." }, "period": { "default": 3600, "type": "number", "description": "The time interval in seconds for getting statistic aggregation" } } }, "uuid": "6382b2d7-259e-487d-88db-78c852ffea54", "goal_name": "server_consolidation", "display_name": "VM Workload Consolidation Strategy" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-strategy"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-strategy" class="operation-anchor" href="#show-strategy" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/strategies/{strategy_ident}</div> <div class="row col-md-12">Show Strategy</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-strategy-detail" data-toggle="collapse" id="show-strategy-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-strategy-detail"> Shows details for a Strategy resource. Normal response codes: 200 Error codes: 404 <section id="id68"> <h3>Request<a class="headerlink" href="#id68" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>strategy_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> </tbody> </table> </section> <section id="id69"> <h3>Response<a class="headerlink" href="#id69" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>Name of the strategy.</td> </tr> <tr class="row-even"><td>display_name</td> <td>body</td> <td>string</td> <td>Localized name of the strategy.</td> </tr> <tr class="row-odd"><td>parameters_spec</td> <td>body</td> <td>JSON</td> <td>Parameters specifications for this strategy.</td> </tr> <tr class="row-even"><td>goal_name</td> <td>body</td> <td>string</td> <td>Name of the goal.</td> </tr> <tr class="row-odd"><td>goal_uuid</td> <td>body</td> <td>string</td> <td>Unique UUID for this goal.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "goal_uuid": "4690f8ba-18ff-45c1-99e9-159556d23810", "name": "dummy", "links": [ { "rel": "self", "href": "http://controller:9322/v1/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25" }, { "rel": "bookmark", "href": "http://controller:9322/strategies/e311727b-b9b3-43ef-a5f7-8bd7ea80df25" } ], "parameters_spec": { "properties": { "para2": { "default": "hello", "type": "string", "description": "string parameter example" }, "para1": { "maximum": 10.2, "type": "number", "minimum": 1.0, "description": "number parameter example", "default": 3.2 } } }, "uuid": "e311727b-b9b3-43ef-a5f7-8bd7ea80df25", "goal_name": "dummy", "display_name": "Dummy strategy" } </pre></div> </div> </section> </section> <section class="detail-control" id="show-strategy-state"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-strategy-state" class="operation-anchor" href="#show-strategy-state" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/strategies/{strategy_ident}/state</div> <div class="row col-md-12">Show Strategy State</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-strategy-state-detail" data-toggle="collapse" id="show-strategy-state-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-strategy-state-detail"> Retrieve an information about strategy requirements. Normal response codes: 200 Error codes: 404 <section id="id70"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>strategy_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Strategy.</td> </tr> </tbody> </table> </section> <section id="id71"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>state</td> <td>body</td> <td>string or JSON</td> <td>State of requirement for Strategy.</td> </tr> <tr class="row-odd"><td>comment</td> <td>body</td> <td>string</td> <td>Requirement comment.</td> </tr> <tr class="row-even"><td>mandatory</td> <td>body</td> <td>boolean</td> <td>Whether this requirement mandatory or not.</td> </tr> <tr class="row-odd"><td>type</td> <td>body</td> <td>string</td> <td>Type of requirement for Strategy.</td> </tr> </tbody> </table> Example JSON representation of a Strategy: <div class="highlight-javascript notranslate"><div class="highlight"><pre>[ { "state": "gnocchi: available", "comment": "", "mandatory": true, "type": "Datasource" }, { "state": [ { "compute.node.cpu.percent": "available" }, { "cpu_util": "available" }, { "memory.resident": "available" }, { "hardware.memory.used": "available" } ], "comment": "", "mandatory": false, "type": "Metrics" }, { "state": [ { "compute_model": "available" }, { "storage_model": "not available" }, { "baremetal_model": "not available" } ], "comment": "", "mandatory": true, "type": "CDM" }, { "state": "workload_stabilization", "mandatory": "", "comment": "", "type": "Name" } ] </pre></div> </div> </section> </section> </section> <section id="services"> <h1>Services<a class="headerlink" href="#services" title="Link to this heading">¶</a></h1> This resource represents Watcher services, their states and hosts they are placed on. <section class="detail-control" id="list-service"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-service" class="operation-anchor" href="#list-service" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/services</div> <div class="row col-md-12">List Service</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-service-detail" data-toggle="collapse" id="list-service-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-service-detail"> Returns a list of Service resources. Normal response codes: 200 Error codes: 400,401 <section id="id72"> <h3>Request<a class="headerlink" href="#id72" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-even"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id73"> <h3>Response<a class="headerlink" href="#id73" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>id</td> <td>body</td> <td>integer</td> <td>The ID of service.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The Name of service like <code class="docutils literal notranslate">watcher-applier</code>.</td> </tr> <tr class="row-even"><td>host</td> <td>body</td> <td>string</td> <td>The Name of host where service is placed on.</td> </tr> <tr class="row-odd"><td>status</td> <td>body</td> <td>string</td> <td>The State of service. It can be either in ACTIVE or FAILED state.</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Service: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "services": [ { "id": 1, "status": "ACTIVE", "name": "watcher-applier", "host": "controller", "links": [ { "rel": "self", "href": "http://controller:9322/v1/services/1" }, { "rel": "bookmark", "href": "http://controller:9322/services/1" } ] }, { "id": 2, "status": "ACTIVE", "name": "watcher-decision-engine", "host": "controller", "links": [ { "rel": "self", "href": "http://controller:9322/v1/services/2" }, { "rel": "bookmark", "href": "http://controller:9322/services/2" } ] } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-service-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-service-detailed" class="operation-anchor" href="#list-service-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/services/detail</div> <div class="row col-md-12">List Service Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-service-detailed-detail" data-toggle="collapse" id="list-service-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-service-detailed-detail"> Returns a list of Service resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id74"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-even"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id75"> <h3>Response<a class="headerlink" href="#id75" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>id</td> <td>body</td> <td>integer</td> <td>The ID of service.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The Name of service like <code class="docutils literal notranslate">watcher-applier</code>.</td> </tr> <tr class="row-even"><td>host</td> <td>body</td> <td>string</td> <td>The Name of host where service is placed on.</td> </tr> <tr class="row-odd"><td>status</td> <td>body</td> <td>string</td> <td>The State of service. It can be either in ACTIVE or FAILED state.</td> </tr> <tr class="row-even"><td>last_seen_up</td> <td>body</td> <td>string</td> <td>The Time when Watcher service sent latest heartbeat.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Service: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "services": [ { "status": "ACTIVE", "name": "watcher-applier", "host": "controller", "links": [ { "rel": "self", "href": "http://controller:9322/v1/services/1" }, { "rel": "bookmark", "href": "http://controller:9322/services/1" } ], "id": 1, "deleted_at": null, "updated_at": "2018-04-26T08:52:37.652895+00:00", "last_seen_up": "2018-04-26T08:52:37.648572", "created_at": "2018-03-26T11:55:24.075093+00:00" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-service"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-service" class="operation-anchor" href="#show-service" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/services/{service_ident}</div> <div class="row col-md-12">Show Service</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-service-detail" data-toggle="collapse" id="show-service-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-service-detail"> Shows details for a Service resource. Normal response codes: 200 Error codes: 404 <section id="id76"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>service_ident</td> <td>path</td> <td>string</td> <td>The ID or name of the Service.</td> </tr> </tbody> </table> </section> <section id="id77"> <h3>Response<a class="headerlink" href="#id77" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>id</td> <td>body</td> <td>integer</td> <td>The ID of service.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The Name of service like <code class="docutils literal notranslate">watcher-applier</code>.</td> </tr> <tr class="row-even"><td>host</td> <td>body</td> <td>string</td> <td>The Name of host where service is placed on.</td> </tr> <tr class="row-odd"><td>status</td> <td>body</td> <td>string</td> <td>The State of service. It can be either in ACTIVE or FAILED state.</td> </tr> <tr class="row-even"><td>last_seen_up</td> <td>body</td> <td>string</td> <td>The Time when Watcher service sent latest heartbeat.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Service: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "status": "ACTIVE", "name": "watcher-applier", "host": "controller", "links": [ { "rel": "self", "href": "http://controller:9322/v1/services/1" }, { "rel": "bookmark", "href": "http://controller:9322/services/1" } ], "id": 1, "deleted_at": null, "updated_at": "2018-04-26T09:45:37.653061+00:00", "last_seen_up": "2018-04-26T09:45:37.649314", "created_at": "2018-03-26T11:55:24.075093+00:00" } </pre></div> </div> </section> </section> </section> <section id="scoring-engines"> <h1>Scoring Engines<a class="headerlink" href="#scoring-engines" title="Link to this heading">¶</a></h1> A <code class="docutils literal notranslate">Scoring Engine</code> is an executable that has a well-defined input, a well-defined output, and performs a purely mathematical task. That is, the calculation does not depend on the environment in which it is running - it would produce the same result anywhere. Because there might be multiple algorithms used to build a particular data model (and therefore a scoring engine), the usage of scoring engine might vary. A metainfo field is supposed to contain any information which might be needed by the user of a given scoring engine. <section class="detail-control" id="list-scoring-engine"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-scoring-engine" class="operation-anchor" href="#list-scoring-engine" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/scoring_engines</div> <div class="row col-md-12">List Scoring Engine</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-scoring-engine-detail" data-toggle="collapse" id="list-scoring-engine-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-scoring-engine-detail"> Returns a list of Scoring Engine resources. Normal response codes: 200 Error codes: 400,401 <section id="id78"> <h3>Request<a class="headerlink" href="#id78" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-even"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id79"> <h3>Response<a class="headerlink" href="#id79" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the scoring engine.</td> </tr> <tr class="row-even"><td>description</td> <td>body</td> <td>string</td> <td>A human readable description of the Scoring Engine.</td> </tr> <tr class="row-odd"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Scoring Engine: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "scoring_engines": [ { "description": "Dummy Scorer calculating the average value", "uuid": "5a44f007-55b1-423c-809f-6a274a9bd93b", "links": [ { "rel": "self", "href": "http://controller:9322/v1/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b" }, { "rel": "bookmark", "href": "http://controller:9322/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b" } ], "name": "dummy_avg_scorer" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="list-scoring-engine-detailed"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-scoring-engine-detailed" class="operation-anchor" href="#list-scoring-engine-detailed" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/scoring_engines/detail</div> <div class="row col-md-12">List Scoring Engine Detailed</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-scoring-engine-detailed-detail" data-toggle="collapse" id="list-scoring-engine-detailed-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-scoring-engine-detailed-detail"> Returns a list of Scoring Engine resources with complete details. Normal response codes: 200 Error codes: 400,401 <section id="id80"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>limit (Optional)</td> <td>query</td> <td>integer</td> <td>Requests a page size of items. Returns a number of items up to a <code class="docutils literal notranslate">limit</code> value. Use the limit 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">marker</code> parameter value in a subsequent limited request.</td> </tr> <tr class="row-odd"><td>sort_dir (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the requested sort direction. A valid value is <code class="docutils literal notranslate">asc</code> (ascending) or <code class="docutils literal notranslate">desc</code> (descending). Default is <code class="docutils literal notranslate">asc</code>.</td> </tr> <tr class="row-even"><td>sort_key (Optional)</td> <td>query</td> <td>string</td> <td>Sorts the response by the this attribute value. Default is <code class="docutils literal notranslate">id</code>.</td> </tr> </tbody> </table> </section> <section id="id81"> <h3>Response<a class="headerlink" href="#id81" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the scoring engine.</td> </tr> <tr class="row-even"><td>description</td> <td>body</td> <td>string</td> <td>A human readable description of the Scoring Engine.</td> </tr> <tr class="row-odd"><td>metainfo</td> <td>body</td> <td>string</td> <td>A metadata associated with the scoring engine</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Scoring Engine: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "scoring_engines": [ { "description": "Dummy Scorer calculating the average value", "uuid": "5a44f007-55b1-423c-809f-6a274a9bd93b", "links": [ { "rel": "self", "href": "http://controller:9322/v1/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b" }, { "rel": "bookmark", "href": "http://controller:9322/scoring_engines/5a44f007-55b1-423c-809f-6a274a9bd93b" } ], "name": "dummy_avg_scorer", "metainfo": "" } ] } </pre></div> </div> </section> </section> <section class="detail-control" id="show-scoring-engine"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="show-scoring-engine" class="operation-anchor" href="#show-scoring-engine" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/scoring_engines/{scoring_engine_ident}</div> <div class="row col-md-12">Show Scoring Engine</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#show-scoring-engine-detail" data-toggle="collapse" id="show-scoring-engine-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="show-scoring-engine-detail"> Shows details for a Scoring Engine resource. Normal response codes: 200 Error codes: 404 <section id="id82"> <h3>Request<a class="headerlink" href="#id82" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>scoring_engine_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Scoring Engine.</td> </tr> </tbody> </table> </section> <section id="id83"> <h3>Response<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>uuid</td> <td>body</td> <td>string</td> <td>The UUID for the resource.</td> </tr> <tr class="row-odd"><td>name</td> <td>body</td> <td>string</td> <td>The name of the scoring engine.</td> </tr> <tr class="row-even"><td>description</td> <td>body</td> <td>string</td> <td>A human readable description of the Scoring Engine.</td> </tr> <tr class="row-odd"><td>metainfo</td> <td>body</td> <td>string</td> <td>A metadata associated with the scoring engine</td> </tr> <tr class="row-even"><td>links</td> <td>body</td> <td>array</td> <td>A list of relative links. Includes the self and bookmark links.</td> </tr> </tbody> </table> Example JSON representation of a Scoring Engine: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "description": "Dummy Scorer calculating the maximum value", "uuid": "1ac42282-4e77-473e-898b-62ea007f1deb", "links": [ { "rel": "self", "href": "http://controller:9322/v1/scoring_engines/1ac42282-4e77-473e-898b-62ea007f1deb" }, { "rel": "bookmark", "href": "http://controller:9322/scoring_engines/1ac42282-4e77-473e-898b-62ea007f1deb" } ], "name": "dummy_max_scorer", "metainfo": "" } </pre></div> </div> </section> </section> </section> <section id="data-model"> <h1>Data Model<a class="headerlink" href="#data-model" title="Link to this heading">¶</a></h1> <div class="versionadded"> Added in version 1.3. </div> <code class="docutils literal notranslate">Data Model</code> is very important for Watcher to generate resource optimization solutions. Users can easily view the data model by the API. <section class="detail-control" id="list-data-model"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="list-data-model" class="operation-anchor" href="#list-data-model" onclick="window.location.hash = hash;" > </a> GET </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/data_model</div> <div class="row col-md-12">List Data Model</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#list-data-model-detail" data-toggle="collapse" id="list-data-model-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="list-data-model-detail"> Returns the information about Data Model. Normal response codes: 200 Error codes: 400,401,406 <section id="id84"> <h3>Request<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">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit (Optional)</td> <td>query</td> <td>string</td> <td>Optional UUID of an audit, to get only actions for that audit.</td> </tr> <tr class="row-odd"><td>type (Optional)</td> <td>query</td> <td>string</td> <td>Type of data model user want to list. Default type is compute. Supported values: compute. Future support values: storage, baremetal.</td> </tr> </tbody> </table> </section> <section id="id85"> <h3>Response<a class="headerlink" href="#id85" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>server_uuid</td> <td>body</td> <td>string</td> <td>The Unique UUID of the server.</td> </tr> <tr class="row-odd"><td>server_name</td> <td>body</td> <td>string</td> <td>The Name of the server.</td> </tr> <tr class="row-even"><td>server_vcpus</td> <td>body</td> <td>integer</td> <td>The Vcpu of the server.</td> </tr> <tr class="row-odd"><td>server_memory</td> <td>body</td> <td>integer</td> <td>The Memory of server.</td> </tr> <tr class="row-even"><td>server_disk</td> <td>body</td> <td>integer</td> <td>The Disk of the server.</td> </tr> <tr class="row-odd"><td>server_state</td> <td>body</td> <td>string</td> <td>The State of the server.</td> </tr> <tr class="row-even"><td>node_uuid</td> <td>body</td> <td>string</td> <td>The Unique UUID of the node.</td> </tr> <tr class="row-odd"><td>node_hostname</td> <td>body</td> <td>string</td> <td>The Host Name of the node.</td> </tr> <tr class="row-even"><td>node_vcpus</td> <td>body</td> <td>integer</td> <td>The Vcpu of the node.</td> </tr> <tr class="row-odd"><td>node_vcpu_ratio</td> <td>body</td> <td>float</td> <td>The Vcpu ratio of the node.</td> </tr> <tr class="row-even"><td>node_memory</td> <td>body</td> <td>integer</td> <td>The Memory of the node(in MiB).</td> </tr> <tr class="row-odd"><td>node_memory_ratio</td> <td>body</td> <td>float</td> <td>The Memory Ratio of the node.</td> </tr> <tr class="row-even"><td>node_disk</td> <td>body</td> <td>integer</td> <td>The Disk of the node(in GiB).</td> </tr> <tr class="row-odd"><td>node_disk_ratio</td> <td>body</td> <td>float</td> <td>The Disk Ratio of the node.</td> </tr> <tr class="row-even"><td>node_state</td> <td>body</td> <td>string</td> <td>The State of the node. The value is up or down.</td> </tr> </tbody> </table> Example JSON representation of a Data Model: <div class="highlight-javascript notranslate"><div class="highlight"><pre>{ "context": [ { "server_uuid": "1bf91464-9b41-428d-a11e-af691e5563bb", "server_name": "chenke-test1", "server_vcpus": "1", "server_memory": "512", "server_disk": "1", "server_state": "active", "node_uuid": "253e5dd0-9384-41ab-af13-4f2c2ce26112", "node_hostname": "localhost.localdomain", "node_vcpus": "4", "node_vcpu_ratio": "16.0", "node_memory": "16383", "node_memory_ratio": "1.5", "node_disk": "37", "node_disk_ratio": "1.0", "node_state": "up" }, { "server_uuid": "e2cb5f6f-fa1d-4ba2-be1e-0bf02fa86ba4", "server_name": "chenke-test2", "server_vcpus": "1", "server_memory": "512", "server_disk": "1", "server_state": "active", "node_uuid": "253e5dd0-9384-41ab-af13-4f2c2ce26112", "node_hostname": "localhost.localdomain", "node_vcpus": "4", "node_vcpu_ratio": "16.0", "node_memory": "16383", "node_memory_ratio": "1.5", "node_disk": "37", "node_disk_ratio": "1.0", "node_state": "up" } ] } </pre></div> </div> </section> </section> </section> <section id="webhooks"> <h1>Webhooks<a class="headerlink" href="#webhooks" title="Link to this heading">¶</a></h1> <div class="versionadded"> Added in version 1.4. </div> Triggers an event based Audit. <section class="detail-control" id="trigger-event-audit"> <div class="operation-grp "> <div class="row"> <div class="col-md-2"> <div class="operation"> <a name="trigger-event-audit" class="operation-anchor" href="#trigger-event-audit" onclick="window.location.hash = hash;" > </a> POST </div> </div> <div class="col-md-9"> <div class="row"> <div class="endpoint-container"> <div class="row col-md-12">/v1/webhooks/{audit_ident}</div> <div class="row col-md-12">Trigger EVENT Audit</div> </div> </div> </div> <div class="col-md-1"> <button class="btn btn-info btn-sm btn-detail" data-target="#trigger-event-audit-detail" data-toggle="collapse" id="trigger-event-audit-detail-btn" >detail</button> </div> </div> </div></section> <section class="api-detail collapse" id="trigger-event-audit-detail"> Normal response codes: 202 Error codes: 400,404 <section id="id86"> <h3>Request<a class="headerlink" href="#id86" title="Link to this heading">¶</a></h3> <table class="docutils align-default"> <thead> <tr class="row-odd"><th class="head">Name</th> <th class="head">In</th> <th class="head">Type</th> <th class="head">Description</th> </tr> </thead> <tbody> <tr class="row-even"><td>audit_ident</td> <td>path</td> <td>string</td> <td>The UUID or name of the Audit.</td> </tr> </tbody> </table> </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"></a> </div> <div class="row docs-byline bottom"> <div class="docs-updated">this page last updated: 2020-02-17 11:53:46</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> 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>. </div> <div class="col-lg-4 col-md-4 col-sm-4 docs-actions-wrapper">  <a href="#" id="logABugLink2" class="docs-footer-actions"> 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"></button> <button type="button" data-toggle="dropdown" class="btn docs-sidebar-release-select">OpenStack Documentation</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>Infrastructure Optimization API Reference </h4></a> <ul> <li><a class="reference internal" href="#">Watcher API</a></li> <li><a class="reference internal" href="#api-versions">API versions</a><ul> <li><a class="reference internal" href="#list-api-versions">List API versions</a></li> <li><a class="reference internal" href="#show-v1-api">Show v1 API</a></li> </ul> </li> <li><a class="reference internal" href="#audit-templates">Audit Templates</a><ul> <li><a class="reference internal" href="#create-audit-template">Create Audit Template</a></li> <li><a class="reference internal" href="#list-audit-template">List Audit Template</a></li> <li><a class="reference internal" href="#list-audit-template-detailed">List Audit Template Detailed</a></li> <li><a class="reference internal" href="#show-audit-template">Show Audit Template</a></li> <li><a class="reference internal" href="#update-audit-template">Update Audit Template</a></li> <li><a class="reference internal" href="#delete-audit-template">Delete Audit Template</a></li> </ul> </li> <li><a class="reference internal" href="#audits">Audits</a><ul> <li><a class="reference internal" href="#create-audit">Create Audit</a></li> <li><a class="reference internal" href="#list-audit">List Audit</a></li> <li><a class="reference internal" href="#list-audit-detailed">List Audit Detailed</a></li> <li><a class="reference internal" href="#show-audit">Show Audit</a></li> <li><a class="reference internal" href="#cancel-audit">Cancel Audit</a></li> <li><a class="reference internal" href="#update-audit">Update Audit</a></li> <li><a class="reference internal" href="#delete-audit">Delete Audit</a></li> </ul> </li> <li><a class="reference internal" href="#action-plans">Action Plans</a><ul> <li><a class="reference internal" href="#start-action-plan">Start Action Plan</a></li> <li><a class="reference internal" href="#list-action-plan">List Action Plan</a></li> <li><a class="reference internal" href="#list-action-plan-detailed">List Action Plan detailed</a></li> <li><a class="reference internal" href="#show-action-plan">Show Action Plan</a></li> <li><a class="reference internal" href="#cancel-action-plan">Cancel Action Plan</a></li> <li><a class="reference internal" href="#delete-action-plan">Delete Action Plan</a></li> </ul> </li> <li><a class="reference internal" href="#actions">Actions</a><ul> <li><a class="reference internal" href="#list-action">List Action</a></li> <li><a class="reference internal" href="#list-action-detailed">List Action Detailed</a></li> <li><a class="reference internal" href="#show-action">Show Action</a></li> </ul> </li> <li><a class="reference internal" href="#goals">Goals</a><ul> <li><a class="reference internal" href="#list-goal">List Goal</a></li> <li><a class="reference internal" href="#list-goal-detailed">List Goal Detailed</a></li> <li><a class="reference internal" href="#show-goal">Show Goal</a></li> </ul> </li> <li><a class="reference internal" href="#strategies">Strategies</a><ul> <li><a class="reference internal" href="#list-strategy">List Strategy</a></li> <li><a class="reference internal" href="#list-strategy-detailed">List Strategy Detailed</a></li> <li><a class="reference internal" href="#show-strategy">Show Strategy</a></li> <li><a class="reference internal" href="#show-strategy-state">Show Strategy State</a></li> </ul> </li> <li><a class="reference internal" href="#services">Services</a><ul> <li><a class="reference internal" href="#list-service">List Service</a></li> <li><a class="reference internal" href="#list-service-detailed">List Service Detailed</a></li> <li><a class="reference internal" href="#show-service">Show Service</a></li> </ul> </li> <li><a class="reference internal" href="#scoring-engines">Scoring Engines</a><ul> <li><a class="reference internal" href="#list-scoring-engine">List Scoring Engine</a></li> <li><a class="reference internal" href="#list-scoring-engine-detailed">List Scoring Engine Detailed</a></li> <li><a class="reference internal" href="#show-scoring-engine">Show Scoring Engine</a></li> </ul> </li> <li><a class="reference internal" href="#data-model">Data Model</a><ul> <li><a class="reference internal" href="#list-data-model">List Data Model</a></li> </ul> </li> <li><a class="reference internal" href="#webhooks">Webhooks</a><ul> <li><a class="reference internal" href="#trigger-event-audit">Trigger EVENT Audit</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> 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>. </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/watcher/src/api-ref/source" + "/" + sourceFile; /* gitsha, project and bug_tag rely on variables in conf.py */ var gitSha = "SHA: 5f6fbaea56889eaf1bd317f9873f314b716e0ddc"; var repositoryName = "openstack/watcher"; var bugProject = "watcher"; var bugTitle = "Watcher API in Infrastructure Optimization API Reference"; var fieldTags = ""; 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 2020-02-17 11:53:46"; var fieldComment = encodeURI(buildstring) + lineFeed + encodeURI(gitSha) + lineFeed + encodeURI(gitURL) ; logABug(bugTitle, bugProject, fieldComment, fieldTags, repositoryName, useStoryboard); </script> </body> </html>