Return-Path: X-Original-To: apmail-falcon-commits-archive@minotaur.apache.org Delivered-To: apmail-falcon-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 223FA111A1 for ; Fri, 12 Sep 2014 09:44:44 +0000 (UTC) Received: (qmail 67531 invoked by uid 500); 12 Sep 2014 09:44:44 -0000 Delivered-To: apmail-falcon-commits-archive@falcon.apache.org Received: (qmail 67494 invoked by uid 500); 12 Sep 2014 09:44:44 -0000 Mailing-List: contact commits-help@falcon.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@falcon.incubator.apache.org Delivered-To: mailing list commits@falcon.incubator.apache.org Received: (qmail 67485 invoked by uid 99); 12 Sep 2014 09:44:44 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 12 Sep 2014 09:44:44 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 12 Sep 2014 09:44:41 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id CC8052388BEC; Fri, 12 Sep 2014 09:43:56 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1624488 [7/7] - in /incubator/falcon: site/ site/0.3-incubating/ site/0.4-incubating/ site/docs/ site/docs/restapi/ trunk/ trunk/general/src/site/twiki/docs/ trunk/general/src/site/twiki/docs/restapi/ Date: Fri, 12 Sep 2014 09:43:51 -0000 To: commits@falcon.incubator.apache.org From: sriksun@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20140912094356.CC8052388BEC@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki?rev=1624488&view=auto ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki (added) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceList.twiki Fri Sep 12 09:43:48 2014 @@ -0,0 +1,89 @@ +---++ GET /api/instance/list/:entity-type/:entity-name + * Description + * Parameters + * Results + * Examples + +---++ 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 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 Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * colo Colo on which the query should be run. + * lifecycle Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy 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 Field by which results should be ordered. + * Supports ordering by "status","startTime","endTime","cluster". + * sortOrder Valid options are "asc" and "desc" + * offset Show results from the offset, used for pagination. Defaults to 0. + * numResults 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 + +GET http://localhost:15000/api/instance/list/process/SampleProcess?colo=*&start=2012-04-03T07:00Z + +---+++ Result + +{ + "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" +} + + + +---+++ Rest Call + +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 + +---+++ Result + +{ + "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" +} + Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceLogs.twiki Fri Sep 12 09:43:48 2014 @@ -8,10 +8,23 @@ Get log of a specific instance of an entity. ---++ Parameters - * :entity-type can either be a feed or a process. - * :entity-name is name of the entity. - * start is the start time of the instance that you want to refer to - * end is the end time of the instance that you want to refer to + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * start 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 Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * colo Colo on which the query should be run. + * runId Run Id. + * lifecycle Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy 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 Field by which results should be ordered. + * Supports ordering by "status","startTime","endTime","cluster". + * sortOrder Valid options are "asc" and "desc" + * offset Show results from the offset, used for pagination. Defaults to 0. + * numResults Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10. ---++ Results Log of specified instance. @@ -20,7 +33,6 @@ Log of specified instance. ---+++ Rest Call GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z -Remote-User: rgautam ---+++ Result @@ -48,3 +60,53 @@ Remote-User: rgautam "status": "SUCCEEDED" } + +---+++ Rest Call + +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 + +---+++ Result + +{ + "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" +} + + + + Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRerun.twiki Fri Sep 12 09:43:48 2014 @@ -11,6 +11,7 @@ Rerun a specific instance of an entity. * :entity-type can either be a feed or a process. * :entity-name is name of the entity. * start is the start time of the instance that you want to refer to + * lifecycle can be Eviction/Replication(default) for feed and Execution(default) for process. ---++ Results Results of the rerun command. @@ -19,7 +20,6 @@ Results of the rerun command. ---+++ Rest Call POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z -Remote-User: rgautam ---+++ Result Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceResume.twiki Fri Sep 12 09:43:48 2014 @@ -11,7 +11,7 @@ Resume a specific instance of an entity. * :entity-type can either be a feed or a process. * :entity-name is name of the entity. * start is the start time of the instance that you want to refer to - + * lifecycle can be Eviction/Replication(default) for feed and Execution(default) for process. ---++ Results Results of the resume command. @@ -19,7 +19,6 @@ Results of the resume command. ---+++ Rest Call POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z -Remote-User: rgautam ---+++ Result Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceRunning.twiki Fri Sep 12 09:43:48 2014 @@ -8,8 +8,19 @@ Get a list of instances currently running for a given entity. ---++ Parameters - * :entity-type can either be a feed or a process. - * :entity-name is name of the entity. + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * colo Colo on which the query should be run. + * lifecycle Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy Filter results by list of field:value pairs. Example: filterBy=CLUSTER:primary-cluster + * Supported filter fields are CLUSTER, SOURCECLUSTER, STARTEDAFTER. + * Query will do an AND among filterBy fields. + * orderBy Field by which results should be ordered. + * Supports ordering by "status","startTime","endTime","cluster". + * sortOrder Valid options are "asc" and "desc" + * offset Show results from the offset, used for pagination. Defaults to 0. + * numResults Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10. + ---++ Results List of instances currently running. @@ -18,7 +29,6 @@ List of instances currently running. ---+++ Rest Call GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=* -Remote-User: rgautam ---+++ Result @@ -36,3 +46,40 @@ Remote-User: rgautam "status": "SUCCEEDED" } + + +---+++ Rest Call + +GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2 + +---+++ Result + +{ + "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": "RUNNING", + "instance": "2012-04-03T07:00Z" + }, + { + "details": "", + "endTime": "2013-10-21T14:42:27-07:00", + "startTime": "2013-10-21T14:41:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933397-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T08:00Z" + }, + ], + + "requestId": "default\/e15bb378-d09f-4911-9df2-5334a45153d2\n", + "message": "default\/STATUS\n", + "status": "SUCCEEDED" +} + + + Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceStatus.twiki Fri Sep 12 09:43:48 2014 @@ -8,11 +8,24 @@ Get status of a specific instance of an entity. ---++ Parameters - * :entity-type can either be a feed or a process. - * :entity-name is name of the entity. - * start is the start time of the instance that you want to refer to - * end is the end time of the instance that you want to refer to + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * start 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 Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * colo Colo on which the query should be run. + * lifecycle Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). + * filterBy 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 Field by which results should be ordered. + * Supports ordering by "status","startTime","endTime","cluster". + * sortOrder Valid options are "asc" and "desc" + * offset Show results from the offset, used for pagination. Defaults to 0. + * numResults Number of results to show per request, used for pagination. Only integers > 0 are valid, Default is 10. + ---++ Results Status of the specified instance. @@ -20,7 +33,6 @@ Status of the specified instance. ---+++ Rest Call GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z -Remote-User: rgautam ---+++ Result @@ -41,3 +53,38 @@ Remote-User: rgautam "status": "SUCCEEDED" } + + +---+++ Rest Call + +GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&filterBy=STATUS:SUCCEEDED,CLUSTER:primary-cluster&orderBy=startTime&offset=2&numResults=2 + +---+++ Result + +{ + "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" +} + Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSummary.twiki Fri Sep 12 09:43:48 2014 @@ -8,10 +8,14 @@ Get summary of instance/instances of an entity. ---++ Parameters - * :entity-type can either be a feed or a process. - * :entity-name is name of the entity. - * start is the start time of the instance that you want to refer to - * end is the end time of the instance that you want to refer to + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * start 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 Show instances up to this date. Date format is yyyy-MM-dd'T'HH:mm'Z'. + * Default is set to now. + * colo Colo on which the query should be run. + * lifecycle Valid lifecycles for feed are Eviction/Replication(default) and for process is Execution(default). ---++ Results Summary of the instances over the specified time range @@ -20,7 +24,6 @@ Summary of the instances over the specif ---+++ Rest Call GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z -Remote-User: suhas ---+++ Result @@ -36,7 +39,7 @@ Remote-User: suhas "entry": { "key":"SUCCEEDED", - "value":"3" + "key2":"value" } } } Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/InstanceSuspend.twiki Fri Sep 12 09:43:48 2014 @@ -11,6 +11,7 @@ Suspend a specific instance of an entity * :entity-type can either be a feed or a process. * :entity-name is name of the entity. * start is the start time of the instance that you want to refer to + * lifecycle can be Eviction/Replication(default) for feed and Execution(default) for process. ---++ Results Results of the suspend command. @@ -19,7 +20,6 @@ Results of the suspend command. ---+++ Rest Call POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z -Remote-User: rgautam ---+++ Result Modified: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki (original) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/ResourceList.twiki Fri Sep 12 09:43:48 2014 @@ -1,7 +1,32 @@ ---+ RESTful Resources + +---++ Resource List * REST Call on Entity Resource * REST Call on Feed/Process Instances * REST Call on Admin Resource + * REST Call on Lineage Graph Resource + +---++ Authentication + +When security is off (Pseudo/Simple), the authenticated user is the username specified in the user.name query +parameter. If the user.name parameter is not set, the server may either set the authenticated user to a default web +user, if there is any, or return an error response. + +When security is on (kerberos), authentication is performed by Kerberos SPNEGO. + +Below are examples using the curl command tool. + +Authentication when security is off (Pseudo/Simple): + +curl -i "http://:/?[user.name=&]=..." + + +Authentication using Kerberos SPNEGO when security is on: + +curl -i --negotiate -u : "http://:/?=..." + + +See also: [[../Security.twiki][Security in Falcon]] ---++ REST Call on Admin Resource @@ -23,17 +48,31 @@ | DELETE | [[EntityDelete][api/entities/delete/:entity-type/:entity-name]] | Delete the entity | | GET | [[EntityStatus][api/entities/status/:entity-type/:entity-name]] | Get the status of the entity | | GET | [[EntityDefinition][api/entities/definition/:entity-type/:entity-name]] | Get the definition of the entity | -| GET | [[EntityList][api/entities/list/:entity-type?fields=:fields]] | Get the list of entities | +| GET | [[EntityList][api/entities/list/:entity-type]] | Get the list of entities | +| GET | [[EntitySummary][api/entities/summary/:entity-type/:cluster]] | Get instance summary of all entities | | GET | [[EntityDependencies][api/entities/dependencies/:entity-type/:entity-name]] | Get the dependencies of the entity | ---++ REST Call on Feed and Process Instances -| *Call Type* | *Resource* | *Description* | -| GET | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]] | List of running instances. | -| GET | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]]] | Status of a given instance | -| POST | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]]] | Kill a given instance | -| POST | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]]] | Suspend a running instance | -| POST | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]]] | Resume a given instance | -| POST | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]]] | Rerun a given instance | -| GET | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]]] | Get logs of a given instance | - +| *Call Type* | *Resource* | *Description* | +| GET | [[InstanceRunning][api/instance/running/:entity-type/:entity-name]] | List of running instances. | +| GET | [[InstanceList][api/instance/list/:entity-type/:entity-name]] | List of instances | +| GET | [[InstanceStatus][api/instance/status/:entity-type/:entity-name]] | Status of a given instance | +| POST | [[InstanceKill][api/instance/kill/:entity-type/:entity-name]] | Kill a given instance | +| POST | [[InstanceSuspend][api/instance/suspend/:entity-type/:entity-name]] | Suspend a running instance | +| POST | [[InstanceResume][api/instance/resume/:entity-type/:entity-name]] | Resume a given instance | +| POST | [[InstanceRerun][api/instance/rerun/:entity-type/:entity-name]] | Rerun a given instance | +| GET | [[InstanceLogs][api/instance/logs/:entity-type/:entity-name]] | Get logs of a given instance | +| GET | [[InstanceSummary][api/instance/summary/:entity-type/:entity-name]] | Return summary of instances for an entity | + +---++ REST Call on Lineage Graph + +| *Call Type* | *Resource* | *Description* | +| GET | [[Graph][api/graphs/lineage/serialize]] | dump the graph | +| GET | [[AllVertices][api/graphs/lineage/vertices/all]] | get all vertices | +| GET | [[Vertices][api/graphs/lineage/vertices?key=:key&value=:value]] | get all vertices for a key index | +| GET | [[Vertex][api/graphs/lineage/vertices/:id]] | get the vertex with the specified id | +| GET | [[VertexProperties][api/graphs/lineage/vertices/properties/:id?relationships=:true]] | get the properties of the vertex with the specified id | +| GET | [[AdjacentVertices][api/graphs/lineage/vertices/:id/:direction]] | get the adjacent vertices or edges of the vertex with the specified direction | +| GET | [[AllEdges][api/graphs/lineage//edges/all]] | get all edges | +| GET | [[Edge][api/graphs/lineage/edges/:id]] | get the edge with the specified id | Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki?rev=1624488&view=auto ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki (added) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertex.twiki Fri Sep 12 09:43:48 2014 @@ -0,0 +1,35 @@ +---++ GET api/graphs/lineage/vertices/:id + * Description + * Parameters + * Results + * Examples + +---++ Description +Gets the vertex with specified id. + +---++ Parameters + * :id is the unique id of the vertex. + +---++ Results +Vertex with the specified id. + +---++ Examples +---+++ Rest Call + +GET http://localhost:15000/api/graphs/lineage/vertices/4 + +---+++ Result + +{ + "results": [ + { + "timestamp":"2014-04-21T20:55Z", + "name":"sampleIngestProcess", + "type":"process-instance", + "version":"2.0.0", + "_id":4, + "_type":"vertex" + } + ] +} + Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki?rev=1624488&view=auto ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki (added) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/VertexProperties.twiki Fri Sep 12 09:43:48 2014 @@ -0,0 +1,33 @@ +---++ GET api/graphs/lineage/vertices/properties/:id?relationships=:true + * Description + * Parameters + * Results + * Examples + +---++ Description +Gets the properties of the vertex with specified id. + +---++ Parameters + * :id is the unique id of the vertex. + * :relationships has default value of false. Pass true if relationships should be fetched. + +---++ Results + Properties associated with the specified vertex. + +---++ Examples +---+++ Rest Call + +GET http://localhost:15000/api/graphs/lineage/vertices/properties/40004?relationships=true + +---+++ Result + +{ + "results": + { + "timestamp":"2014-04-25T22:20Z", + "name":"local", + "type":"cluster-entity" + }, + "totalSize":3 +} + Added: incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki?rev=1624488&view=auto ============================================================================== --- incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki (added) +++ incubator/falcon/trunk/general/src/site/twiki/docs/restapi/Vertices.twiki Fri Sep 12 09:43:48 2014 @@ -0,0 +1,37 @@ +---++ GET api/graphs/lineage/vertices?key=:key&value=:value + * Description + * Parameters + * Results + * Examples + +---++ Description +Get all vertices for a key index given the specified value. + +---++ Parameters + * :key is the key to be matched. + * :value is the associated value of the key. + +---++ Results +All vertices matching given property key and a value. + +---++ Examples +---+++ Rest Call + +GET http://localhost:15000/api/graphs/lineage/vertices?key=name&value=sampleIngestProcess + +---+++ Result + +{ + "results": [ + { + "timestamp":"2014-04-21T20:55Z", + "name":"sampleIngestProcess", + "type":"process-instance", + "version":"2.0.0", + "_id":4, + "_type":"vertex" + } + ], + "totalSize": 1 +} + Modified: incubator/falcon/trunk/pom.xml URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/pom.xml?rev=1624488&r1=1624487&r2=1624488&view=diff ============================================================================== --- incubator/falcon/trunk/pom.xml (original) +++ incubator/falcon/trunk/pom.xml Fri Sep 12 09:43:48 2014 @@ -215,6 +215,26 @@ Talend + + rostafiychuk + Ruslan Ostafiychuk + rostafiychuk@apache.org + +03:00 + + committer + + Hortonworks + + + raghav + Raghav Kumar Gautam + raghav@apache.org + -08:00 + + committer + + Hortonworks +