| <!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/extension/instances/:job-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/extension/instances/:job-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/extension/instances/:job-name<a name="GET_apiextensioninstances:job-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>List instances of an extension job.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:job-name Name of the extension job.</li> |
| <li>start <optional> Show instances from this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.</li> |
| <li>end <optional> Show instances up to this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.</li> |
| <li>instanceStatus <optional> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT.</li> |
| <li>fields <optional> Entity output fields separated by commas. Valid options: STATUS, TAGS, PIPELINES, CLUSTERS.</li> |
| <li>orderBy <optional> Column by which results should be ordered. Sorted by descending order. Valid options are nominalTime (default) and status.</li> |
| <li>sortOrder <optional> Valid options are “asc” and “desc”.</li> |
| <li>offset <optional> Show results from the offset. Used for pagination. Default is 0.</li> |
| <li>numResults <optional> Number of instances per entity to show. Default value is 10.</li> |
| <li>doAs <optional> Impersonate the user.</li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>A list of entities of the job, each followed by a set of instances.</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/extension/instances/daily-health-bill?start=2012-04-01T00:00 |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "numEntities": "2", |
| "entitiesSummary": { |
| "entitySummary": [ |
| { |
| "entityProfile": { |
| "type": "FEED", |
| "name": "SampleUSHealthBill" |
| }, |
| "instances": [ |
| { |
| "instance": "2012-04-02T00:00Z", |
| "status": "RUNNING", |
| "cluster": "SampleCluster1", |
| "sourceCluster": "primaryCluster", |
| "details": "hftp://sandbox.hortonworks.com:50070/apps/falcon/adf-demo/pig-input-2012-04-02" |
| }, |
| { |
| "instance": "2012-04-01T00:00Z", |
| "status": "SUCCEEDED", |
| "cluster": "SampleCluster1", |
| "sourceCluster": "primaryCluster", |
| "details": "hftp://sandbox.hortonworks.com:50070/apps/falcon/adf-demo/pig-input-2012-04-01" |
| } |
| ] |
| }, |
| { |
| "entityProfile": { |
| "type": "PROCESS", |
| "name": "SampleBillPay" |
| }, |
| "instances": [ |
| { |
| "instance": "2012-04-02T00:00Z", |
| "status": "RUNNING", |
| "logFile": "http://sandbox.hortonworks.com:11000/oozie?job=0000085-160322203213815-oozie-oozi-W", |
| "cluster": "primaryCluster", |
| "startTime": "2016-04-04T22:37:46Z", |
| "details": "", |
| "actions": { |
| "action": "dr-replication", |
| "status": "RUNNING", |
| "logFile": "http://sandbox.hortonworks.com:8088/proxy/application_1458678764964_0052/" |
| } |
| }, |
| { |
| "instance": "2012-04-01T00:00Z", |
| "status": "SKIPPED", |
| "cluster": "primaryCluster" |
| } |
| ] |
| } |
| ] |
| } |
| } |
| |
| </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> |
