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 A3328200B81 for ; Tue, 9 Aug 2016 01:15:41 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id A1FB1160AB9; 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 5FF6A160A91 for ; Tue, 9 Aug 2016 01:15:38 +0200 (CEST) Received: (qmail 61499 invoked by uid 500); 8 Aug 2016 23:15:37 -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 59718 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 5A956E2C1A; Mon, 8 Aug 2016 23:15:36 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: balu@apache.org To: commits@falcon.apache.org Date: Mon, 08 Aug 2016 23:16:09 -0000 Message-Id: <92d248286d054fa3869fe0db3b8e103b@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [35/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/0.10/restapi/EntityUpdate.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/EntityUpdate.html b/content/0.10/restapi/EntityUpdate.html new file mode 100644 index 0000000..cc9b5bd --- /dev/null +++ b/content/0.10/restapi/EntityUpdate.html @@ -0,0 +1,163 @@ + + + + + + + + + Falcon - POST api/entities/update/:entity-type/:entity-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/entities/update/:entity-type/:entity-name

+

+
+
+

Description

+

Updates the submitted entity.

+
+

Parameters

+

+
    +
  • :entity-type can be cluster, feed or process.
    • +
  • :entity-name is name of the cluster, feed or process.
    • +
  • skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
    • +
  • doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+

Results

+

Result of the validation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/update/process/SampleProcess?skipDryRun=false&doAs=joe
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+    <clusters>
+      <cluster name="primary-cluster">
+	<validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+      </cluster>
+    </clusters>
+
+    <parallel>1</parallel>
+    <order>FIFO</order>
+    <frequency>hours(1)</frequency>
+
+    <inputs>
+        <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+    </inputs>
+
+    <outputs>
+        <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+    </outputs>
+
+    <properties>
+        <property name="queueName" value="default" />
+        <property name="ssh.host" value="localhost" />
+        <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+    </properties>
+
+    <workflow engine="oozie" path="/examples/apps/aggregator" />
+    <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+    
+    <late-process policy="exp-backoff" delay="hours(1)">
+        <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+    </late-process>
+</process>
+
+
+
+

Result

+
+
+{
+    "requestId": "update\/default\/d6aaa328-6836-4818-a212-515bb43d8b86\n\n",
+    "message": "update\/default\/SampleProcess updated successfully\n\n",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/EntityValidate.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/EntityValidate.html b/content/0.10/restapi/EntityValidate.html new file mode 100644 index 0000000..685a3ec --- /dev/null +++ b/content/0.10/restapi/EntityValidate.html @@ -0,0 +1,281 @@ + + + + + + + + + Falcon - POST api/entities/validate/entity-type + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/entities/validate/entity-type

+

+
+
+

Description

+

Validates the submitted entity.

+
+

Parameters

+

+
    +
  • :entity-type can be cluster, feed or process.
    • +
  • skipDryRun : Optional query param, Falcon skips oozie dryrun when value is set to true.
    • +
  • doAs <optional query param> allows the current user to impersonate the user passed in doAs when interacting with the Falcon system.
+
+

Results

+

Result of the validation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/cluster
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<cluster xmlns="uri:falcon:cluster:0.1" name="primary-cluster" description="Primary Cluster" colo="west-coast">
+    <interfaces>
+        <interface type="readonly" endpoint="hftp://localhost:50070" version="1.1.1"/>
+        <interface type="write" endpoint="hdfs://localhost:9000" version="1.1.1"/>
+        <interface type="execute" endpoint="localhost:9001" version="1.1.1"/>
+        <interface type="workflow" endpoint="http://localhost:11000/oozie/" version="4.0.0"/>
+        <interface type="messaging" endpoint="tcp://localhost:61616?daemon=true" version="5.4.3"/>
+    </interfaces>
+    <locations>
+        <location name="staging" path="/apps/falcon/staging"/>
+        <location name="temp" path="/tmp"/>
+        <location name="working" path="/apps/falcon/working"/>
+    </locations>
+</cluster>
+
+
+
+

Result

+
+
+{
+    "requestId": "dd3f6c3a-a6f1-4c50-97fb-3f9a3f698e10",
+    "message": "Validated successfully (CLUSTER) primary-cluster",
+    "status": "SUCCEEDED"
+}
+
+
+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/feed?skipDryRun=true
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Hourly sample input data -->
+
+<feed description="sample input data"
+      name="SampleInput" xmlns="uri:falcon:feed:0.1"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <groups>group</groups>
+    <frequency>hours(1)</frequency>
+    <late-arrival cut-off="hours(6)" />
+    <clusters>
+        <cluster name="primary-cluster" type="source">
+            <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+            <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+            <retention limit="months(24)" action="delete" />
+        </cluster>
+    </clusters>
+
+    <locations>
+        <location type="data" path="/projects/bootcamp/data/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleInput" />
+        <location type="stats" path="/projects/bootcamp/stats/SampleInput" />
+        <location type="meta" path="/projects/bootcamp/meta/SampleInput" />
+    </locations>
+
+    <ACL owner="suser" group="users" permission="0755" />
+
+    <schema location="/none" provider="none" />
+</feed>
+
+
+
+

Result

+
+
+{
+    "requestId": "c85b190e-e653-493a-a863-d62de9c2e3b0",
+    "message": "Validated successfully (FEED) SampleInput",
+    "status": "SUCCEEDED"
+}
+
+
+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/feed
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample output data -->
+
+<feed description="sample output data" name="SampleOutput" xmlns="uri:falcon:feed:0.1"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <groups>group</groups>
+    <frequency>hours(1)</frequency>
+    <late-arrival cut-off="hours(6)" />
+    <clusters>
+        <cluster name="primary-cluster" type="source">
+            <!--validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" timezone="UTC" /-->
+            <validity start="2009-01-01T00:00Z" end="2099-12-31T00:00Z" />
+            <retention limit="months(24)" action="delete" />
+        </cluster>
+    </clusters>
+    <locations>
+        <location type="data" path="/projects/bootcamp/output/${YEAR}-${MONTH}-${DAY}-${HOUR}/SampleOutput" />
+        <location type="stats" path="/projects/bootcamp/stats/SampleOutput" />
+        <location type="meta" path="/projects/bootcamp/meta/SampleOutput" />
+    </locations>
+    <ACL owner="suser" group="users" permission="0755" />
+    <schema location="/none" provider="none" />
+</feed>
+
+
+
+

Result

+
+
+{
+    "requestId": "60781732-460e-4c6c-ba86-a75fae574b05",
+    "message": "Validated successfully (FEED) SampleOutput",
+    "status": "SUCCEEDED"
+}
+
+
+
+

Rest Call

+
+
+POST http://localhost:15000/api/entities/validate/process?skipDryRun=false&doAs=joe
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Daily sample process. Runs at 6th hour every day. Input - last day's hourly data. Generates output for yesterday -->
+<process xmlns="uri:falcon:process:0.1" name="SampleProcess" >
+    <clusters>
+      <cluster name="primary-cluster">
+	<validity start="2012-04-03T06:00Z" end="2022-12-30T00:00Z" />
+      </cluster>
+    </clusters>
+
+    <parallel>1</parallel>
+    <order>FIFO</order>
+    <frequency>hours(1)</frequency>
+
+    <inputs>
+        <input name="input" feed="SampleInput" start="yesterday(0,0)" end="today(-1,0)" />
+    </inputs>
+
+    <outputs>
+        <output name="output" feed="SampleOutput" instance="yesterday(0,0)" />
+    </outputs>
+
+    <properties>
+        <property name="queueName" value="default" />
+        <property name="ssh.host" value="localhost" />
+        <property name="fileTimestamp" value="${coord:formatTime(coord:nominalTime(), 'yyyy-MM-dd')}" />
+    </properties>
+
+    <workflow engine="oozie" path="/examples/apps/aggregator" />
+    <retry policy="exp-backoff" delay="minutes(5)" attempts="3" />
+    
+    <late-process policy="exp-backoff" delay="hours(1)">
+        <late-input input="input" workflow-path="/projects/bootcamp/workflow/lateinput" />
+    </late-process>
+</process>
+
+
+
+

Result

+
+
+{
+    "requestId": "e4a965c6-c7a2-41d9-ba08-2e77f1c43f57",
+    "message": "Validated successfully (PROCESS) SampleProcess",
+    "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionDefinition.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionDefinition.html b/content/0.10/restapi/ExtensionDefinition.html new file mode 100644 index 0000000..28ce967 --- /dev/null +++ b/content/0.10/restapi/ExtensionDefinition.html @@ -0,0 +1,258 @@ + + + + + + + + + Falcon - GET api/extension/definition/:extension­name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

GET api/extension/definition/:extension­name

+

+
+
+

Description

+

Get definition of the extension.

+
+

Parameters

+

+
    +
  • :extension­name Name of the extension.
+
+

Results

+

Outputs a JSON document describing the extension invocation parameters.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/extension/definition/hdfs­mirroring
+
+
+
+

Result

+
+
+{
+    "shortDescription": "This extension implements replicating arbitrary directories on HDFS from one Hadoop cluster to another Hadoop cluster. This piggy backs on replication solution in Falcon which uses the DistCp tool.",
+    "properties":[
+        {
+            "propertyName":"jobName",
+            "required":true,
+            "description":"Unique job name",
+            "example":"hdfs-monthly-sales-dr"
+        },
+        {
+            "propertyName":"jobClusterName",
+            "required":true,
+            "description":"Cluster where job should run",
+            "example":"backupCluster"
+        },
+        {
+            "propertyName":"jobValidityStart",
+            "required":true,
+            "description":"Job validity start time",
+            "example":"2016-03-03T00:00Z"
+        },
+        {
+            "propertyName":"jobValidityEnd",
+            "required":true,
+            "description":"Job validity end time",
+            "example":"2018-03-13T00:00Z"
+        },
+        {
+            "propertyName":"jobFrequency",
+            "required":true,
+            "description":"job frequency. Valid frequency types are minutes, hours, days, months",
+            "example":"months(1)"
+        },
+        {
+            "propertyName":"jobTimezone",
+            "required":false,
+            "description":"Time zone for the job",
+            "example":"GMT"
+        },
+        {
+            "propertyName":"jobTags",
+            "required":false,
+            "description":"list of comma separated tags. Key Value Pairs, separated by comma",
+            "example":"consumer=consumer@xyz.com, owner=producer@xyz.com, _department_type=forecasting"
+        },
+        {
+            "propertyName":"jobRetryPolicy",
+            "required":false,
+            "description":"Job retry policy",
+            "example":"periodic"
+        },
+        {
+            "propertyName":"jobRetryDelay",
+            "required":false,
+            "description":"Job retry delay",
+            "example":"minutes(30)"
+        },
+        {
+            "propertyName":"jobRetryAttempts",
+            "required":false,
+            "description":"Job retry attempts",
+            "example":"3"
+        },
+        {
+            "propertyName":"jobRetryOnTimeout",
+            "required":false,
+            "description":"Job retry on timeout",
+            "example":"true"
+        },
+        {
+            "propertyName":"jobAclOwner",
+            "required":false,
+            "description":"ACL owner",
+            "example":"ambari-qa"
+        },
+        {
+            "propertyName":"jobAclGroup",
+            "required":false,
+            "description":"ACL group",
+            "example":"users"
+        },
+        {
+            "propertyName":"jobAclPermission",
+            "required":false,
+            "description":"ACL permission",
+            "example":"0x755"
+        },
+        {
+            "propertyName":"sourceDir",
+            "required":true,
+            "description":"Multiple hdfs comma separated source directories",
+            "example":"/user/ambari-qa/primaryCluster/dr/input1, /user/ambari-qa/primaryCluster/dr/input2"
+        },
+        {
+            "propertyName":"sourceCluster",
+            "required":true,
+            "description":"Source cluster for hdfs mirroring",
+            "example":"primaryCluster"
+        },
+        {
+            "propertyName":"targetDir",
+            "required":true,
+            "description":"Target hdfs directory",
+            "example":"/user/ambari-qa/backupCluster/dr"
+        },
+        {
+            "propertyName":"targetCluster",
+            "required":true,
+            "description":"Target cluster for hdfs mirroring",
+            "example":"backupCluster"
+        },
+        {
+            "propertyName":"distcpMaxMaps",
+            "required":false,
+            "description":"Maximum number of mappers for DistCP",
+            "example":"1"
+        },
+        {
+            "propertyName":"distcpMapBandwidth",
+            "required":false,
+            "description":"Bandwidth in MB for each mapper in DistCP",
+            "example":"100"
+        },
+        {
+            "propertyName":"jobNotificationType",
+            "required":false,
+            "description":"Email Notification for Falcon instance completion",
+            "example":"email"
+        },
+        {
+            "propertyName":"jobNotificationReceivers",
+            "required":false,
+            "description":"Comma separated email Id's",
+            "example":"user1@gmail.com, user2@gmail.com"
+        }
+    ]
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionDelete.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionDelete.html b/content/0.10/restapi/ExtensionDelete.html new file mode 100644 index 0000000..5c6cb22 --- /dev/null +++ b/content/0.10/restapi/ExtensionDelete.html @@ -0,0 +1,127 @@ + + + + + + + + + Falcon - POST api/extension/delete/:job-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/extension/delete/:job-name

+

+
+
+

Description

+

Delete an extension job.

+
+

Parameters

+

+
    +
  • :job-name Name of the extension job.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Result of the delete operation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/extensions/delete/sales-monthly
+
+
+
+

Result

+
+
+{
+  "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+  "message": "Extension job sales-monthly deleted successfully",
+  "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionDescription.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionDescription.html b/content/0.10/restapi/ExtensionDescription.html new file mode 100644 index 0000000..a8013a3 --- /dev/null +++ b/content/0.10/restapi/ExtensionDescription.html @@ -0,0 +1,122 @@ + + + + + + + + + Falcon - GET api/extension/describe/:extension­name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

GET api/extension/describe/:extension­name

+

+
+
+

Description

+

Description of an extension.

+
+

Parameters

+

+
    +
  • :extension­name Name of the extension.
+
+

Results

+

Outputs the README of the specified extension.

+
+

Examples

+
+

Rest Call

+
+
+GET http://localhost:15000/api/extension/describe/hdfs­mirroring
+
+
+
+

Result

+
+
+<README file of the specified extension>
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionEnumeration.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionEnumeration.html b/content/0.10/restapi/ExtensionEnumeration.html new file mode 100644 index 0000000..278f7b0 --- /dev/null +++ b/content/0.10/restapi/ExtensionEnumeration.html @@ -0,0 +1,134 @@ + + + + + + + + + Falcon - GET api/extension/enumerate + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

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/0.10/restapi/ExtensionInstances.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionInstances.html b/content/0.10/restapi/ExtensionInstances.html new file mode 100644 index 0000000..616e6ff --- /dev/null +++ b/content/0.10/restapi/ExtensionInstances.html @@ -0,0 +1,185 @@ + + + + + + + + + Falcon - GET api/extension/instances/:job-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

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/0.10/restapi/ExtensionList.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionList.html b/content/0.10/restapi/ExtensionList.html new file mode 100644 index 0000000..990372c --- /dev/null +++ b/content/0.10/restapi/ExtensionList.html @@ -0,0 +1,169 @@ + + + + + + + + + Falcon - GET api/extension/list/:extension-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

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”}
+              }
+        }
+      }
+    ]
+  }
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionResume.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionResume.html b/content/0.10/restapi/ExtensionResume.html new file mode 100644 index 0000000..9b5b6b0 --- /dev/null +++ b/content/0.10/restapi/ExtensionResume.html @@ -0,0 +1,127 @@ + + + + + + + + + Falcon - POST api/extension/resume/:job-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/extension/resume/:job-name

