Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 58841200B81 for ; Tue, 9 Aug 2016 01:15:41 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 572F6160AB9; Mon, 8 Aug 2016 23:15:41 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 63F30160ABC for ; Tue, 9 Aug 2016 01:15:37 +0200 (CEST) Received: (qmail 59658 invoked by uid 500); 8 Aug 2016 23:15:36 -0000 Mailing-List: contact commits-help@falcon.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@falcon.apache.org Delivered-To: mailing list commits@falcon.apache.org Received: (qmail 59124 invoked by uid 99); 8 Aug 2016 23:15:36 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 08 Aug 2016 23:15:36 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id EF144E69FC; Mon, 8 Aug 2016 23:15:35 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: balu@apache.org To: commits@falcon.apache.org Date: Mon, 08 Aug 2016 23:15:49 -0000 Message-Id: <0a4de244a9ae4340ac9a639d1a1ecd8f@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [15/49] falcon git commit: FALCON-2006 Update documentation on site for 0.10 release archived-at: Mon, 08 Aug 2016 23:15:41 -0000 http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/ExtensionEnumeration.html ---------------------------------------------------------------------- diff --git a/content/restapi/ExtensionEnumeration.html b/content/restapi/ExtensionEnumeration.html new file mode 100644 index 0000000..41e7dc2 --- /dev/null +++ b/content/restapi/ExtensionEnumeration.html @@ -0,0 +1,649 @@ + + + + + + + + + Falcon - GET api/extension/enumerate + + + + + + + + + + + + + + + + +
+ + + + + +
+
+
+ + + + + + +
+ +
+
+
+
+ + Built by Maven + +
+
+
+ + +
+ +
+

GET api/extension/enumerate

+

+
+
+

Description

+

Get list of the supported extensions.

+
+

Parameters

+

None

+
+

Results

+

Total number of results and a list of extension server extensions supported.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/extension/enumerate
+
+
+
+

Result

+
+
+{
+    "totalResults":"2”,
+    “extensions”: [
+        {
+            “name”: “Hdfs­mirroring”
+            “type”: “Trusted/Provided extension”
+            “description”: “This extension implements replicating arbitrary directories on HDFS from one Hadoop cluster to another Hadoop cluster.”
+        },
+        {
+            “name”: “Hive­mirroring”
+            “type”: “Trusted/Provided extension”
+            “description”: “This extension implements replicating hive metadata and data from one Hadoop cluster to another Hadoop cluster.”
+        }
+    ]
+}
+
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/ExtensionInstances.html ---------------------------------------------------------------------- diff --git a/content/restapi/ExtensionInstances.html b/content/restapi/ExtensionInstances.html new file mode 100644 index 0000000..fe96c11 --- /dev/null +++ b/content/restapi/ExtensionInstances.html @@ -0,0 +1,700 @@ + + + + + + + + + Falcon - GET api/extension/instances/:job-name + + + + + + + + + + + + + + + + +
+ + + + + +
+
+
+ + + + + + +
+ +
+
+
+
+ + Built by Maven + +
+
+
+ + +
+ +
+

GET api/extension/instances/:job-name

+

+
+
+

Description

+

List instances of an extension job.

+
+

Parameters

+

+
    +
  • :job-name Name of the extension job.
    • +
  • start <optional> Show instances from this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.
    • +
  • end <optional> Show instances up to this nominal time. Format: yyyy-MM-dd'T'HH:mm'Z'.
    • +
  • instanceStatus <optional> Valid options are RUNNING, SUCCEEDED, FAILED, WAITING, SUSPENDED, KILLED, TIMEOUT.
    • +
  • fields <optional> Entity output fields separated by commas. Valid options: STATUS, TAGS, PIPELINES, CLUSTERS.
    • +
  • orderBy <optional> Column by which results should be ordered. Sorted by descending order. Valid options are nominalTime (default) and status.
    • +
  • sortOrder <optional> Valid options are “asc” and “desc”.
    • +
  • offset <optional> Show results from the offset. Used for pagination. Default is 0.
    • +
  • numResults <optional> Number of instances per entity to show. Default value is 10.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

A list of entities of the job, each followed by a set of instances.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/extensions/instances/daily-health-bill?start=2012-04-01T00:00
+
+
+
+

Result

