| <!DOCTYPE html> |
| <!-- |
| | Generated by Apache Maven Doxia at 2018-03-12 |
| | Rendered using Apache Maven Fluido Skin 1.3.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <meta name="Date-Revision-yyyymmdd" content="20180312" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| <title>Falcon - GET api/extension/definition/:extensionÂname</title> |
| <link rel="stylesheet" href="../css/apache-maven-fluido-1.3.0.min.css" /> |
| <link rel="stylesheet" href="../css/site.css" /> |
| <link rel="stylesheet" href="../css/print.css" media="print" /> |
| |
| |
| <script type="text/javascript" src="../js/apache-maven-fluido-1.3.0.min.js"></script> |
| |
| |
| |
| <script type="text/javascript">$( document ).ready( function() { $( '.carousel' ).carousel( { interval: 3500 } ) } );</script> |
| |
| </head> |
| <body class="topBarDisabled"> |
| |
| |
| |
| |
| <div class="container"> |
| <div id="banner"> |
| <div class="pull-left"> |
| <div id="bannerLeft"> |
| <img src="../images/falcon-logo.png" alt="Apache Falcon" width="200px" height="45px"/> |
| </div> |
| </div> |
| <div class="pull-right"> </div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| |
| |
| <li class=""> |
| <a href="../index.html" title="Falcon"> |
| Falcon</a> |
| </li> |
| <li class="divider ">/</li> |
| <li class="">GET api/extension/definition/:extensionÂname</li> |
| |
| |
| |
| <li id="publishDate" class="pull-right">Last Published: 2018-03-12</li> <li class="divider pull-right">|</li> |
| <li id="projectVersion" class="pull-right">Version: 0.11</li> |
| |
| </ul> |
| </div> |
| |
| |
| |
| <div id="bodyColumn" > |
| |
| <div class="section"> |
| <h3>GET api/extension/definition/:extension­name<a name="GET_apiextensiondefinition:extensionname"></a></h3> |
| <p></p> |
| <ul> |
| <li><a href="#Description">Description</a></li> |
| <li><a href="#Parameters">Parameters</a></li> |
| <li><a href="#Results">Results</a></li> |
| <li><a href="#Examples">Examples</a></li></ul></div> |
| <div class="section"> |
| <h3>Description<a name="Description"></a></h3> |
| <p>Get definition of the extension.</p></div> |
| <div class="section"> |
| <h3>Parameters<a name="Parameters"></a></h3> |
| <p></p> |
| <ul> |
| <li>:extension­name Name of the extension.</li></ul></div> |
| <div class="section"> |
| <h3>Results<a name="Results"></a></h3> |
| <p>Outputs a JSON document describing the extension invocation parameters.</p></div> |
| <div class="section"> |
| <h3>Examples<a name="Examples"></a></h3></div> |
| <div class="section"> |
| <h4>Rest Call<a name="Rest_Call"></a></h4> |
| <div class="source"> |
| <pre> |
| GET http://localhost:15000/api/extension/definition/hdfs­mirroring |
| |
| </pre></div></div> |
| <div class="section"> |
| <h4>Result<a name="Result"></a></h4> |
| <div class="source"> |
| <pre> |
| { |
| "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" |
| } |
| ] |
| } |
| |
| </pre></div></div> |
| </div> |
| </div> |
| |
| <hr/> |
| |
| <footer> |
| <div class="container"> |
| <div class="row span12">Copyright © 2013-2018 |
| <a href="http://www.apache.org">Apache Software Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| |
| |
| <p id="poweredBy" class="pull-right"> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /> |
| </a> |
| </p> |
| |
| </div> |
| </footer> |
| </body> |
| </html> |
