http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/ExtensionValidate.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/ExtensionValidate.html b/content/0.11/restapi/ExtensionValidate.html new file mode 100644 index 0000000..4504c1d --- /dev/null +++ b/content/0.11/restapi/ExtensionValidate.html @@ -0,0 +1,136 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST api/extension/validate/:extension-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/extension/validate/:extension-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST api/extension/validate/:extension-name<a name="POST_apiextensionvalidate:extension-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>Validate the input for extension job submission.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:extension-name Name of the extension.</li> +<li>doAs <optional> Impersonate the user.</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Result of validation.</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/extension/validate/hdfs-mirroring +jobName=sales-monthly +jobClustername=primaryCluster +jobClusterValidityStart=2015-03-13T00:00Z +jobClusterValidityEnd=2016-12-30T00:00Z +jobFrequency=minutes(5) +sourceDir=/user/hrt_qa/dr/test/primaryCluster/input +sourceCluster=primaryCluster +targetDir=/user/hrt_qa/dr/test/backupCluster/input +targetCluster=backupCluster + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3", + "message": "Validated successfully", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html>
http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/FeedInstanceListing.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/FeedInstanceListing.html b/content/0.11/restapi/FeedInstanceListing.html new file mode 100644 index 0000000..d360bf7 --- /dev/null +++ b/content/0.11/restapi/FeedInstanceListing.html @@ -0,0 +1,144 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/listing/feed/: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/listing/feed/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/listing/feed/:entity-name<a name="GET_apiinstancelistingfeed: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 falcon feed instance availability.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<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>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>Feed instance availability status</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/listing/feed/SampleFeed?colo=*&start=2012-04-03T07:00Z&doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "instances": [ + { + "size": "450231212222", + "creationTime": "1236679827365", + "cluster": "primary-cluster", + "uri": "/data/SampleFeed/2012-04-03", + "status": "AVAILABLE", + "instance": "2012-04-03T07: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-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/FeedLookup.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/FeedLookup.html b/content/0.11/restapi/FeedLookup.html new file mode 100644 index 0000000..3f29f3c --- /dev/null +++ b/content/0.11/restapi/FeedLookup.html @@ -0,0 +1,115 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET api/entities/lookup/feed</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET api/entities/lookup/feed</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET api/entities/lookup/feed<a name="GET_apientitieslookupfeed"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p>* path path of the instance for which you want to determine the feed. e.g. /data/project1/2014/10/10/23/ Path has to be the complete path and can't be a part of it. * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</p></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Returns the name of the feed along with the location type(meta/data/stats) and cluster on which the given path belongs to this feed.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/lookup/feed?path=/data/project1/2014/10/10/23&doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<p>{ "feeds": [ { "feedName": "My-Feed1", "locationType": "DATA", "clusterName": "My-cluster1" }, { "feedName": "My-Feed2", "locationType": "DATA", "clusterName": "My-cluster2" } ] }</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/FeedSLA.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/FeedSLA.html b/content/0.11/restapi/FeedSLA.html new file mode 100644 index 0000000..c5f0ce2 --- /dev/null +++ b/content/0.11/restapi/FeedSLA.html @@ -0,0 +1,154 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/entities/sla-alert/:entity-type</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + + + <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> + + + +<script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> + + </head> + <body class="topBarDisabled"> + + + + + <div class="container"> + <div id="banner"> + <div class="pull-left"> + <div id="bannerLeft"> + <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> + </div> + </div> + <div class="pull-right"> </div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + + + <li class=""> + <a href="../index.html" title="Falcon"> + Falcon</a> + </li> + <li class="divider ">/</li> + <li class="">GET /api/entities/sla-alert/:entity-type</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/entities/sla-alert/:entity-type<a name="GET_apientitiessla-alert:entity-type"></a></h3> +<p></p> +<ul> +<li><a href="#Description">Description</a></li> +<li><a href="#Parameters">Parameters</a></li> +<li><a href="#Results">Results</a></li> +<li><a href="#Examples">Examples</a></li></ul></div> +<div class="section"> +<h3>Description<a name="Description"></a></h3> +<div class="source"> +<pre> +Since: 0.8 + +</pre></div> +<p>This command lists all the feed instances which have missed sla and are still not available. If a feed instance missed sla but is now available, then it will not be reported in results. The purpose of this API is alerting and hence it doesn't return feed instances which missed SLA but are available as they don't require any action.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<ul> +<li>:entity-type Only valid option is feed.</li> +<li>entity-name <optional param> parameter to restrict results for a particular feed using feed's name.</li> +<li>start <mandatory param> start of the time window for nominal instances, inclusive.</li> +<li>end <mandatory param> end of the time window for nominal instances to be considered, default is treated as current time.</li> +<li>colo <optional param> name of the colo</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Pending feed instances which missed SLA.</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/entities/sla-alert/feed?colo=*&start=2012-04-03T07:00Z + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"default/Success!\n", + "requestId":"default/885720178@qtp-495452957-6 - f6e82e9b-d23f-466b-82df-4fb8293ce9cf\n", + "instances":[ + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:33:00+05:30","tags":"Missed SLA High"}, + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:29:00+05:30","tags":"Missed SLA High"}, + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:35:00+05:30","tags":"Missed SLA Low"}, + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:30:00+05:30","tags":"Missed SLA High"}, + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:34:00+05:30","tags":"Missed SLA High"}, + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:31:00+05:30","tags":"Missed SLA High"}, + {"cluster":"local","entityName":"out","entityType":"FEED","instanceTime":"2015-09-26T17:32:00+05:30","tags":"Missed SLA High"} + ] +} + +</pre></div> +<p>In case there are no pending instances which have missed sla the response will be like below:</p> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"default/Success!\n", + "requestId":"default/979808239@qtp-1243851750-3 - 8c7396c0-efe2-43e9-9aea-7ae6afea5fd6\n" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/Graph.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/Graph.html b/content/0.11/restapi/Graph.html new file mode 100644 index 0000000..e0de5f2 --- /dev/null +++ b/content/0.11/restapi/Graph.html @@ -0,0 +1,118 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET api/metadata/lineage/serialize</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/lineage/serialize</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET api/metadata/lineage/serialize<a name="GET_apimetadatalineageserialize"></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>Dump the graph.</p></div> +<div class="section"> +<h3>Parameters<a name="Parameters"></a></h3> +<p></p> +<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>Serialize graph to a file configured using *.falcon.graph.serialize.path in Custom startup.properties.</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/lineage/serialize?doAs=joe + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<p>None.</p></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceDependencies.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceDependencies.html b/content/0.11/restapi/InstanceDependencies.html new file mode 100644 index 0000000..df34e09 --- /dev/null +++ b/content/0.11/restapi/InstanceDependencies.html @@ -0,0 +1,145 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/dependencies/: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/dependencies/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/dependencies/:entity-type/:entity-name<a name="GET_apiinstancedependencies: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 dependent instances for a particular instance.</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>instanceTime <mandatory param> time of the given instance</li> +<li>colo <optional param> name of the colo</li></ul></div> +<div class="section"> +<h3>Results<a name="Results"></a></h3> +<p>Dependent instances for the specified instance</p></div> +<div class="section"> +<h3>Examples<a name="Examples"></a></h3></div> +<div class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET http://localhost:15000/api/instance/dependencies/feed/myFeed?colo=*&instanceTime=2012-04-03T07:00Z + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + 'status': 'SUCCEEDED', + 'message': 'default/Success!\n', + 'dependencies': [ + { + 'cluster': 'local', + 'entityName': 'consumer-process', + 'entityType': 'PROCESS', + 'instanceTime': '2014-12-18T00:00Z', + 'tags': 'Input' + }, + { + 'cluster': 'local', + 'entityName': 'producer-process', + 'entityType': 'PROCESS', + 'instanceTime': '2014-12-18T00:00Z', + 'tags': 'Output' + } + ], + 'requestId': 'default/1405883107@qtp-1501726962-6-0c2e690f-546b-47b0-a5ee-0365d4522a31\n' +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceKill.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceKill.html b/content/0.11/restapi/InstanceKill.html new file mode 100644 index 0000000..622c394 --- /dev/null +++ b/content/0.11/restapi/InstanceKill.html @@ -0,0 +1,142 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - POST /api/instance/kill/: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/kill/:entity-type/:entity-name</li> + + + + <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>POST /api/instance/kill/:entity-type/:entity-name<a name="POST_apiinstancekill: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>Kill currently running instance(s) 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>Result of the kill operation.</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/kill/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:26:59-07:00", + "startTime": "2013-10-21T15:19:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "KILLED", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/23b3cfee-ee22-40c0-825d-39c322587d5f\n", + "message": "default\/KILL\n", + "status": "SUCCEEDED" +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceList.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceList.html b/content/0.11/restapi/InstanceList.html new file mode 100644 index 0000000..a6f4306 --- /dev/null +++ b/content/0.11/restapi/InstanceList.html @@ -0,0 +1,262 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/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: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/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> +<li>allAttempts <optional query param> To get all the attempts for corresponding instances.</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 class="section"> +<h4>Rest Call<a name="Rest_Call"></a></h4> +<div class="source"> +<pre> +GET https://localhost:15443/api/instance/status/process/oozie-mr-process?user.name=narayan&start=2013-11-15T00:05Z&end=2013-11-15T01:00Z&colo=*&offset=0&allAttempts=true + +</pre></div></div> +<div class="section"> +<h4>Result<a name="Result"></a></h4> +<div class="source"> +<pre> +{ + "status":"SUCCEEDED", + "message":"default/STATUS\n", + "requestId":"default/942519651@qtp-1386909980-16 - 5b11a8ba-402b-4cc7-969c-256e0ed18ae2\n", + "instances":[ + { + "instance":"2013-11-15T00:05Z", + "status":"SUCCEEDED", + "logFile":"http://IM1948-X0:11000/oozie?job=0000010-160106121750678-oozie-oozi-W", + "cluster":"local", + "startTime":"2016-01-06T12:39:22+05:30", + "endTime":"2016-01-06T12:40:05+05:30", + "runId":0, + "details":"", + "actions":[ + { + "action":"mr-node", + "status":"SUCCEEDED", + "logFile":"http://localhost:8088/proxy/application_1452062826344_0010/" + } + ] + }, + { + "instance":"2013-11-15T00:05Z", + "status":"SUCCEEDED", + "logFile":"http://IM1948-X0:11000/oozie?job=0000011-160106121750678-oozie-oozi-W", + "cluster":"local", + "startTime":"2016-01-06T12:40:27+05:30", + "endTime":"2016-01-06T12:41:05+05:30", + "runId":0, + "details":"", + "actions":[ + { + "action":"mr-node", + "status":"SUCCEEDED", + "logFile":"http://localhost:8088/proxy/application_1452062826344_0012/" + } + ] + } + ] +} + +</pre></div></div> + </div> + </div> + + <hr/> + + <footer> + <div class="container"> + <div class="row span12">Copyright © 2013-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceLogs.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceLogs.html b/content/0.11/restapi/InstanceLogs.html new file mode 100644 index 0000000..833bc1b --- /dev/null +++ b/content/0.11/restapi/InstanceLogs.html @@ -0,0 +1,217 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/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: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/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-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceParams.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceParams.html b/content/0.11/restapi/InstanceParams.html new file mode 100644 index 0000000..0ed5225 --- /dev/null +++ b/content/0.11/restapi/InstanceParams.html @@ -0,0 +1,123 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - GET /api/instance/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: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>GET /api/instance/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-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceRerun.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceRerun.html b/content/0.11/restapi/InstanceRerun.html new file mode 100644 index 0000000..15139aa --- /dev/null +++ b/content/0.11/restapi/InstanceRerun.html @@ -0,0 +1,168 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - 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: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>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-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html> http://git-wip-us.apache.org/repos/asf/falcon/blob/91c68bea/content/0.11/restapi/InstanceResume.html ---------------------------------------------------------------------- diff --git a/content/0.11/restapi/InstanceResume.html b/content/0.11/restapi/InstanceResume.html new file mode 100644 index 0000000..f7e8030 --- /dev/null +++ b/content/0.11/restapi/InstanceResume.html @@ -0,0 +1,140 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia at 2018-03-12 + | Rendered using Apache Maven Fluido Skin 1.3.0 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180312" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Falcon - 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: 2018-03-12</li> <li class="divider pull-right">|</li> + <li id="projectVersion" class="pull-right">Version: 0.11</li> + + </ul> + </div> + + + + <div id="bodyColumn" > + + <div class="section"> +<h3>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-2018 + <a href="http://www.apache.org";>Apache Software Foundation</a>. + All Rights Reserved. + + </div> + + + <p id="poweredBy" class="pull-right"> + <a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"> + <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> + </a> + </p> + + </div> + </footer> + </body> +</html>
