blob: b222d47237768fe1dd0efb29e586ff534a16dbf2 [file] [log] [blame]
<!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-fluid">
<div id="banner">
<div class="pull-left">
<a href="../../index.html" id="bannerLeft">
<img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/>
</a>
</div>
<div class="pull-right"> <a href="http://www.apache.org" id="bannerRight">
<img src="../images/apache-feather-tm.gif" alt="Falcon" height="45px"/>
</a>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li class="">
<a href="http://www.apache.org" class="externalLink" title="Apache">
Apache</a>
</li>
<li class="divider ">/</li>
<li class="">
<a href="../index.html" title="Falcon">
Falcon</a>
</li>
<li class="divider ">/</li>
<li class="">GET /api/instance/list/:entity-type/:entity-name</li>
<li id="publishDate" class="pull-right">Last Published: 2018-03-12</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span3">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Falcon</li>
<li>
<a href="../index.html" title="About">
<i class="none"></i>
About</a>
</li>
<li>
<a href="../slides/falcon-overview.html" title="Overview">
<i class="none"></i>
Overview</a>
</li>
<li>
<a href="../slides/falcon-user-guide.html" title="User Guide">
<i class="none"></i>
User Guide</a>
</li>
<li>
<a href="../GettingStarted.html" title="Getting Started">
<i class="none"></i>
Getting Started</a>
</li>
<li>
<a href="../FalconDocumentation.html" title="Architecture">
<i class="none"></i>
Architecture</a>
</li>
<li>
<a href="../InstallationSteps.html" title="Installation">
<i class="none"></i>
Installation</a>
</li>
<li>
<a href="../OnBoarding.html" title="On Boarding">
<i class="none"></i>
On Boarding</a>
</li>
<li>
<a href="../MigrationInstructions.html" title="Migrate to 0.10">
<i class="none"></i>
Migrate to 0.10</a>
</li>
<li>
<a href="../Operability.html" title="Operability">
<i class="none"></i>
Operability</a>
</li>
<li>
<a href="../EntitySpecification.html" title="Entity Specification">
<i class="none"></i>
Entity Specification</a>
</li>
<li>
<a href="../falconcli/FalconCLI.html" title="Client (Falcon CLI)">
<i class="none"></i>
Client (Falcon CLI)</a>
</li>
<li>
<a href="../restapi/ResourceList.html" title="Rest API">
<i class="icon-chevron-down"></i>
Rest API</a>
<ul class="nav nav-list">
<li>
<a href="../restapi/ResourceList.html" title="Entity Resource">
<i class="icon-chevron-right"></i>
Entity Resource</a>
</li>
<li>
<a href="../restapi/ResourceList.html" title="Feed/Process Instances">
<i class="icon-chevron-down"></i>
Feed/Process Instances</a>
<ul class="nav nav-list">
<li>
<a href="../restapi/InstanceRunning.html" title="List of running instances.">
<i class="none"></i>
List of running instances.</a>
</li>
<li>
<a href="../restapi/InstanceParams.html" title="List of entity instances along with their workflow params.">
<i class="none"></i>
List of entity instances along with their workflow params.</a>
</li>
<li class="active">
<a href="#"><i class="none"></i>List of instances</a>
</li>
<li>
<a href="../restapi/InstanceStatus.html" title="Status of a given instance">
<i class="none"></i>
Status of a given instance</a>
</li>
<li>
<a href="../restapi/InstanceKill.html" title="Kill a given instance">
<i class="none"></i>
Kill a given instance</a>
</li>
<li>
<a href="../restapi/InstanceSuspend.html" title="Suspend a running instance">
<i class="none"></i>
Suspend a running instance</a>
</li>
<li>
<a href="../restapi/InstanceResume.html" title="Resume a given instance">
<i class="none"></i>
Resume a given instance</a>
</li>
<li>
<a href="../restapi/InstanceRerun.html" title="Rerun a given instance">
<i class="none"></i>
Rerun a given instance</a>
</li>
<li>
<a href="../restapi/InstanceLogs.html" title="Get logs of a given instance">
<i class="none"></i>
Get logs of a given instance</a>
</li>
<li>
<a href="../restapi/InstanceSummary.html" title="Return summary of instances for an entity">
<i class="none"></i>
Return summary of instances for an entity</a>
</li>
<li>
<a href="../restapi/InstanceDependency.html" title="Return dependent instances of an instance">
<i class="none"></i>
Return dependent instances of an instance</a>
</li>
<li>
<a href="../restapi/Triage.html" title="Triage a given instance">
<i class="none"></i>
Triage a given instance</a>
</li>
</ul>
</li>
<li>
<a href="../restapi/ResourceList.html" title="Admin Resource">
<i class="icon-chevron-right"></i>
Admin Resource</a>
</li>
<li>
<a href="../restapi/ResourceList.html" title="Lineage Graph Resource">
<i class="icon-chevron-right"></i>
Lineage Graph Resource</a>
</li>
<li>
<a href="../restapi/ResourceList.html" title="Metadata Resource">
<i class="icon-chevron-right"></i>
Metadata Resource</a>
</li>
<li>
<a href="../restapi/ResourceList.html" title="Falcon Extensions">
<i class="icon-chevron-right"></i>
Falcon Extensions</a>
</li>
</ul>
</li>
<li>
<a href="../HiveIntegration.html" title="Hive Integration">
<i class="none"></i>
Hive Integration</a>
</li>
<li>
<a href="../Extensions.html" title="Server side Extensions">
<i class="none"></i>
Server side Extensions</a>
</li>
<li>
<a href="../Security.html" title="Security">
<i class="none"></i>
Security</a>
</li>
<li class="nav-header">Project Information</li>
<li>
<a href="../project-info.html" title="Summary">
<i class="none"></i>
Summary</a>
</li>
<li>
<a href="../mail-lists.html" title="Mailing Lists">
<i class="none"></i>
Mailing Lists</a>
</li>
<li>
<a href="http://webchat.freenode.net?channels=apachefalcon&uio=d4" class="externalLink" title="IRC">
<i class="none"></i>
IRC</a>
</li>
<li>
<a href="../team-list.html" title="Team">
<i class="none"></i>
Team</a>
</li>
<li>
<a href="../issue-tracking.html" title="Issue Tracking">
<i class="none"></i>
Issue Tracking</a>
</li>
<li>
<a href="../source-repository.html" title="Source Repository">
<i class="none"></i>
Source Repository</a>
</li>
<li>
<a href="https://cwiki.apache.org/confluence/display/FALCON/Index" class="externalLink" title="Wiki">
<i class="none"></i>
Wiki</a>
</li>
<li>
<a href="../license.html" title="License">
<i class="none"></i>
License</a>
</li>
<li>
<a href="https://cwiki.apache.org/confluence/display/FALCON/News" class="externalLink" title="News">
<i class="none"></i>
News</a>
</li>
<li>
<a href="https://cwiki.apache.org/confluence/display/FALCON/PoweredBy" class="externalLink" title="Powered by">
<i class="none"></i>
Powered by</a>
</li>
<li>
<a href="https://cwiki.apache.org/confluence/display/FALCON/Acknowledgements" class="externalLink" title="Acknowledgements">
<i class="none"></i>
Acknowledgements</a>
</li>
<li>
<a href="http://blogs.apache.org/falcon/" class="externalLink" title="Blog">
<i class="none"></i>
Blog</a>
</li>
<li class="nav-header">Releases</li>
<li>
<a href="http://www.apache.org/dyn/closer.lua/falcon/0.11" class="externalLink" title="0.11">
<i class="none"></i>
0.11</a>
</li>
<li>
<a href="http://www.apache.org/dyn/closer.lua/falcon/0.10" class="externalLink" title="0.10">
<i class="none"></i>
0.10</a>
</li>
<li>
<a href="http://www.apache.org/dyn/closer.lua/falcon/0.9" class="externalLink" title="0.9">
<i class="none"></i>
0.9</a>
</li>
<li>
<a href="http://www.apache.org/dyn/closer.lua/falcon/0.8" class="externalLink" title="0.8">
<i class="none"></i>
0.8</a>
</li>
<li>
<a href="http://www.apache.org/dyn/closer.lua/falcon/0.7" class="externalLink" title="0.7">
<i class="none"></i>
0.7</a>
</li>
<li>
<a href="http://archive.apache.org/dist/falcon/0.6.1" class="externalLink" title="0.6.1">
<i class="none"></i>
0.6.1</a>
</li>
<li>
<a href="http://archive.apache.org/dist/incubator/falcon/0.6-incubating" class="externalLink" title="0.6-incubating">
<i class="none"></i>
0.6-incubating</a>
</li>
<li>
<a href="http://archive.apache.org/dist/incubator/falcon/0.5-incubating" class="externalLink" title="0.5-incubating">
<i class="none"></i>
0.5-incubating</a>
</li>
<li>
<a href="http://archive.apache.org/dist/incubator/falcon/0.4-incubating" class="externalLink" title="0.4-incubating">
<i class="none"></i>
0.4-incubating</a>
</li>
<li>
<a href="http://archive.apache.org/dist/incubator/falcon/0.3-incubating" class="externalLink" title="0.3-incubating">
<i class="none"></i>
0.3-incubating</a>
</li>
<li>
<a href="https://cwiki.apache.org/confluence/display/FALCON/Roadmap" class="externalLink" title="Coming soon">
<i class="none"></i>
Coming soon</a>
</li>
<li class="nav-header">Documentation</li>
<li>
<a href="../0.11/index.html" title="0.11 (Current)">
<i class="none"></i>
0.11 (Current)</a>
</li>
<li>
<a href="../0.10/index.html" title="0.10">
<i class="none"></i>
0.10</a>
</li>
<li>
<a href="../0.9/index.html" title="0.9">
<i class="none"></i>
0.9</a>
</li>
<li>
<a href="../0.8/index.html" title="0.8">
<i class="none"></i>
0.8</a>
</li>
<li>
<a href="../0.7/index.html" title="0.7">
<i class="none"></i>
0.7</a>
</li>
<li>
<a href="../0.6.1/index.html" title="0.6.1">
<i class="none"></i>
0.6.1</a>
</li>
<li>
<a href="../0.6-incubating/index.html" title="0.6-incubating">
<i class="none"></i>
0.6-incubating</a>
</li>
<li>
<a href="../0.5-incubating/index.html" title="0.5-incubating">
<i class="none"></i>
0.5-incubating</a>
</li>
<li>
<a href="../0.4-incubating/index.html" title="0.4-incubating">
<i class="none"></i>
0.4-incubating</a>
</li>
<li>
<a href="../0.3-incubating/index.html" title="0.3-incubating">
<i class="none"></i>
0.3-incubating</a>
</li>
<li class="nav-header">ASF</li>
<li>
<a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink" title="How Apache Works">
<i class="none"></i>
How Apache Works</a>
</li>
<li>
<a href="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
<i class="none"></i>
Foundation</a>
</li>
<li>
<a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
<i class="none"></i>
Sponsoring Apache</a>
</li>
<li>
<a href="http://www.apache.org/foundation/thanks.html" class="externalLink" title="Thanks">
<i class="none"></i>
Thanks</a>
</li>
</ul>
<hr class="divider" />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<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>
</div>
</div>
</div>
<div id="bodyColumn" class="span9" >
<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 &lt;optional param&gt; 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 &lt;optional param&gt; 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 &lt;optional param&gt; Colo on which the query should be run.</li>
<li>lifecycle &lt;optional param&gt; Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).</li>
<li>filterBy &lt;optional param&gt; 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 &lt;optional param&gt; Field by which results should be ordered.
<ul>
<li>Supports ordering by &quot;status&quot;,&quot;startTime&quot;,&quot;endTime&quot;,&quot;cluster&quot;.</li></ul></li>
<li>sortOrder &lt;optional param&gt; Valid options are &quot;asc&quot; and &quot;desc&quot;</li>
<li>offset &lt;optional param&gt; Show results from the offset, used for pagination. Defaults to 0.</li>
<li>numResults &lt;optional param&gt; Number of results to show per request, used for pagination. Only integers &gt; 0 are valid, Default is 10.</li>
<li>doAs &lt;optional query param&gt; allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.</li>
<li>allAttempts &lt;optional query param&gt; 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=*&amp;start=2012-04-03T07:00Z
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;instances&quot;: [
{
&quot;details&quot;: &quot;&quot;,
&quot;endTime&quot;: &quot;2013-10-21T14:40:26-07:00&quot;,
&quot;startTime&quot;: &quot;2013-10-21T14:39:56-07:00&quot;,
&quot;cluster&quot;: &quot;primary-cluster&quot;,
&quot;logFile&quot;: &quot;http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;,
&quot;instance&quot;: &quot;2012-04-03T07:00Z&quot;
}
],
&quot;requestId&quot;: &quot;default\/e15bb378-d09f-4911-9df2-5334a45153d2\n&quot;,
&quot;message&quot;: &quot;default\/STATUS\n&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;
}
</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=*&amp;start=2012-04-03T07:00Z&amp;filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&amp;orderBy=startTime&amp;offset=2&amp;numResults=2&amp;doAs=joe
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;instances&quot;: [
{
&quot;details&quot;: &quot;&quot;,
&quot;endTime&quot;: &quot;2013-10-21T14:40:26-07:00&quot;,
&quot;startTime&quot;: &quot;2013-10-21T14:39:56-07:00&quot;,
&quot;cluster&quot;: &quot;primary-cluster&quot;,
&quot;logFile&quot;: &quot;http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;,
&quot;instance&quot;: &quot;2012-04-03T07:00Z&quot;
},
{
&quot;details&quot;: &quot;&quot;,
&quot;endTime&quot;: &quot;2013-10-21T14:42:26-07:00&quot;,
&quot;startTime&quot;: &quot;2013-10-21T14:41:56-07:00&quot;,
&quot;cluster&quot;: &quot;primary-cluster&quot;,
&quot;logFile&quot;: &quot;http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;,
&quot;instance&quot;: &quot;2012-04-03T08:00Z&quot;
},
],
&quot;requestId&quot;: &quot;default\/e15bb378-d09f-4911-9df2-5334a45153d2\n&quot;,
&quot;message&quot;: &quot;default\/STATUS\n&quot;,
&quot;status&quot;: &quot;SUCCEEDED&quot;
}
</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&amp;start=2013-11-15T00:05Z&amp;end=2013-11-15T01:00Z&amp;colo=*&amp;offset=0&amp;allAttempts=true
</pre></div></div>
<div class="section">
<h4>Result<a name="Result"></a></h4>
<div class="source">
<pre>
{
&quot;status&quot;:&quot;SUCCEEDED&quot;,
&quot;message&quot;:&quot;default/STATUS\n&quot;,
&quot;requestId&quot;:&quot;default/942519651@qtp-1386909980-16 - 5b11a8ba-402b-4cc7-969c-256e0ed18ae2\n&quot;,
&quot;instances&quot;:[
{
&quot;instance&quot;:&quot;2013-11-15T00:05Z&quot;,
&quot;status&quot;:&quot;SUCCEEDED&quot;,
&quot;logFile&quot;:&quot;http://IM1948-X0:11000/oozie?job=0000010-160106121750678-oozie-oozi-W&quot;,
&quot;cluster&quot;:&quot;local&quot;,
&quot;startTime&quot;:&quot;2016-01-06T12:39:22+05:30&quot;,
&quot;endTime&quot;:&quot;2016-01-06T12:40:05+05:30&quot;,
&quot;runId&quot;:0,
&quot;details&quot;:&quot;&quot;,
&quot;actions&quot;:[
{
&quot;action&quot;:&quot;mr-node&quot;,
&quot;status&quot;:&quot;SUCCEEDED&quot;,
&quot;logFile&quot;:&quot;http://localhost:8088/proxy/application_1452062826344_0010/&quot;
}
]
},
{
&quot;instance&quot;:&quot;2013-11-15T00:05Z&quot;,
&quot;status&quot;:&quot;SUCCEEDED&quot;,
&quot;logFile&quot;:&quot;http://IM1948-X0:11000/oozie?job=0000011-160106121750678-oozie-oozi-W&quot;,
&quot;cluster&quot;:&quot;local&quot;,
&quot;startTime&quot;:&quot;2016-01-06T12:40:27+05:30&quot;,
&quot;endTime&quot;:&quot;2016-01-06T12:41:05+05:30&quot;,
&quot;runId&quot;:0,
&quot;details&quot;:&quot;&quot;,
&quot;actions&quot;:[
{
&quot;action&quot;:&quot;mr-node&quot;,
&quot;status&quot;:&quot;SUCCEEDED&quot;,
&quot;logFile&quot;:&quot;http://localhost:8088/proxy/application_1452062826344_0012/&quot;
}
]
}
]
}
</pre></div></div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row span12">Copyright &copy; 2013-2018
<a href="http://www.apache.org">Apache Software Foundation</a>.
All Rights Reserved.
</div>
</div>
</footer>
</body>
</html>