| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2018-03-12 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20180312" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Falcon - GET /api/entities/sla-alert/:entity-type</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| |
| <script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> |
| </div> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="../index.html" title="Falcon"> |
| Falcon</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class="">GET /api/entities/sla-alert/:entity-type</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> |
| <li id="projectVersion" class="pull-right">Version: 0.11</li> |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| <div class="section"> |
| <h3>GET /api/entities/sla-alert/:entity-type<a name="GET_apientitiessla-alert:entity-type"></a></h3> |
| <p></p> |
| <ul> |
| <li><a href="#Description">Description</a></li> |
| <li><a href="#Parameters">Parameters</a></li> |
| <li><a href="#Results">Results</a></li> |
| <li><a href="#Examples">Examples</a></li></ul></div> |
| <div class="section"> |
| <h3>Description<a name="Description"></a></h3> |
| <div class="source"> |
| <pre> |
| Since: 0.8 |
| |
| </pre></div> |
| <p>This command lists all the feed instances which have missed sla and are still not available. If a feed instance missed sla but is now available, then it will not be reported in results. The purpose of this API is alerting and hence it doesn't return feed instances which missed SLA but are available as they don't require any action.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:entity-type Only valid option is feed.</li> |
| <li>entity-name <optional param> parameter to restrict results for a particular feed using feed's name.</li> |
| <li>start <mandatory param> start of the time window for nominal instances, inclusive.</li> |
| <li>end <mandatory param> end of the time window for nominal instances to be considered, default is treated as current time.</li> |
| <li>colo <optional param> name of the colo</li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>Pending feed instances which missed SLA.</p></div> |
| <div class="section"> |
| <h3>Examples<a name="Examples"></a></h3></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/entities/sla-alert/feed?colo=*&start=2012-04-03T07:00Z |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "status":"SUCCEEDED", |
| "message":"default/Success!\n", |
| "requestId":"default/885720178@qtp-495452957-6 - f6e82e9b-d23f-466b-82df-4fb8293ce9cf\n", |
| "instances":[ |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:33:00+05:30","tags":"Missed SLA High"}, |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:29:00+05:30","tags":"Missed SLA High"}, |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:35:00+05:30","tags":"Missed SLA Low"}, |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:30:00+05:30","tags":"Missed SLA High"}, |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:34:00+05:30","tags":"Missed SLA High"}, |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:31:00+05:30","tags":"Missed SLA High"}, |
| {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:32:00+05:30","tags":"Missed SLA High"} |
| ] |
| } |
| |
| </pre></div> |
| <p>In case there are no pending instances which have missed sla the response will be like below:</p> |
| <div class="source"> |
| <pre> |
| { |
| "status":"SUCCEEDED", |
| "message":"default/Success!\n", |
| "requestId":"default/979808239@qtp-1243851750-3 - 8c7396c0-efe2-43e9-9aea-7ae6afea5fd6\n" |
| } |
| |
| </pre></div></div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2013-2018 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
