You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@falcon.apache.org by ve...@apache.org on 2014/12/06 07:11:43 UTC
svn commit: r1643497 [9/11] - in /incubator/falcon/site: ./ 0.3-incubating/
0.4-incubating/ 0.5-incubating/ 0.5-incubating/restapi/ 0.6-incubating/
0.6-incubating/css/ 0.6-incubating/images/ 0.6-incubating/images/logos/
0.6-incubating/images/profiles/ ...
Added: incubator/falcon/site/0.6-incubating/restapi/InstanceLogs.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceLogs.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceLogs.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceLogs.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,225 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/logs/: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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/logs/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/logs/:entity-type/:entity-name<a name="GET_apiinstancelogs: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 log 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>runId <optional param> Run Id.</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>Log of 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/logs/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": [
+ {
+ "actions": [
+ {
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log",
+ "status": "SUCCEEDED",
+ "action": "pig"
+ }
+ ],
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ }
+ ],
+ "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\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/logs/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": [
+ {
+ "actions": [
+ {
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/pig_SUCCEEDED.log",
+ "status": "SUCCEEDED",
+ "action": "pig"
+ }
+ ],
+ "details": "",
+ "endTime": "2013-10-21T14:40:26-07:00",
+ "startTime": "2013-10-21T14:39:56-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/000\/oozie.log",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T07:00Z"
+ },
+ {
+ "actions": [
+ {
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/001\/pig_SUCCEEDED.log",
+ "status": "SUCCEEDED",
+ "action": "pig"
+ }
+ ],
+ "details": "",
+ "endTime": "2013-10-21T14:42:27-07:00",
+ "startTime": "2013-10-21T14:41:57-07:00",
+ "cluster": "primary-cluster",
+ "logFile": "http:\/\/localhost:50070\/data\/apps\/falcon\/staging\/falcon\/workflows\/process\/SampleProcess\/logs\/job-2012-04-03-07-00\/001\/oozie.log",
+ "status": "SUCCEEDED",
+ "instance": "2012-04-03T08:00Z"
+ }
+ ],
+ "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\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/0.6-incubating/restapi/InstanceParams.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceParams.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceParams.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceParams.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,194 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET /api/instance/params/: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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/params/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET /api/instance/params/:entity-type/:entity-name<a name="GET_apiinstanceparams: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 along with the information for workflow params.</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>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/0.6-incubating/restapi/InstanceRerun.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceRerun.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceRerun.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceRerun.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,149 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/instance/rerun/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </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 instances 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>end is the end 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=2013-04-03T07:00Z&end=2014-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/0.6-incubating/restapi/InstanceResume.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceResume.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceResume.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceResume.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,149 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/instance/resume/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </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 suspended instances 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(s) that you want to refer to</li>
+<li>end is the end time of the instance(s) 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&end=2014-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/0.6-incubating/restapi/InstanceRunning.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceRunning.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceRunning.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceRunning.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,195 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/running/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </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/0.6-incubating/restapi/InstanceStatus.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceStatus.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceStatus.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceStatus.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,211 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/status/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </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 along with job urls for all actions of user workflow and non-succeeded actions of the main-workflow.</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 https://localhost:15443/api/instance/status/process/WordCount?start=2014-11-04T16:00Z&colo=*
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "instances": [
+ {
+ "details": "",
+ "endTime": "2014-11-05T16:08:10+05:30",
+ "startTime": "2014-11-05T16:07:29+05:30",
+ "cluster": "local",
+ "logFile": "http:\/\/localhost:11000\/oozie?job=0000011-141105155430303-oozie-oozi-W",
+ "status": "SUCCEEDED",
+ "instance": "2014-11-04T16:00Z",
+ "actions": [
+ {
+ "action": "wordcount-mr",
+ "status": "SUCCEEDED",
+ "logFile": "http:\/\/localhost:50030\/jobdetails.jsp?jobid=job_201411051553_0005"
+ }
+ ]
+ }
+ ],
+ "requestId": "default\/b9fc3cba-1b46-4d1f-8196-52c795ea3580\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/0.6-incubating/restapi/InstanceSummary.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceSummary.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceSummary.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceSummary.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,157 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET /api/instance/summary/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </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>
Added: incubator/falcon/site/0.6-incubating/restapi/InstanceSuspend.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/InstanceSuspend.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/InstanceSuspend.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/InstanceSuspend.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,150 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - POST /api/instance/suspend/: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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">POST /api/instance/suspend/:entity-type/:entity-name</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>POST /api/instance/suspend/:entity-type/:entity-name<a name="POST_apiinstancesuspend: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>Suspend instances 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(s) that you want to refer to</li>
+<li>end is the end time of the instance(s) 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 suspend 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/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-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-21T15:15:01-07:00",
+ "startTime": "2013-10-21T15:14:32-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\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n",
+ "message": "default\/SUSPEND\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/0.6-incubating/restapi/MetadataList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/MetadataList.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/MetadataList.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/MetadataList.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,135 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/discovery/:type/list</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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/metadata/discovery/:type/list</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/discovery/:type/list<a name="GET_apimetadatadiscovery:typelist"></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 all dimensions of specified type.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines</li>
+<li>cluster <optional query param> Show dimensions related to this cluster.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>List of dimensions that match requested type [and cluster].</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/metadata/discovery/process_entity/list?cluster=primary-cluster
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "results": ["sampleIngestProcess","testProcess","anotherProcess"],
+ "totalSize": 3
+}
+
+</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/0.6-incubating/restapi/MetadataRelations.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/MetadataRelations.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/MetadataRelations.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/MetadataRelations.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,152 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - GET api/metadata/discovery/:dimension-type/:dimension-name/relations</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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">GET api/metadata/discovery/:dimension-type/:dimension-name/relations</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h3>GET api/metadata/discovery/:dimension-type/:dimension-name/relations<a name="GET_apimetadatadiscovery:dimension-type:dimension-namerelations"></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 all relations of a specific dimension.</p></div>
+<div class="section">
+<h3>Parameters<a name="Parameters"></a></h3>
+<p></p>
+<ul>
+<li>:type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines</li>
+<li>:name Name of the dimension.</li></ul></div>
+<div class="section">
+<h3>Results<a name="Results"></a></h3>
+<p>Get all relations of a specific dimension.</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/metadata/discovery/process_entity/sample-process/relations
+
+</pre></div></div>
+<div class="section">
+<h4>Result<a name="Result"></a></h4>
+<div class="source">
+<pre>
+{
+ "timestamp":"2014-09-09T01:31Z",
+ "userWorkflowEngine":"pig",
+ "name":"sample-process",
+ "type":"PROCESS_ENTITY",
+ "userWorkflowName":"imp-click-join-workflow",
+ "version":"1.0.9",
+ "inVertices":[
+ {"name":"clicks-feed","type":"FEED_ENTITY","label":"input"},
+ {"name":"impression-feed","type":"FEED_ENTITY","label":"input"},
+ {"name":"sample-process\/2014-01-01T01:00Z","type":"PROCESS_INSTANCE","label":"instance-of"}
+ ],
+ "outVertices":[
+ {"name":"Critical","type":"TAGS","label":"classified-as"},
+ {"name":"testPipeline","type":"PIPELINES","label":"pipeline"},
+ {"name":"primary-cluster","type":"CLUSTER_ENTITY","label":"runs-on"},
+ {"name":"imp-click-join2","type":"FEED_ENTITY","label":"output"},
+ {"name":"imp-click-join1","type":"FEED_ENTITY","label":"output"},
+ {"name":"falcon-user","type":"USER","label":"owned-by"}
+ ]
+}
+
+</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/0.6-incubating/restapi/ResourceList.html
URL: http://svn.apache.org/viewvc/incubator/falcon/site/0.6-incubating/restapi/ResourceList.html?rev=1643497&view=auto
==============================================================================
--- incubator/falcon/site/0.6-incubating/restapi/ResourceList.html (added)
+++ incubator/falcon/site/0.6-incubating/restapi/ResourceList.html Sat Dec 6 06:11:41 2014
@@ -0,0 +1,305 @@
+<!DOCTYPE html>
+<!--
+ | Generated by Apache Maven Doxia at 2014-12-05
+ | 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="20141205" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Falcon - RESTful Resources</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>
+
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <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="../index.html" title="Home">
+ Home</a>
+ </li>
+ <li class="divider ">/</li>
+ <li class="">RESTful Resources</li>
+
+
+
+
+
+ <li class="pull-right"> <a href="http://s.apache.org/falcon-0.5-release-notes" class="externalLink" title="Released: 2014-09-22">
+ Released: 2014-09-22</a>
+ </li>
+
+ <li class="divider pull-right">|</li>
+
+ <li class="pull-right"> <a href="http://www.apache.org/dist/incubator/falcon" class="externalLink" title="0.5-incubating">
+ 0.5-incubating</a>
+ </li>
+
+ </ul>
+ </div>
+
+
+
+ <div id="bodyColumn" >
+
+ <div class="section">
+<h2>RESTful Resources<a name="RESTful_Resources"></a></h2></div>
+<div class="section">
+<h3>Resource List<a name="Resource_List"></a></h3>
+<p></p>
+<ul>
+<li><a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a></li>
+<li><a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a></li>
+<li><a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a></li>
+<li><a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a></li>
+<li><a href="#REST_Call_on_Metadata_Resource">REST Call on Metadata Resource</a></li></ul></div>
+<div class="section">
+<h3>Authentication<a name="Authentication"></a></h3>
+<p>When security is off (Pseudo/Simple), the authenticated user is the username specified in the user.name query parameter. If the user.name parameter is not set, the server may either set the authenticated user to a default web user, if there is any, or return an error response.</p>
+<p>When security is on (kerberos), authentication is performed by Kerberos SPNEGO.</p>
+<p>Below are examples using the curl command tool.</p>
+<p>Authentication when security is off (Pseudo/Simple):</p>
+<div class="source">
+<pre>
+curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..."
+
+</pre></div>
+<p>Authentication using Kerberos SPNEGO when security is on:</p>
+<div class="source">
+<pre>
+curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..."
+
+</pre></div>
+<p>See also: <a href="./../Security.twiki.html">Security in Falcon</a></p></div>
+<div class="section">
+<h3>REST Call on Admin Resource<a name="REST_Call_on_Admin_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AdminStack.html">api/admin/stack</a></td>
+<td>Get stack of the server</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AdminVersion.html">api/admin/version</a></td>
+<td>Get version of the server</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AdminConfig.html">api/admin/config/:config-type</a></td>
+<td>Get configuration information of the server</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Entity Resource<a name="REST_Call_on_Entity_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntityValidate.html">api/entities/validate/:entity-type</a></td>
+<td>Validate the entity</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./EntitySubmit.html">api/entities/submit/:entity-type</a></td>
+<td>Submit the entity</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntityUpdate.html">api/entities/update/:entity-type/:entity-name</a></td>
+<td>Update the entity</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./EntitySubmitAndSchedule.html">api/entities/submitAndSchedule/:entity-type</a></td>
+<td>Submit & Schedule the entity</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntitySchedule.html">api/entities/schedule/:entity-type/:entity-name</a></td>
+<td>Schedule the entity</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./EntitySuspend.html">api/entities/suspend/:entity-type/:entity-name</a></td>
+<td>Suspend the entity</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./EntityResume.html">api/entities/resume/:entity-type/:entity-name</a></td>
+<td>Resume the entity</td></tr>
+<tr class="a">
+<td>DELETE</td>
+<td><a href="./EntityDelete.html">api/entities/delete/:entity-type/:entity-name</a></td>
+<td>Delete the entity</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityStatus.html">api/entities/status/:entity-type/:entity-name</a></td>
+<td>Get the status of the entity</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./EntityDefinition.html">api/entities/definition/:entity-type/:entity-name</a></td>
+<td>Get the definition of the entity</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityList.html">api/entities/list/:entity-type</a></td>
+<td>Get the list of entities</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./EntitySummary.html">api/entities/summary/:entity-type/:cluster</a></td>
+<td>Get instance summary of all entities</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./EntityDependencies.html">api/entities/dependencies/:entity-type/:entity-name</a></td>
+<td>Get the dependencies of the entity</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Feed and Process Instances<a name="REST_Call_on_Feed_and_Process_Instances"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceRunning.html">api/instance/running/:entity-type/:entity-name</a></td>
+<td>List of running instances.</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./InstanceList.html">api/instance/list/:entity-type/:entity-name</a></td>
+<td>List of instances</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceStatus.html">api/instance/status/:entity-type/:entity-name</a></td>
+<td>Status of a given instance</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./InstanceKill.html">api/instance/kill/:entity-type/:entity-name</a></td>
+<td>Kill a given instance</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./InstanceSuspend.html">api/instance/suspend/:entity-type/:entity-name</a></td>
+<td>Suspend a running instance</td></tr>
+<tr class="a">
+<td>POST</td>
+<td><a href="./InstanceResume.html">api/instance/resume/:entity-type/:entity-name</a></td>
+<td>Resume a given instance</td></tr>
+<tr class="b">
+<td>POST</td>
+<td><a href="./InstanceRerun.html">api/instance/rerun/:entity-type/:entity-name</a></td>
+<td>Rerun a given instance</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./InstanceLogs.html">api/instance/logs/:entity-type/:entity-name</a></td>
+<td>Get logs of a given instance</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./InstanceSummary.html">api/instance/summary/:entity-type/:entity-name</a></td>
+<td>Return summary of instances for an entity</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Metadata Lineage Resource<a name="REST_Call_on_Metadata_Lineage_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./Graph.html">api/metadata/lineage/serialize</a></td>
+<td>dump the graph</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AllVertices.html">api/metadata/lineage/vertices/all</a></td>
+<td>get all vertices</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./Vertices.html">api/metadata/lineage/vertices?key=:key&value=:value</a></td>
+<td>get all vertices for a key index</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Vertex.html">api/metadata/lineage/vertices/:id</a></td>
+<td>get the vertex with the specified id</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./VertexProperties.html">api/metadata/lineage/vertices/properties/:id?relationships=:true</a></td>
+<td>get the properties of the vertex with the specified id</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./AdjacentVertices.html">api/metadata/lineage/vertices/:id/:direction</a></td>
+<td>get the adjacent vertices or edges of the vertex with the specified direction</td></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./AllEdges.html">api/metadata/lineage/edges/all</a></td>
+<td>get all edges</td></tr>
+<tr class="a">
+<td>GET</td>
+<td><a href="./Edge.html">api/metadata/lineage/edges/:id</a></td>
+<td>get the edge with the specified id</td></tr></table></div>
+<div class="section">
+<h3>REST Call on Metadata Discovery Resource<a name="REST_Call_on_Metadata_Discovery_Resource"></a></h3>
+<p></p>
+<table border="0" class="table table-striped">
+<tr class="a">
+<th>Call Type</th>
+<th>Resource</th>
+<th>Description</th></tr>
+<tr class="b">
+<td>GET</td>
+<td><a href="./MetadataList.html">api/metadata/discovery/:dimension-type/list</a></td>
+<td>list of dimensions</td></tr>
+<tr class="a">
+<td>GET</td>
+<td>[MetadataRelations][api/metadata/discovery/:dimension-type/:dimension-name/relations]]</td>
+<td>Return all relations of a dimension</td></tr></table></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>