| <!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/search</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/search</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/search<a name="GET_apiinstancesearch"></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 list of instances that meet search criteria.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:type <optional param> Comma-separated entity types. Valid entity types are feed, process or datasource.</li> |
| <li>nameseq <optional param> Subsequence of entity name. Not case sensitive. |
| <ul> |
| <li>The entity name needs to contain all the characters in the subsequence in the same order.</li> |
| <li>Example 1: "sample1" will match the entity named "SampleFeed1-2".</li> |
| <li>Example 2: "mhs" will match the entity named "New-My-Hourly-Summary".</li></ul></li> |
| <li>tagkeys <optional param> Keywords in tags, separated by comma. Not case sensitive. |
| <ul> |
| <li>The returned entities will have tags that match all the tag keywords.</li></ul></li> |
| <li>instanceStatus <optional param> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT.</li> |
| <li>start <optional param> Show instances from this nominal time. Format: 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 nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'. |
| <ul> |
| <li>Default is set to now.</li></ul></li> |
| <li>orderBy <optional param> Field by which results should be ordered. Sorted by descending order. |
| <ul> |
| <li>If not specified, instances of the same entity will be listed together in the result.</li> |
| <li>Current valid option: status. Coming soon: sorting by name, nominal time, running time.</li></ul></li> |
| <li>offset <optional param> Show results from the offset, used for pagination. Defaults to 0.</li> |
| <li>numResults <optional param> Number of results to show per request, used for pagination. |
| <ul> |
| <li>Only integers > 0 are valid. Default is 10.</li></ul></li> |
| <li>doAs <optional query param> allows the current user to impersonate the user passed in doAs.</li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>A list 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/instance/search?nameseq=usbill&start=2012-04-03T00:00Z |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "instances": [ |
| { |
| “name":"SampleUSHealthBill”, |
| “type":"FEED”, |
| “tags”: {"tag":["related=ushealthcare","department=billingDepartment"]}, |
| “nominalTime": "2012-04-03T07:00Z" |
| "cluster": "primary-cluster", |
| "status": "SUCCEEDED", |
| "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", |
| "startTime": "2013-10-21T14:39:56-07:00", |
| "endTime": "2013-10-21T14:40:26-07:00", |
| } |
| ], |
| "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", |
| "message": "Instances Search Results", |
| "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/search?nameseq=samplebill&tagkeys=billing,healthcare&start=2012-04-03T00:00Z&instanceStatus=succeeded&orderBy=nominalTime&offset=2&numResults=2 |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "instances": [ |
| { |
| "name":"SampleHealthBill", |
| "type":"PROCESS", |
| "tags”: {"tag":["related=healthcare","department=billingDepartment"]}, |
| “nominalTime": "2012-04-03T08:00Z" |
| "cluster": "primary-cluster", |
| "status": "SUCCEEDED", |
| "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W", |
| "startTime": "2013-10-21T14:41:56-07:00", |
| "endTime": "2013-10-21T14:42:26-07:00", |
| }, |
| { |
| "name":"SampleUSHealthBill", |
| "type":"FEED”, |
| "tags": {"tag":["related=ushealthcare","department=billingDepartment"]}, |
| “nominalTime": "2012-04-03T07:00Z" |
| "cluster": "primary-cluster", |
| "status": "SUCCEEDED", |
| "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", |
| "startTime": "2013-10-21T14:39:56-07:00", |
| "endTime": "2013-10-21T14:40:26-07:00", |
| }, |
| ], |
| |
| "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", |
| "message": "Instances Search Results", |
| "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> |
