Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceList.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceList.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceList.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceList.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,100 @@ +---++ 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. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +List of instances of given entity. + +The possible instance status returned and its meaning are as follows: + * WAITING - The instance is waiting for the corresponding data(feed) instances to become available. + * 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. + * RUNNING - The instance is running on the workflow engine. + * FAILED - The instance has failed during execution. + * KILLED - The instance has been killed either manually or by the system. + * SUCCEEDED - The instance has executed successfully. + * SKIPPED - This instance was not executed, but was skipped. For example, when the execution order is LAST_ONLY, the older instances are skipped. + * ERROR - There was error while executing this instance on the workflow engine. + * UNDEFINED - The status of the instance could not be determined. +---++ 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&doAs=joe +</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>
Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceLogs.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceLogs.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceLogs.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceLogs.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,113 @@ +---++ GET /api/instance/logs/: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 log of a specific instance of an 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. + * runId <optional param> Run Id. + * 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. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Log of specified instance. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z +</verbatim> +---+++ Result +<verbatim> +{ + "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" + } + ], + "requestId": "default\/3527038e-8334-4e50-8173-76c4fa430d0b\n", + "message": "default\/STATUS\n", + "status": "SUCCEEDED" +} +</verbatim> + +---+++ Rest Call +<verbatim> +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&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "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" +} +</verbatim> + + + Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceParams.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceParams.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceParams.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceParams.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,83 @@ +---++ GET /api/instance/params/: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 the params passed to the workflow for an instance of feed/process. + +---++ Parameters + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * start should be the nominal time of the instance for which you want the params to be returned + * 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). + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + + +---++ Results +List of instances currently running. + +---++ Examples +---+++ Rest Call +<verbatim> +http://userqa.user.com:16000/api/instance/params/process/Sample-Process?start=2014-10-01T11:00Z&colo=*&doAs=joe +</verbatim> +---+++ Result +{ + "status": "SUCCEEDED", + "message": "ua1/PARAMS\n", + "requestId": "ua1/807e9fe6-ba60-490e-b720-f8dc8b92063e\n", + "instances": [ + { + "instance": "2014-10-01T11:00Z", + "status": "RUNNING", + "logFile": "http://spyke.user.com:11000/oozie?job=0000211-141117203201940-oozie-oozi-W";, + "cluster": "sample-cluster", + "startTime": "2014-11-19T19:46:29+08:00", + "details": "", + "actions": [ + { + "action": "succeeded-post-processing", + "status": "RUNNING", + "logFile": "http://spyke.user.com:50030/jobdetails.jsp?jobid=job_201411071450_1052"; + } + ], + "params": { + "entry": {"key": "jobTracker", "value": "10.16.114.113:8021"}, + "entry":{"key":"falconInputNames","value":"IGNORE"}, + "entry":{"key":"shouldRecord","value":"false"}, + "entry":{"key":"timeStamp","value":"2014-11-19-11-46"}, + "entry":{"key":"falconInPaths","value":"IGNORE"}, + "entry":{"key":"broker.url","value":"tcp://localhost:61616"}, + "entry":{"key":"feedNames","value":"NONE"}, + "entry":{"key":"falcon.libpath","value":"/path/falcon/sample/lib"}, + "entry":{"key":"ENTITY_PATH","value":"/path/falcon/staging/falcon/workflows/process/Sample-Process/9506be19980e0e6fdb709e1baffff_1416397585511/DEFAULT"}, + "entry":{"key":"entityType","value":"process"}, + "entry":{"key":"nominalTime","value":"2014-10-01-11-00"}, + "entry":{"key":"feedInstancePaths","value":"IGNORE"}, + "entry":{"key":"oozie.bundle.application.path","value":"hdfs://10.16.104.13:8020/path/falcon/staging/falcon/workflows/process/Sample-Process/9506be19980e0e669709e1baffff_1416397585511"}, + "entry":{"key":"logDir","value":"hdfs://10.16.104.13:8020/path/falcon/staging/falcon/workflows/process/Sample-Process/logs"}, + "entry":{"key":"userWorkflowEngine","value":"oozie"}, + "entry":{"key":"broker.ttlInMins","value":"4320"}, + "entry":{"key":"oozie.use.system.libpath","value":"true"}, + "entry":{"key":"queueName","value":"reports"}, + "entry":{"key":"falconDataOperation","value":"GENERATE"}, + "entry":{"key":"oozie.wf.external.id","value":"Sample-Process/DEFAULT/2014-10-01T11:00Z"}, + "entry":{"key":"workflowEngineUrl","value":"http://10.11.100.10:11000/oozie/"}, + "entry":{"key":"userBrokerImplClass","value":"org.apache.activemq.ActiveMQConnectionFactory"}, + "entry":{"key":"ENTITY_NAME","value":"FALCON_PROCESS_DEFAULT_Sample-Process"}, + "entry":{"key":"broker.impl.class","value":"org.apache.activemq.ActiveMQConnectionFactory"}, + "entry":{"key":"userWorkflowName","value":"Sample-workflow"}, + "entry":{"key":"entityName","value":"Sample-Process"}, + "entry":{"key":"srcClusterName","value":"NA"}, + "entry":{"key":"userBrokerUrl","value":"tcp://localhost:61616?daemon=true"}, + "entry":{"key":"falconInputFeeds","value":"NONE"}, + "entry":{"key":"user.name","value":"sampleuser"}, + "entry":{"key":"threedaysback","value":"2014-09-28"}, + "entry":{"key":"userWorkflowVersion","value":"1.0"} + } + } + ] +} Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRerun.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRerun.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRerun.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRerun.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,66 @@ +---++ POST /api/instance/rerun/: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 +Rerun instances of an entity. On issuing a rerun, by default the execution resumes from the last failed node in the workflow. + +---++ 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 + * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process. + * force <optional param> can be used to forcefully rerun the entire instance. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Results of the rerun command. + +---++ Examples +---+++ Rest Call +<verbatim> +POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:10:47-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n", + "message": "default\/RERUN\n", + "status": "SUCCEEDED" +} +</verbatim> + +<verbatim> +POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2013-04-03T07:00Z&end=2014-04-03T07:00Z&force=true&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:10:47-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/7a3582bd-608c-45a7-9b74-1837b51ba6d5\n", + "message": "default\/RERUN\n", + "status": "SUCCEEDED" +} +</verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceResume.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceResume.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceResume.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceResume.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,43 @@ +---++ POST /api/instance/resume/: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 +Resume suspended 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(s) that you want to refer to + * end is the end time of the instance(s) that you want to refer to + * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Results of the resume command. + +---++ Examples +---+++ Rest Call + <verbatim> + POST http://localhost:15000/api/instance/resume/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe + </verbatim> + ---+++ Result + <verbatim> + { + "instances": [ + { + "details": "", + "startTime": "2013-10-21T15:19:57-07:00", + "cluster": "primary-cluster", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000070-131021115933395-oozie-rgau-W", + "status": "RUNNING", + "instance": "2012-04-03T07:00Z" + } + ], + "requestId": "default\/e88ff2e0-2af7-4829-a360-f92e95be2981\n", + "message": "default\/RESUME\n", + "status": "SUCCEEDED" + } + </verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRunning.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRunning.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRunning.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceRunning.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,84 @@ +---++ GET /api/instance/running/: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 a list of instances currently running for a given entity. + +---++ Parameters + * :entity-type Valid options are cluster, feed or process. + * :entity-name Name of the entity. + * 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=CLUSTER:primary-cluster + * Supported filter fields are 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. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +List of instances currently running. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=* +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "startTime": "2013-10-21T14:39:28-07:00", + "cluster": "primary-cluster", + "status": "RUNNING", + "instance": "2012-04-03T06:00Z" + } + ], + "requestId": "default\/12e9a7d4-3b4f-4a76-b471-c8f3786a62a0\n", + "message": "default\/Running Instances\n", + "status": "SUCCEEDED" +} +</verbatim> + + +---+++ Rest Call +<verbatim> +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&doAs=joe +</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": "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" +} +</verbatim> + Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceStatus.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceStatus.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceStatus.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceStatus.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,97 @@ +---++ GET /api/instance/status/: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 status of a specific instance of an 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. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Status of the specified instance along with job urls for all actions of user workflow and non-succeeded actions of the main-workflow. + +---++ Examples +---+++ Rest Call +<verbatim> +GET https://localhost:15443/api/instance/status/process/WordCount?start=2014-11-04T16:00Z&colo=* +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "endTime": "2014-11-05T16:08:10+05:30", + "startTime": "2014-11-05T16:07:29+05:30", + "cluster": "local", + "logFile": "http:\/\/localhost:11000\/oozie?job=0000011-141105155430303-oozie-oozi-W", + "status": "SUCCEEDED", + "instance": "2014-11-04T16:00Z", + "actions": [ + { + "action": "wordcount-mr", + "status": "SUCCEEDED", + "logFile": "http:\/\/localhost:50030\/jobdetails.jsp?jobid=job_201411051553_0005" + } + ] + } + ], + "requestId": "default\/b9fc3cba-1b46-4d1f-8196-52c795ea3580\n", + "message": "default\/STATUS\n", + "status": "SUCCEEDED" +} +</verbatim> + + +---+++ Rest Call +<verbatim> +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&doAs=joe +</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> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSummary.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSummary.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSummary.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSummary.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,114 @@ +---++ GET /api/instance/summary/: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 summary of instance/instances of an entity. + +---++ Parameters + * :entity-type Valid options are 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. + Example1: filterBy=STATUS:RUNNING,CLUSTER:primary-cluster + Example2: filterBy=Status:RUNNING,Status:KILLED + * Supported filter fields are STATUS, CLUSTER + * Query will do an AND among filterBy fields. + * orderBy <optional param> Field by which results should be ordered. + * Supports ordering by "cluster". + * sortOrder <optional param> Valid options are "asc" and "desc" + Example: orderBy=cluster sortOrder=asc + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Summary of the instances over the specified time range + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/summary/process/WordCount?colo=*&start=2014-01-21T13:00Z&end=2014-01-21T16:00Z +</verbatim> +---+++ Result +<verbatim> +{ + "status":"SUCCEEDED", + "message":"default/SUMMARY\n", + "requestId":"default/c344567b-da73-44d5-bcd4-bf456524934c\n", + "instancesSummary": + { + "cluster":"local", + "map": + { + "entry": + { + "key":"SUCCEEDED", + "value":"value" + } + } + } + } +} +</verbatim> + +---+++ Rest Call +<verbatim> +GET https://localhost:16443/api/instance/summary/process/WordCount?filterBy=Status:KILLED,Status:RUNNING&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=* +</verbatim> +---+++ Result +<verbatim> +{ + "status":"SUCCEEDED", + "message":"local/SUMMARY\n", + "requestId":"local/1246061948@qtp-1059149611-5 - 34d8c3bb-f461-4fd5-87cd-402c9c6b1ed2\n", + "instancesSummary":[ + { + "cluster":"local", + "map":{ + "entry":{ + "key":"RUNNING", + "value":"1" + }, + "entry":{ + "key":"KILLED", + "value":"1" + } + } + } + ] +} +</verbatim> + +---+++ Rest Call +<verbatim> +GET https://localhost:16443/api/instance/summary/process/WordCount?orderBy=cluster&sortOrder=asc&start=2015-06-24T16:00Z&end=2015-06-24T23:00Z&colo=*&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "status":"SUCCEEDED", + "message":"local/SUMMARY\n", + "requestId":"local/1246061948@qtp-1059149611-5 - 42e2040d-6b6e-4bfd-a090-83db5ed1a429\n", + "instancesSummary":[ + { + "cluster":"local", + "map":{ + "entry":{ + "key":"SUCCEEDED", + "value":"6" + }, + "entry":{ + "key":"KILLED", + "value":"1" + } + } + } + ] +} +</verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSuspend.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSuspend.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSuspend.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/InstanceSuspend.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,44 @@ +---++ POST /api/instance/suspend/: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 +Suspend 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(s) that you want to refer to + * end is the end time of the instance(s) that you want to refer to + * lifecycle <optional param> can be Eviction/Replication(default) for feed and Execution(default) for process. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Results of the suspend command. + +---++ Examples +---+++ Rest Call +<verbatim> +POST http://localhost:15000/api/instance/suspend/process/SampleProcess?colo=*&start=2012-04-03T07:00Z&end=2014-04-03T07:00Z&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "instances": [ + { + "details": "", + "endTime": "2013-10-21T15:15:01-07:00", + "startTime": "2013-10-21T15:14:32-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\/ff07e45b-b6da-4f47-ae96-9182bd8a7e53\n", + "message": "default\/SUSPEND\n", + "status": "SUCCEEDED" +} +</verbatim> \ No newline at end of file Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataList.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataList.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataList.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataList.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,31 @@ +---++ GET api/metadata/discovery/:type/list + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get all dimensions of specified type. + +---++ Parameters + * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines + * cluster <optional query param> Show dimensions related to this cluster. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + + +---++ Results +List of dimensions that match requested type [and cluster]. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/discovery/process_entity/list?cluster=primary-cluster&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": ["sampleIngestProcess","testProcess","anotherProcess"], + "totalSize": 3 +} +</verbatim> + Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataRelations.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataRelations.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataRelations.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/MetadataRelations.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,46 @@ +---++ GET api/metadata/discovery/:dimension-type/:dimension-name/relations + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Get all relations of a specific dimension. + +---++ Parameters + * :type Valid dimension types are cluster_entity,feed_entity, process_entity, user, colo, tags, groups, pipelines + * :name Name of the dimension. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Get all relations of a specific dimension. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/discovery/process_entity/sample-process/relations?doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "timestamp":"2014-09-09T01:31Z", + "userWorkflowEngine":"pig", + "name":"sample-process", + "type":"PROCESS_ENTITY", + "userWorkflowName":"imp-click-join-workflow", + "version":"1.0.9", + "inVertices":[ + {"name":"clicks-feed","type":"FEED_ENTITY","label":"input"}, + {"name":"impression-feed","type":"FEED_ENTITY","label":"input"}, + {"name":"sample-process\/2014-01-01T01:00Z","type":"PROCESS_INSTANCE","label":"instance-of"} + ], + "outVertices":[ + {"name":"Critical","type":"TAGS","label":"classified-as"}, + {"name":"testPipeline","type":"PIPELINES","label":"pipeline"}, + {"name":"primary-cluster","type":"CLUSTER_ENTITY","label":"runs-on"}, + {"name":"imp-click-join2","type":"FEED_ENTITY","label":"output"}, + {"name":"imp-click-join1","type":"FEED_ENTITY","label":"output"}, + {"name":"falcon-user","type":"USER","label":"owned-by"} + ] +} +</verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/ResourceList.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/ResourceList.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/ResourceList.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/ResourceList.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,93 @@ +---+ RESTful Resources + +---++ Resource List + * <a href="#REST_Call_on_Entity_Resource">REST Call on Entity Resource</a> + * <a href="#REST_Call_on_Feed_and_Process_Instances">REST Call on Feed/Process Instances</a> + * <a href="#REST_Call_on_Admin_Resource">REST Call on Admin Resource</a> + * <a href="#REST_Call_on_Lineage_Graph">REST Call on Lineage Graph Resource</a> + * <a href="#REST_Call_on_Metadata_Resource">REST Call on Metadata Resource</a> + +---++ 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): +<verbatim> +curl -i "http://<HOST>:<PORT>/<PATH>?[user.name=<USER>&]<PARAM>=..." +</verbatim> + +Authentication using Kerberos SPNEGO when security is on: +<verbatim> +curl -i --negotiate -u : "http://<HOST>:<PORT>/<PATH>?<PARAM>=..." +</verbatim> + +See also: [[../Security.twiki][Security in Falcon]] + +The current version of the rest api's documentation is also hosted on the Falcon server and Prism Server (in distributed mode) at the url http://<HOST>:<PORT>/docs + +---++ REST Call on Admin Resource + +| *Call Type* | *Resource* | *Description* | +| GET | [[AdminStack][api/admin/stack]] | Get stack of the server | +| GET | [[AdminVersion][api/admin/version]] | Get version of the server | +| GET | [[AdminConfig][api/admin/config/:config-type]] | Get configuration information of the server | + +---++ REST Call on Entity Resource + +| *Call Type* | *Resource* | *Description* | +| POST | [[EntityValidate][api/entities/validate/:entity-type]] | Validate the entity | +| POST | [[EntitySubmit][api/entities/submit/:entity-type]] | Submit the entity | +| POST | [[EntityUpdate][api/entities/update/:entity-type/:entity-name]] | Update the entity | +| POST | [[EntitySubmitAndSchedule][api/entities/submitAndSchedule/:entity-type]] | Submit & Schedule the entity | +| POST | [[EntitySchedule][api/entities/schedule/:entity-type/:entity-name]] | Schedule the entity | +| POST | [[EntitySuspend][api/entities/suspend/:entity-type/:entity-name]] | Suspend the entity | +| POST | [[EntityResume][api/entities/resume/:entity-type/:entity-name]] | Resume the entity | +| 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]] | 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 | +| GET | [[FeedSLA][api/entities/sla-alert/:entity-type]] | Get pending feed instances which missed sla | +| GET | [[FeedLookup][api/entities/lookup/feed/]] | Get feed for given path | + +---++ 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 | [[InstanceParams][api/instance/params/:entity-type/:entity-name]] | List of entity instances along with their workflow params. | +| 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 | [[Triage][api/instance/triage/:entity-type/:entity-name]] | Triage an instance to see it's stuck lineage | +| GET | [[InstanceSummary][api/instance/summary/:entity-type/:entity-name]] | Return summary of instances for an entity | +| GET | [[InstanceDependency][api/instance/dependencies/:entity-type/:entity-name]] | Return dependent instances for a given instance | + +---++ REST Call on Metadata Lineage Resource + +| *Call Type* | *Resource* | *Description* | +| GET | [[Graph][api/metadata/lineage/serialize]] | dump the graph | +| GET | [[AllVertices][api/metadata/lineage/vertices/all]] | get all vertices | +| GET | [[Vertices][api/metadata/lineage/vertices?key=:key&value=:value]] | get all vertices for a key index | +| GET | [[Vertex][api/metadata/lineage/vertices/:id]] | get the vertex with the specified id | +| GET | [[VertexProperties][api/metadata/lineage/vertices/properties/:id?relationships=:true]] | get the properties of the vertex with the specified id | +| GET | [[AdjacentVertices][api/metadata/lineage/vertices/:id/:direction]] | get the adjacent vertices or edges of the vertex with the specified direction | +| GET | [[AllEdges][api/metadata/lineage/edges/all]] | get all edges | +| GET | [[Edge][api/metadata/lineage/edges/:id]] | get the edge with the specified id | +| GET | [[EntityLineage][api/metadata/lineage/entities?pipeline=:name]] | Get lineage graph for processes and feeds in the specified pipeline | + +---++ REST Call on Metadata Discovery Resource + +| *Call Type* | *Resource* | *Description* | +| GET | [[MetadataList][api/metadata/discovery/:dimension-type/list]] | list of dimensions | +| GET | [MetadataRelations][api/metadata/discovery/:dimension-type/:dimension-name/relations]] | Return all relations of a dimension | Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/Triage.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/Triage.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/Triage.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/Triage.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,45 @@ +---++ GET api/instance/triage/: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 +Given a feed/process instance this command traces it's ancestors to find what all ancestors have failed. It's useful if +lot of instances are failing in a pipeline as it then finds out the root cause of the pipeline being stuck. + + +---++ Parameters + * :entity-type type of entity(feed/process). + * :entity-name name of the feed/process. + * :start instance time of the entity instance. + * :colo <optional param> name of the colo on which you want to triage + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +It returns a json graph + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/instance/triage/feed/my-feed?start=2015-03-02T00:00Z&colo=local&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "vertices": ["(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]", "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]"], + "edges": + [ + { + "from" : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", + "to" : "(FEED) my-feed (2015-03-02T00:00Z) [Unavailable]", + "label" : "produces" + }, + { + "from" : "(FEED) input-feed-for-producer (2015-03-01T00:00Z) [Available]", + "to" : "(PROCESS) producer-process (2015-03-01T10:00Z) [TIMEDOUT]", + "label" : "consumed by" + } + ] +} +</verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertex.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertex.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertex.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertex.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,36 @@ +---++ GET api/metadata/lineage/vertices/:id + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ Description +Gets the vertex with specified id. + +---++ Parameters + * :id is the unique id of the vertex. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +Vertex with the specified id. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/lineage/vertices/4?doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": [ + { + "timestamp":"2014-04-21T20:55Z", + "name":"sampleIngestProcess", + "type":"process-instance", + "version":"2.0.0", + "_id":4, + "_type":"vertex" + } + ] +} +</verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/VertexProperties.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/VertexProperties.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/VertexProperties.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/VertexProperties.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,34 @@ +---++ GET api/metadata/lineage/vertices/properties/:id?relationships=:true + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ 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. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results + Properties associated with the specified vertex. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/lineage/vertices/properties/40004?relationships=true&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": + { + "timestamp":"2014-04-25T22:20Z", + "name":"local", + "type":"cluster-entity" + }, + "totalSize":3 +} +</verbatim> Added: falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertices.twiki URL: http://svn.apache.org/viewvc/falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertices.twiki?rev=1730446&view=auto ============================================================================== --- falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertices.twiki (added) +++ falcon/trunk/releases/0.9/src/site/twiki/restapi/Vertices.twiki Mon Feb 15 05:08:31 2016 @@ -0,0 +1,38 @@ +---++ GET api/metadata/lineage/vertices?key=:key&value=:value + * <a href="#Description">Description</a> + * <a href="#Parameters">Parameters</a> + * <a href="#Results">Results</a> + * <a href="#Examples">Examples</a> + +---++ 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. + * doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system. + +---++ Results +All vertices matching given property key and a value. + +---++ Examples +---+++ Rest Call +<verbatim> +GET http://localhost:15000/api/metadata/lineage/vertices?key=name&value=sampleIngestProcess&doAs=joe +</verbatim> +---+++ Result +<verbatim> +{ + "results": [ + { + "timestamp":"2014-04-21T20:55Z", + "name":"sampleIngestProcess", + "type":"process-instance", + "version":"2.0.0", + "_id":4, + "_type":"vertex" + } + ], + "totalSize": 1 +} +</verbatim> \ No newline at end of file