+
+
+{
+    "numEntities": "2",
+    "entitiesSummary": {
+        "entitySummary": [
+            {
+                "entityProfile": {
+                    "type": "FEED",
+                    "name": "SampleUSHealthBill"
+                },
+                "instances": [
+                    {
+                        "instance": "2012-04-02T00:00Z",
+                        "status": "RUNNING",
+                        "cluster": "SampleCluster1",
+                        "sourceCluster": "primaryCluster",
+                        "details": "hftp://sandbox.hortonworks.com:50070/apps/falcon/adf-demo/pig-input-2012-04-02"
+                    },
+                    {
+                        "instance": "2012-04-01T00:00Z",
+                        "status": "SUCCEEDED",
+                        "cluster": "SampleCluster1",
+                        "sourceCluster": "primaryCluster",
+                        "details": "hftp://sandbox.hortonworks.com:50070/apps/falcon/adf-demo/pig-input-2012-04-01"
+                    }
+                ]
+            },
+            {
+                "entityProfile": {
+                    "type": "PROCESS",
+                    "name": "SampleBillPay"
+                },
+                "instances": [
+                    {
+                        "instance": "2012-04-02T00:00Z",
+                        "status": "RUNNING",
+                        "logFile": "http://sandbox.hortonworks.com:11000/oozie?job=0000085-160322203213815-oozie-oozi-W",
+                        "cluster": "primaryCluster",
+                        "startTime": "2016-04-04T22:37:46Z",
+                        "details": "",
+                        "actions": {
+                            "action": "dr-replication",
+                            "status": "RUNNING",
+                            "logFile": "http://sandbox.hortonworks.com:8088/proxy/application_1458678764964_0052/"
+                        }
+                    },
+                    {
+                        "instance": "2012-04-01T00:00Z",
+                        "status": "SKIPPED",
+                        "cluster": "primaryCluster"
+                    }
+                ]
+            }
+        ]
+    }
+}
+
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/restapi/ExtensionList.html ---------------------------------------------------------------------- diff --git a/content/restapi/ExtensionList.html b/content/restapi/ExtensionList.html new file mode 100644 index 0000000..b085c21 --- /dev/null +++ b/content/restapi/ExtensionList.html @@ -0,0 +1,684 @@ + + + + + + + + + Falcon - GET api/extension/list/:extension-name + + + + + + + + + + + + + + + + +
+ + + + + +
+
+
+ + + + + + +
+ +
+
+
+
+ + Built by Maven + +
+
+
+ + +
+ +
+

GET api/extension/list/:extension-name

+

+
+
+

Description

+

List jobs generated from an extension.

+
+

Parameters

+

+
    +
  • :extension-name Name of the extension.
    • +
  • sortOrder <optional> Sort order by job name. Valid options: "asc" (default) and "desc".
    • +
  • offset <optional> Show results from the offset. Default is 0.
    • +
  • numResults <optional> Number of results to show per request. Default is 10.
    • +
  • fields <optional> Output fields separated by commas. Valid options: STATUS, TAGS, PIPELINES, CLUSTERS.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Total number of results and a list of jobs generated from the extension, followed by the associated entities.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/extensions/list/billCollection?fields=status,clusters,tags
+
+
+
+

Result

+
+
+{
+  "numJobs":"2",
+  "jobs":{
+    "job": [
+      {
+        "jobName": "daily-health-bill",
+        "jobEntities: {
+          "totalResults": "2",
+          "entity": [
+            {
+              "type":"FEED",
+              "name":"SampleUSHealthBill",
+              "status":"SUBMITTED”,
+              "tags":{"tag":["related=ushealthcare","department=billingDepartment","_falcon_extension_name=billCoollection","_falcon_extension_job=daily-health-bill"]},
+              "clusters": {"cluster":["SampleCluster1","primaryCluster”]}
+            },
+            {
+              "type":"PROCESS”,
+              "name":"SampleBillPay”,
+              "status":"RUNNING”,
+              "tags":{"tag":["related=healthcare","department=billingDepartment","_falcon_extension_name=billCoollection","_falcon_extension_job=daily-health-bill"]},
+              "clusters":{"cluster":"primaryCluster”}
+            }
+          ]
+        }
+      },
+      {
+        "jobName": "fsa-bill",
+        "jobEntities": {
+          "totalResults": "1",
+          "entity":
+              {
+                "type":"PROCESS”,
+                "name":"FSAPay”,
+                "status":"RUNNING”,
+                "tags”:{"tag":["related=healthcare","department=billingDepartment","_falcon_extension_name=billCollection","_falcon_extension_job=fsa-bill"]},
+                "clusters":{"cluster":"primaryCluster”}
+              }
+        }
+      }
+    ]
+  }
+}
+
+
+
+
+
+ +
+ + + +