Added: falcon/site/0.9/restapi/InstanceList.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceList.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceList.html (added) +++ falcon/site/0.9/restapi/InstanceList.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,207 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/list/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/list/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/list/:entity-type/:entity-name<a name="GET_apiinstancelist: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 list of all instances of 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>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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>List of instances of given entity.</p> +<p>The possible instance status returned and its meaning are as follows:</p> +<ul> +<li>WAITING - The instance is waiting for the corresponding data(feed) instances to become available.</li> +<li>READY - The instance is ready to be scheduled. But, is waiting for scheduling conditions to be met. For example, limitation on number of instances that can be run in parallel.</li> +<li>RUNNING - The instance is running on the workflow engine.</li> +<li>FAILED - The instance has failed during execution.</li> +<li>KILLED - The instance has been killed either manually or by the system.</li> +<li>SUCCEEDED - The instance has executed successfully.</li> +<li>SKIPPED - This instance was not executed, but was skipped. For example, when the execution order is LAST_ONLY, the older instances are skipped.</li> +<li>ERROR - There was error while executing this instance on the workflow engine.</li> +<li>UNDEFINED - The status of the instance could not be determined.</li></ul></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/list/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/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/InstanceLogs.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceLogs.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceLogs.html (added) +++ falcon/site/0.9/restapi/InstanceLogs.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,217 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/logs/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/InstanceParams.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceParams.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceParams.html (added) +++ falcon/site/0.9/restapi/InstanceParams.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,123 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/params/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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 the params passed to the workflow for an instance of feed/process.</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 should be the nominal time of the instance for which you want the params to be returned</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>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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> +http://userqa.user.com:16000/api/instance/params/process/Sample-Process?start=2014-10-01T11:00Z&colo=*&doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<p>{ "status": "SUCCEEDED", "message": "ua1/PARAMS\n", "requestId": "ua1/807e9fe6-ba60-490e-b720-f8dc8b92063e\n", "instances": [ { "instance": "2014-10-01T11:00Z", "status": "RUNNING", "logFile": "http://spyke.user.com:11000/oozie?job=0000211-141117203201940-oozie-oozi-W", "cluster": "sample-cluster", "startTime": "2014-11-19T19:46:29+08:00", "details": "", "actions": [ { "action": "succeeded-post-processing", "status": "RUNNING", "logFile": "http://spyke.user.com:50030/jobdetails.jsp?jobid=job_201411071450_1052" } ], "params": { "entry": {"key": "jobTracker", "value": "10.16.114.113:8021"}, "entry":{"key":"falconInputNames","value":"IGNORE"}, "entry":{"key":"shouldRecord","value":"false"}, "entry":{"key":"timeStamp","value":"2014-11-19-11-46"}, "entry":{"key":"falconInPaths","value":"IGNORE"}, "entry":{"key":"broker.url","value":"tcp://localhost:61616"}, "entry":{"key":"feedNames","value":"NONE"}, "entry":{"key":"falcon.libpath","value":"/path/falcon/sample/lib& quot;}, "entry":{"key":"ENTITY_PATH","value":"/path/falcon/staging/falcon/workflows/process/Sample-Process/9506be19980e0e6fdb709e1baffff_1416397585511/DEFAULT"}, "entry":{"key":"entityType","value":"process"}, "entry":{"key":"nominalTime","value":"2014-10-01-11-00"}, "entry":{"key":"feedInstancePaths","value":"IGNORE"}, "entry":{"key":"oozie.bundle.application.path","value":"hdfs://10.16.104.13:8020/path/falcon/staging/falcon/workflows/process/Sample-Process/9506be19980e0e669709e1baffff_1416397585511"}, "entry":{"key":"logDir","value":"hdfs://10.16.104.13:8020/path/falcon/staging/falcon/workflows/pr ocess/Sample-Process/logs"}, "entry":{"key":"userWorkflowEngine","value":"oozie"}, "entry":{"key":"broker.ttlInMins","value":"4320"}, "entry":{"key":"oozie.use.system.libpath","value":"true"}, "entry":{"key":"queueName","value":"reports"}, "entry":{"key":"falconDataOperation","value":"GENERATE"}, "entry":{"key":"oozie.wf.external.id","value":"Sample-Process/DEFAULT/2014-10-01T11:00Z"}, "entry":{"key":"workflowEngineUrl","value":"http://10.11.100.10:11000/oozie/"}, "entry":{"key":"user BrokerImplClass","value":"org.apache.activemq.ActiveMQConnectionFactory"}, "entry":{"key":"ENTITY_NAME","value":"FALCON_PROCESS_DEFAULT_Sample-Process"}, "entry":{"key":"broker.impl.class","value":"org.apache.activemq.ActiveMQConnectionFactory"}, "entry":{"key":"userWorkflowName","value":"Sample-workflow"}, "entry":{"key":"entityName","value":"Sample-Process"}, "entry":{"key":"srcClusterName","value":"NA"}, "entry":{"key":"userBrokerUrl","value":"tcp://localhost:61616?daemon=true"}, "entry":{"key":"falconInputFeeds","va lue":"NONE"}, "entry":{"key":"user.name","value":"sampleuser"}, "entry":{"key":"threedaysback","value":"2014-09-28"}, "entry":{"key":"userWorkflowVersion","value":"1.0"} } } ] }</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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: falcon/site/0.9/restapi/InstanceRerun.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceRerun.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceRerun.html (added) +++ falcon/site/0.9/restapi/InstanceRerun.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,168 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/instance/rerun/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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. On issuing a rerun, by default the execution resumes from the last failed node in the workflow.</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> +<li>force <optional param> can be used to forcefully rerun the entire instance.</li> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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 class="source"> +<pre> +POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z&force=true&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/InstanceResume.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceResume.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceResume.html (added) +++ falcon/site/0.9/restapi/InstanceResume.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,140 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/instance/resume/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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&doAs=joe + +</pre></div> +<p>---+++ Result</p> +<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-2016 + <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: falcon/site/0.9/restapi/InstanceRunning.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceRunning.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceRunning.html (added) +++ falcon/site/0.9/restapi/InstanceRunning.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,187 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/running/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/InstanceStatus.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceStatus.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceStatus.html (added) +++ falcon/site/0.9/restapi/InstanceStatus.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,203 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/status/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/InstanceSummary.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceSummary.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceSummary.html (added) +++ falcon/site/0.9/restapi/InstanceSummary.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,219 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/summary/:entity-type/:entity-name</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/instance/summary/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/summary/:entity-type/:entity-name<a name="GET_apiinstancesummary:entity-type:entity-name"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<p>Get summary of instance/instances of an entity.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type Valid options are feed or process.</li> +<li>:entity-name Name of the entity.</li> +<li>start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* By default, it is set to (end - (10 * entityFrequency)). +<ul> +<li>end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.</li></ul>* Default is set to now. +<ul> +<li>colo <optional param> Colo on which the query should be run.</li> +<li>lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li> +<li>filterBy <optional param> Filter results by list of field:value pairs.</li></ul>Example1: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster Example2: filterBy=Status:RUNNING,Status:KILLED * Supported filter fields are STATUS, CLUSTER * Query will do an AND among filterBy fields. +<ul> +<li>orderBy <optional param> Field by which results should be ordered.</li></ul>* Supports ordering by "cluster". +<ul> +<li>sortOrder <optional param> Valid options are "asc" and "desc"</li></ul>Example: orderBy=cluster sortOrder=asc +<ul> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Summary of the instances over the specified time range</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"default/SUMMARY\n", + "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n", + "instancesSummary": + { + "cluster":"local", + "map": + { + "entry": + { + "key":"SUCCEEDED", + "value":"value" + } + } + } + } +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET https://localhost:16443/api/instance/summary/process/WordCount?filterBy=Status:KILLED,Status:RUNNING&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=* + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"local/SUMMARY\n", + "requestId":"local/1246061948@qtp-1059149611-5 - 34d8c3bb-f461-4fd5-87cd-402c9c6b1ed2\n", + "instancesSummary":[ + { + "cluster":"local", + "map":{ + "entry":{ + "key":"RUNNING", + "value":"1" + }, + "entry":{ + "key":"KILLED", + "value":"1" + } + } + } + ] +} + +</pre></div></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET https://localhost:16443/api/instance/summary/process/WordCount?orderBy=cluster&sortOrder=asc&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*&doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"local/SUMMARY\n", + "requestId":"local/1246061948@qtp-1059149611-5 - 42e2040d-6b6e-4bfd-a090-83db5ed1a429\n", + "instancesSummary":[ + { + "cluster":"local", + "map":{ + "entry":{ + "key":"SUCCEEDED", + "value":"6" + }, + "entry":{ + "key":"KILLED", + "value":"1" + } + } + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2016 + <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: falcon/site/0.9/restapi/InstanceSuspend.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/InstanceSuspend.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/InstanceSuspend.html (added) +++ falcon/site/0.9/restapi/InstanceSuspend.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,142 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">POST /api/instance/suspend/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/MetadataList.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/MetadataList.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/MetadataList.html (added) +++ falcon/site/0.9/restapi/MetadataList.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,127 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET api/metadata/discovery/:type/list</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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&doAs=joe + +</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-2016 + <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: falcon/site/0.9/restapi/MetadataRelations.html URL: http://svn.apache.org/viewvc/falcon/site/0.9/restapi/MetadataRelations.html?rev=1730448&view=auto ============================================================================== --- falcon/site/0.9/restapi/MetadataRelations.html (added) +++ falcon/site/0.9/restapi/MetadataRelations.html Mon Feb 15 05:36:56 2016 @@ -0,0 +1,144 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2016-02-09 + | 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="20160209" /> + <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> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET api/metadata/discovery/:dimension-type/:dimension-name/relations</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2016-02-09</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.9</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> +<li>doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>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?doAs=joe + +</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-2016 + <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>
