falcon-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From srik...@apache.org
Subject svn commit: r1536254 [2/2] - in /incubator/falcon/trunk: general/src/site/ general/src/site/twiki/docs/restapi/ releases/0.3-incubating/src/site/twiki/ releases/0.3-incubating/src/site/twiki/docs/restapi/
Date Mon, 28 Oct 2013 05:17:36 GMT
Added: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceLogs.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceLogs.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceLogs.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceLogs.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,49 @@
+---++ 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 can either be a feed or a process.
+   * :entity-name is name of the entity.
+   * start is the start time of the instace that you want to refer to
+
+---++ Results
+Log of specified instance.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/logs/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</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>

Added: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRerun.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRerun.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRerun.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRerun.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,41 @@
+---++  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 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
+
+---++ Results
+Results of the rerun command.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+POST http://localhost:15000/api/instance/rerun/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</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: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceResume.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceResume.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceResume.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceResume.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,41 @@
+---++  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 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
+
+---++ 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
+Remote-User: rgautam
+</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: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRunning.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRunning.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRunning.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceRunning.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,38 @@
+---++  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 can either be a feed or a process.
+   * :entity-name is name of the entity.
+
+---++ Results
+List of instances currently running.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/running/process/SampleProcess?colo=*
+Remote-User: rgautam
+</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>

Added: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceStatus.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceStatus.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceStatus.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceStatus.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,42 @@
+---++  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 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
+
+---++ Results
+Status of the specified instance.
+
+---++ Examples
+---+++ Rest Call
+<verbatim>
+GET http://localhost:15000/api/instance/status/process/SampleProcess?colo=*&start=2012-04-03T07:00Z
+Remote-User: rgautam
+</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>

Added: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceSuspend.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceSuspend.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceSuspend.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/InstanceSuspend.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,42 @@
+---++  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 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
+
+---++ 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
+Remote-User: rgautam
+</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>

Added: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/ResourceList.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/ResourceList.twiki?rev=1536254&view=auto
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/ResourceList.twiki
(added)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/docs/restapi/ResourceList.twiki
Mon Oct 28 05:17:35 2013
@@ -0,0 +1,39 @@
+---+ RESTful Resources
+   * <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>
+
+---++ 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         | [[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 |
+

Modified: incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/index.twiki
URL: http://svn.apache.org/viewvc/incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/index.twiki?rev=1536254&r1=1536253&r2=1536254&view=diff
==============================================================================
--- incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/index.twiki (original)
+++ incubator/falcon/trunk/releases/0.3-incubating/src/site/twiki/index.twiki Mon Oct 28 05:17:35
2013
@@ -9,3 +9,5 @@
    * <a href="./docs/EntitySpecification.html">Entity specification</a>
 
    * <a href="./docs/FalconCLI.html">CLI</a>
+
+   * <a href="./docs/restapi/ResourceList.html">Rest API</a>



Mime
View raw message