| <!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/instance/summary/:entity-type/:entity-name</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/instance/summary/:entity-type/:entity-name</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/instance/summary/:entity-type/:entity-name<a name="GET_apiinstancesummary:entity-type:entity-name"></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> |
| <p>Get summary of instance/instances of an entity.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:entity-type Valid options are feed or process.</li> |
| <li>:entity-name Name of the entity.</li> |
| <li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* By default, it is set to (end - (10 * entityFrequency)). |
| <ul> |
| <li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* Default is set to now. |
| <ul> |
| <li>colo <optional param> Colo on which the query should be run.</li> |
| <li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li> |
| <li>filterBy <optional param> Filter results by list of field:value pairs.</li></ul>Example1: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster Example2: filterBy=Status:RUNNING,Status:KILLED * Supported filter fields are STATUS, CLUSTER * Query will do an AND among filterBy fields. |
| <ul> |
| <li>orderBy <optional param> Field by which results should be ordered.</li></ul>* Supports ordering by "cluster". |
| <ul> |
| <li>sortOrder <optional param> Valid options are "asc" and "desc"</li></ul>Example: orderBy=cluster sortOrder=asc |
| <ul> |
| <li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>Summary of the instances over the specified time range</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/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "status":"SUCCEEDED", |
| "message":"default/SUMMARY\n", |
| "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n", |
| "instancesSummary": |
| { |
| "cluster":"local", |
| "map": |
| { |
| "entry": |
| { |
| "key":"SUCCEEDED", |
| "value":"value" |
| } |
| } |
| } |
| } |
| } |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET https://localhost:16443/api/instance/summary/process/WordCount?filterBy=Status:KILLED,Status:RUNNING&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=* |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "status":"SUCCEEDED", |
| "message":"local/SUMMARY\n", |
| "requestId":"local/1246061948@qtp-1059149611-5 - 34d8c3bb-f461-4fd5-87cd-402c9c6b1ed2\n", |
| "instancesSummary":[ |
| { |
| "cluster":"local", |
| "map":{ |
| "entry":{ |
| "key":"RUNNING", |
| "value":"1" |
| }, |
| "entry":{ |
| "key":"KILLED", |
| "value":"1" |
| } |
| } |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET https://localhost:16443/api/instance/summary/process/WordCount?orderBy=cluster&sortOrder=asc&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*&doAs=joe |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "status":"SUCCEEDED", |
| "message":"local/SUMMARY\n", |
| "requestId":"local/1246061948@qtp-1059149611-5 - 42e2040d-6b6e-4bfd-a090-83db5ed1a429\n", |
| "instancesSummary":[ |
| { |
| "cluster":"local", |
| "map":{ |
| "entry":{ |
| "key":"SUCCEEDED", |
| "value":"6" |
| }, |
| "entry":{ |
| "key":"KILLED", |
| "value":"1" |
| } |
| } |
| } |
| ] |
| } |
| |
| </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> |