blob: 2cd9b1c4a2f4c487a14db0931b102a056c849de3 [file] [log] [blame]
---++ GET /api/instance/list/:entity-type/:entity-name
* <a href="#Description">Description</a>
* <a href="#Parameters">Parameters</a>
* <a href="#Results">Results</a>
* <a href="#Examples">Examples</a>
---++ Description
Get list of all instances of a given entity.
---++ Parameters
* :entity-type Valid options are cluster, feed or process.
* :entity-name Name of the entity.
* start <optional param> Show instances from this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
* By default, it is set to (end - (10 * entityFrequency)).
* end <optional param> Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'.
* Default is set to now.
* colo <optional param> Colo on which the query should be run.
* lifecycle <optional param> Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default).
* filterBy <optional param> Filter results by list of field:value pairs. Example: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster
* Supported filter fields are STATUS, CLUSTER, SOURCECLUSTER, STARTEDAFTER.
* Query will do an AND among filterBy fields.
* orderBy <optional param> Field by which results should be ordered.
* Supports ordering by "status","startTime","endTime","cluster".
* sortOrder <optional param> Valid options are "asc" and "desc"
* offset <optional param> Show results from the offset, used for pagination. Defaults to 0.
* numResults <optional param> Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10.
---++ Results
List of instances of given entity.
---++ Examples
---+++ Rest Call
<verbatim>
GET http://localhost:15000/api/instance/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
</verbatim>
---+++ Result
<verbatim>
{
"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"
}
</verbatim>
---+++ Rest Call
<verbatim>
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
</verbatim>
---+++ Result
<verbatim>
{
"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"
}
</verbatim>