+

+
+
+

Description

+

Resume an extension job.

+
+

Parameters

+

+
    +
  • :job-name Name of the extension job.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Result of the resume operation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/extensions/resume/sales-monthly
+
+
+
+

Result

+
+
+{
+  "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+  "message": "Extension job sales-monthly resumed successfully",
+  "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSchedule.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionSchedule.html b/content/0.10/restapi/ExtensionSchedule.html new file mode 100644 index 0000000..4edb98d --- /dev/null +++ b/content/0.10/restapi/ExtensionSchedule.html @@ -0,0 +1,127 @@ + + + + + + + + + Falcon - POST api/extension/schedule/:job-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/extension/schedule/:job-name

+

+
+
+

Description

+

Schedule an extension job.

+
+

Parameters

+

+
    +
  • :job-name Name of the extension job.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Result of the schedule operation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/extensions/schedule/sales-monthly
+
+
+
+

Result

+
+
+{
+  "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+  "message": "Extension job sales-monthly scheduled successfully",
+  "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSubmit.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionSubmit.html b/content/0.10/restapi/ExtensionSubmit.html new file mode 100644 index 0000000..5da5ce5 --- /dev/null +++ b/content/0.10/restapi/ExtensionSubmit.html @@ -0,0 +1,136 @@ + + + + + + + + + Falcon - POST api/extension/submit/:extension-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/extension/submit/:extension-name

+

+
+
+

Description

+

Submit an extension job.

+
+

Parameters

+

+
    +
  • :extension-name Name of the extension.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Result of submission.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/extensions/submit/hdfs-mirroring
+jobName=sales-monthly
+jobClustername=primaryCluster
+jobClusterValidityStart=2015-03-13T00:00Z
+jobClusterValidityEnd=2016-12-30T00:00Z
+jobFrequency=minutes(5)
+sourceDir=/user/hrt_qa/dr/test/primaryCluster/input
+sourceCluster=primaryCluster
+targetDir=/user/hrt_qa/dr/test/backupCluster/input
+targetCluster=backupCluster
+
+
+
+

Result

+
+
+{
+  "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+  "message": "Extension job submitted successfully",
+  "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSubmitAndSchedule.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionSubmitAndSchedule.html b/content/0.10/restapi/ExtensionSubmitAndSchedule.html new file mode 100644 index 0000000..3e0eb91 --- /dev/null +++ b/content/0.10/restapi/ExtensionSubmitAndSchedule.html @@ -0,0 +1,136 @@ + + + + + + + + + Falcon - POST api/extension/submitAndSchedule/:extension-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/extension/submitAndSchedule/:extension-name

+

+
+
+

Description

+

Submit and schedule an extension job.

+
+

Parameters

+

+
    +
  • :extension-name Name of the extension.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Result of the submit and schedule operation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/extensions/submitAndSchedule/hdfs-mirroring
+jobName=sales-monthly
+jobClustername=primaryCluster
+jobClusterValidityStart=2015-03-13T00:00Z
+jobClusterValidityEnd=2016-12-30T00:00Z
+jobFrequency=minutes(5)
+sourceDir=/user/hrt_qa/dr/test/primaryCluster/input
+sourceCluster=primaryCluster
+targetDir=/user/hrt_qa/dr/test/backupCluster/input
+targetCluster=backupCluster
+
+
+
+

Result

+
+
+{
+  "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+  "message": "Extension job submitted and scheduled successfully",
+  "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + + http://git-wip-us.apache.org/repos/asf/falcon/blob/4612c3f7/content/0.10/restapi/ExtensionSuspend.html ---------------------------------------------------------------------- diff --git a/content/0.10/restapi/ExtensionSuspend.html b/content/0.10/restapi/ExtensionSuspend.html new file mode 100644 index 0000000..beb811f --- /dev/null +++ b/content/0.10/restapi/ExtensionSuspend.html @@ -0,0 +1,127 @@ + + + + + + + + + Falcon - POST api/extension/suspend/:job-name + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +
+

POST api/extension/suspend/:job-name

+

+
+
+

Description

+

Suspend an extension job.

+
+

Parameters

+

+
    +
  • :job-name Name of the extension job.
    • +
  • doAs <optional> Impersonate the user.
+
+

Results

+

Result of the suspend operation.

+
+

Examples

+
+

Rest Call

+
+
+POST http://localhost:15000/api/extensions/suspend/sales-monthly
+
+
+
+

Result

+
+
+{
+  "requestId": "e5cc8230-f356-4566-9b65-536abdff8aa3",
+  "message": "Extension job sales-monthly suspended successfully",
+  "status": "SUCCEEDED"
+}
+
+
+
+
+ +
+ + + +