You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by sr...@apache.org on 2014/09/13 18:47:11 UTC
svn commit: r1624764 [10/11] - in /incubator/falcon: site/
site/0.3-incubating/ site/0.4-incubating/ site/docs/ site/restapi/
site/wiki/ trunk/general/src/site/ trunk/general/src/site/resources/
trunk/general/src/site/resources/images/ trunk/general/sr...
Added: incubator/falcon/site/restapi/InstanceRerun.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/restapi/InstanceRerun.html?rev=1624764&view=auto
==============================================================================
--- incubator/falcon/site/restapi/InstanceRerun.html (added)
+++ incubator/falcon/site/restapi/InstanceRerun.html Sat Sep 13 16:47:09 2014
@@ -0,0 +1,326 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-13
+ | 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="20140913" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/instance/rerun/: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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../FalconDocumentation.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/instance/rerun/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-13</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/instance/rerun/:entity-type/:entity-name<a name="POST_apiinstancererun: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>Rerun a specific instance of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Results of the rerun command.</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>
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "startTime": "2013-10-21T15:10:47-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n",
+ "message": "default\/RERUN\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Added: incubator/falcon/site/restapi/InstanceResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/restapi/InstanceResume.html?rev=1624764&view=auto
==============================================================================
--- incubator/falcon/site/restapi/InstanceResume.html (added)
+++ incubator/falcon/site/restapi/InstanceResume.html Sat Sep 13 16:47:09 2014
@@ -0,0 +1,326 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-13
+ | 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="20140913" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/instance/resume/: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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../FalconDocumentation.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/instance/resume/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-13</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/instance/resume/:entity-type/:entity-name<a name="POST_apiinstanceresume: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>Resume a specific instance of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type can either be a feed or a process.</li>
+<li>:entity-name is name of the entity.</li>
+<li>start is the start time of the instance that you want to refer to</li>
+<li>lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Results of the resume command.</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>
+POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "startTime": "2013-10-21T15:19:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n",
+ "message": "default\/RESUME\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Added: incubator/falcon/site/restapi/InstanceRunning.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/restapi/InstanceRunning.html?rev=1624764&view=auto
==============================================================================
--- incubator/falcon/site/restapi/InstanceRunning.html (added)
+++ incubator/falcon/site/restapi/InstanceRunning.html Sat Sep 13 16:47:09 2014
@@ -0,0 +1,373 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-13
+ | 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="20140913" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/running/: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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../FalconDocumentation.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/running/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-13</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/running/:entity-type/:entity-name<a name="GET_apiinstancerunning: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 a list of instances currently running for a given entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are cluster, feed or process.</li>
+<li>:entity-name Name of the entity.</li>
+<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. Example: filterBy=CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</li></ul></li>
+<li>sortOrder <optional param> Valid options are "asc" and "desc"</li>
+<li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li>
+<li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>List of instances currently running.</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/running/process/SampleProcess?colo=*
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "startTime": "2013-10-21T14:39:28-07:00",
+ "cluster": "primary-cluster",
+ "status": "RUNNING",
+ "instance": "2012-04-03T06:00Z"
+ }
+ ],
+ "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n",
+ "message": "default\/Running Instances\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "RUNNING",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Added: incubator/falcon/site/restapi/InstanceStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/restapi/InstanceStatus.html?rev=1624764&view=auto
==============================================================================
--- incubator/falcon/site/restapi/InstanceStatus.html (added)
+++ incubator/falcon/site/restapi/InstanceStatus.html Sat Sep 13 16:47:09 2014
@@ -0,0 +1,382 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-13
+ | 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="20140913" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/status/: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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../FalconDocumentation.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">
+ <a href="../index.html" title="Falcon">
+ Falcon</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/status/:entity-type/:entity-name</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2014-09-13</li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/status/:entity-type/:entity-name<a name="GET_apiinstancestatus: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 status of a specific instance of an entity.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:entity-type Valid options are cluster, 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'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<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. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
+<ul>
+<li>Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.</li>
+<li>Query will do an AND among filterBy fields.</li></ul></li>
+<li>orderBy <optional param> Field by which results should be ordered.
+<ul>
+<li>Supports ordering by "status","startTime","endTime","cluster".</li></ul></li>
+<li>sortOrder <optional param> Valid options are "asc" and "desc"</li>
+<li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li>
+<li>numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Status of the specified instance.</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/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+<div class="section">
+<h4>Rest Call<a name="Rest_Call"></a></h4>
+<div class="source">
+<pre>
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "details": "",
+ "endTime": "2013-10-21T14:42:26-07:00",
+ "startTime": "2013-10-21T14:41:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T08:00Z"
+ },
+ ],
+
+ "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n",
+ "message": "default\/STATUS\n",
+ "status": "SUCCEEDED"
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>
Added: incubator/falcon/site/restapi/InstanceSummary.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/restapi/InstanceSummary.html?rev=1624764&view=auto
==============================================================================
--- incubator/falcon/site/restapi/InstanceSummary.html (added)
+++ incubator/falcon/site/restapi/InstanceSummary.html Sat Sep 13 16:47:09 2014
@@ -0,0 +1,335 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-09-13
+ | 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="20140913" />
+ <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="topBarEnabled">
+
+
+
+
+
+ <div id="topbar" class="navbar navbar-fixed-top ">
+ <div class="navbar-inner">
+ <div class="container" style="width: 68%;"><div class="nav-collapse">
+
+
+ <ul class="nav">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Falcon <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../index.html" title="About">About</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Index" title="Wiki">Wiki</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/News" title="News">News</a>
+</li>
+
+ <li> <a href="https://git-wip-us.apache.org/repos/asf/incubator-falcon.git" title="Git">Git</a>
+</li>
+
+ <li> <a href="https://svn.apache.org/repos/asf/incubator/falcon" title="Svn">Svn</a>
+</li>
+
+ <li> <a href="https://issues.apache.org/jira/browse/FALCON" title="Jira">Jira</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" title="Powered by">Powered by</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" title="Acknowledgements">Acknowledgements</a>
+</li>
+
+ <li> <a href="http://blogs.apache.org/falcon/" title="Blog">Blog</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Project Information <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../project-info.html" title="Summary">Summary</a>
+</li>
+
+ <li> <a href="../mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+</li>
+
+ <li> <a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" title="IRC">IRC</a>
+</li>
+
+ <li> <a href="../team-list.html" title="Team">Team</a>
+</li>
+
+ <li> <a href="../issue-tracking.html" title="Issue Tracking">Issue Tracking</a>
+</li>
+
+ <li> <a href="../source-repository.html" title="Source Repository">Source Repository</a>
+</li>
+
+ <li> <a href="../license.html" title="License">License</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Releases <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.3-incubating" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="http://www.apache.org/dist/incubator/falcon/0.4-incubating" title="0.4-incubating">0.4-incubating</a>
+</li>
+
+ <li> <a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" title="Roadmap">Roadmap</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../GettingStarted.html" title="current">current</a>
+</li>
+
+ <li> <a href="../0.3-incubating/index.html" title="0.3-incubating">0.3-incubating</a>
+</li>
+
+ <li> <a href="../0.4-incubating/index.html" title="0.4-incubating">0.4-incubating</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Resources <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="../slides/falcon-overview.html" title="Overview">Overview</a>
+</li>
+
+ <li> <a href="../slides/falcon-user-guide.html" title="User Guide">User Guide</a>
+</li>
+
+ <li> <a href="../GettingStarted.html" title="Getting Started">Getting Started</a>
+</li>
+
+ <li> <a href="../FalconDocumentation.html" title="Architecture">Architecture</a>
+</li>
+
+ <li> <a href="../InstallationSteps.html" title="Installation">Installation</a>
+</li>
+
+ <li> <a href="../OnBoarding.html" title="On Boarding">On Boarding</a>
+</li>
+
+ <li> <a href="../EntitySpecification.html" title="Entity Specification">Entity Specification</a>
+</li>
+
+ <li> <a href="../FalconCLI.html" title="Client (Falcon CLI)">Client (Falcon CLI)</a>
+</li>
+
+ <li> <a href="../restapi/ResourceList.html" title="Rest API">Rest API</a>
+</li>
+
+ <li> <a href="../HiveIntegration.html" title="Hive Integration">Hive Integration</a>
+</li>
+
+ <li> <a href="../Security.html" title="Security">Security</a>
+</li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">ASF <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+
+ <li> <a href="http://www.apache.org/foundation/how-it-works.html" title="How Apache Works">How Apache Works</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/" title="Foundation">Foundation</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsoring Apache">Sponsoring Apache</a>
+</li>
+
+ <li> <a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a>
+</li>
+ </ul>
+ </li>
+ </ul>
+
+ <form id="search-form" action="http://www.google.com/search" method="get" class="navbar-search pull-right" >
+
+ <input value="http://falcon.incubator.apache.org" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=search-form"></script>
+
+
+
+
+
+ <iframe src="http://www.facebook.com/plugins/like.php?href=http://falcon.incubator.apache.org/falcon-website-general&send=false&layout=button_count&show-faces=false&action=like&colorscheme=dark"
+ scrolling="no" frameborder="0"
+ style="border:none; width:80px; height:20px; margin-top: 10px;" class="pull-right" ></iframe>
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+ <ul class="nav pull-right"><li style="margin-top: 10px;">
+
+ <div class="g-plusone" data-href="http://falcon.incubator.apache.org/falcon-website-general" data-size="medium" width="60px" align="right" ></div>
+
+ </li></ul>
+
+
+ </div>
+
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="../../index.html" id="bannerLeft">
+ <img src="../images/falcon-logo.png" alt="Falcon" width="200px" height="45px"/>
+ </a>
+ </div>
+ <div class="pull-right"> <a href="http://incubator.apache.org" id="bannerRight">
+ <img src="../images/apache-incubator-logo.png" alt="Apache Incubator"/>
+ </a>
+ </div>
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://www.apache.org" class="externalLink" title="Apache">
+ Apache</a>
+ </li>
+ <li class="divider ">/</li>
+ <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: 2014-09-13</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 cluster, 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'.
+<ul>
+<li>By default, it is set to (end - (10 * entityFrequency)).</li></ul></li>
+<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
+<ul>
+<li>Default is set to now.</li></ul></li>
+<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></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",
+ "key2":"value"
+ }
+ }
+ }
+ }
+}
+
+</pre></div></div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container">
+ <div class="row span12">Copyright © 2013-2014
+ <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>