<!DOCTYPE html>
<!--[if lt IE 7]>      <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]>         <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]>         <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  <meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1"/>
  <title>Gearpump RESTful API reference - Gearpump 0.8.0 Documentation</title>
  

  <link rel="stylesheet" href="css/bootstrap-3.3.5.min.css">
  <style>
    body {
      padding-top: 60px;
      padding-bottom: 40px;
    }
  </style>
  <link rel="stylesheet" href="css/main.css">
  <link rel="stylesheet" href="css/pygments-default.css">
  <script src="js/vendor/modernizr-2.6.1-respond-1.1.0.min.js"></script>
</head>
<body>
  <!--[if lt IE 7]>
    <p class="chromeframe">You are using an outdated browser. <a href="http://browsehappy.com/">Upgrade your browser today</a> or <a href="http://www.google.com/chromeframe/?redirect=true">install Google Chrome Frame</a> to better experience this site.</p>
  <![endif]-->

  <div class="navbar navbar-inverse navbar-fixed-top" id="topbar">
    <div class="container">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="http://gearpump.io">Gearpump
          <span class="label label-primary" style="font-size: .6em">0.8.0</span>
        </a>
      </div>
      <div id="navbar" class="collapse navbar-collapse">
        <ul class="nav navbar-nav">
          <li><a href="index.html">Overview</a></li>

          <li class="dropdown">
            <a href="#" class="dropdown-toggle" data-toggle="dropdown">Introduction<b class="caret"></b></a>
            <ul class="dropdown-menu">
              <li><a href="submit-your-1st-application.html">Submit Your 1st Application</a></li>
              <li><a href="commandline.html">Client Command Line</a></li>
              <li class="divider"></li>
              <li><a href="basic-concepts.html">Basic Concepts</a></li>
              <li><a href="features.html">Technical Highlights</a></li>
              <li><a href="message-delivery.html">Reliable Message Delivery</a></li>
              <li><a href="performance-report.html">Performance</a></li>
              <li><a href="gearpump-internals.html">Gearpump Internals</a></li>
            </ul>
          </li>

          <li class="dropdown">
            <a href="#" class="dropdown-toggle" data-toggle="dropdown">Deploying<b class="caret"></b></a>
            <ul class="dropdown-menu">
              <li class="dropdown-header">Deployment</li>
              <li><a href="deployment-local.html">Local Mode</a><li>
              <li><a href="deployment-standalone.html">Standalone Mode</a></li>
              <li><a href="deployment-yarn.html">YARN Mode</a></li>
              <li><a href="deployment-docker.html">Docker Mode</a><li>
              <li class="divider"></li>
              <li><a href="deployment-ui-authentication.html">UI Authentication</a></li>
              <li><a href="deployment-ha.html">High Availability</a></li>
              <li><a href="deployment-msg-delivery.html">Reliable Message Delivery</a></li>
              <li><a href="deployment-configuration.html">Configuration</a></li>
              <li><a href="deployment-resource-isolation.html">Resource Isolation</a></li>
              <li class="divider"></li>
              <li><a href="deployment-security.html">YARN Security Guide</a></li>
            </ul>
          </li>

          <li class="dropdown">
            <a href="#" class="dropdown-toggle" data-toggle="dropdown">Programming Guide<b class="caret"></b></a>
            <ul class="dropdown-menu">
              <li><a href="dev-write-1st-app.html">Write Your 1st App</a></li>
              <li><a href="dev-custom-serializer.html">Customized Message Passing</a></li>
              <li class="divider"></li>
              <li><a href="api/scala/index.html">Scala API</a></li>
              <li><a href="api/java/index.html">Java API</a></li>
              <li><a href="dev-rest-api.html">RESTful API</a></li>
              <li class="divider"></li>
              <li><a href="dev-connectors.html">Gearpump Connectors</a></li>
              <li class="divider"></li>
              <li><a href="dev-storm.html">Storm Compatibility</a></li>
              <!--
              <li><a href="dev-samoa.html">Samoa Compatibility</a></li>
              <li class="divider"></li>
              <li><a href="dev-iot.html">Gearpump with IoT</a></li>
              -->
            </ul>
          </li>

          <li class="dropdown">
            <a href="#" class="dropdown-toggle" data-toggle="dropdown">More<b class="caret"></b></a>
            <ul class="dropdown-menu">
              <li><a href="how-to-contribute.html">How to Contribute</a></li>
              <li><a href="coding-style.html">Coding Style</a></li>
              <li class="divider"></li>
              <li><a href="faq.html">FAQ</a><li>
              <li><a href="about.html">About</a></li>
            </ul>
          </li>
        </ul>
      </div>
    </div>
  </div>

  <div class="container" id="content">
   
    <h1 class="title">Gearpump RESTful API reference</h1>
   

   <h2 id="authentication">Authentication.</h2>

<p>For all REST API calls, We need authentication by default. If you don&#8217;t want authentication, you can disable them.</p>

<h3 id="how-to-disable-authentication">How to disable Authentication</h3>
<p>To disable Authentication, you can set <code>gearpump-ui.gearpump.ui-security.authentication-enabled = false</code>
in gear.conf, please check <a href="deployment-ui-authentication.html">UI Authentication</a> for details.</p>

<h3 id="how-to-authenticate-if-authentication-is-enabled">How to authenticate if Authentication is enabled.</h3>

<h4 id="for-user-password-based-authentication">For User-Password based authentication</h4>

<p>If Authentication is enabled, then you need to login before calling REST API.</p>

<div class="highlight"><pre><code>curl  -X POST  --data username=admin --data password=admin --cookie-jar outputAuthenticationCookie.txt http://127.0.0.1:8090/login
</code></pre></div>

<p>This will use default user &#8220;admin:admin&#8221; to login, and store the authentication cookie to file outputAuthenticationCookie.txt.</p>

<p>In All subsequent Rest API calls, you need to add the authentication cookie. For example</p>

<div class="highlight"><pre><code>curl --cookie outputAuthenticationCookie.txt http://127.0.0.1/api/v1.0/master
</code></pre></div>

<p>for more information, please check <a href="deployment-ui-authentication.html">UI Authentication</a>.</p>

<h4 id="for-oauth2-based-authentication">For OAuth2 based authentication</h4>

<p>For OAuth2 based authentication, it requires you to have an access token in place.</p>

<p>Different OAuth2 service provider have different way to return an access token.</p>

<p><strong>For Google</strong>, you can refer to <a href="https://developers.google.com/identity/protocols/OAuth2">OAuth Doc</a>.</p>

<p><strong>For CloudFoundry UAA</strong>, you can use the uaac command to get the access token.</p>

<div class="highlight"><pre><code>$ uaac target http://login.gearpump.gotapaas.eu/
$ uaac token get &lt;user_email_address&gt;

### Find access token
$ uaac context

[0]*[http://login.gearpump.gotapaas.eu]

  [0]*[&lt;user_email_address&gt;]
      user_id: 34e33a79-42c6-479b-a8c1-8c471ff027fb
      client_id: cf
      token_type: bearer
      access_token: eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI
      expires_in: 599
      scope: password.write openid cloud_controller.write cloud_controller.read
      jti: 74ea49e4-1001-4757-9f8d-a66e52a27557
</code></pre></div>

<p>For more information on uaac, please check <a href="https://docs.cloudfoundry.org/adminguide/uaa-user-management.html">UAAC guide</a></p>

<p>Now, we have the access token, then let&#8217;s login to Gearpump UI server with this access token:</p>

<div class="highlight"><pre><code>## Please replace cloudfoundryuaa with actual OAuth2 service name you have configured in gear.conf
curl  -X POST  --data accesstoken=eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiI --cookie-jar outputAuthenticationCookie.txt http://127.0.0.1:8090/login/oauth2/cloudfoundryuaa/accesstoken
</code></pre></div>

<p>This will use user  <code>user_email_address</code> to login, and store the authentication cookie to file outputAuthenticationCookie.txt.</p>

<p>In All subsequent Rest API calls, you need to add the authentication cookie. For example</p>

<div class="highlight"><pre><code>curl --cookie outputAuthenticationCookie.txt http://127.0.0.1/api/v1.0/master
</code></pre></div>

<p><strong>NOTE:</strong> You can default the default permission level for OAuth2 user. for more information,
please check <a href="deployment-ui-authentication.html">UI Authentication</a>.</p>

<h2 id="query-version">Query version</h2>

<h3 id="get-version">GET version</h3>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/version</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>0.7.1-SNAPSHOT
</code></pre></div>

<h2 id="master-service">Master Service</h2>

<h3 id="get-apiv10master">GET api/v1.0/master</h3>
<p>Get information of masters</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/master</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "masterDescription": {
    "leader":{"host":"master@127.0.0.1","port":3000},
    "cluster":[{"host":"127.0.0.1","port":3000}]
    "aliveFor": "642941",
    "logFile": "/Users/foobar/gearpump/logs",
    "jarStore": "jarstore/",
    "masterStatus": "synced",
    "homeDirectory": "/Users/foobar/gearpump"
  }
}
</code></pre></div>

<h3 id="get-apiv10masterapplist">GET api/v1.0/master/applist</h3>
<p>Query information of all applications</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/master/applist</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "appMasters": [
    {
      "status": "active",
      "appId": 1,
      "appName": "wordCount",
      "appMasterPath": "akka.tcp://app1-executor-1@127.0.0.1:52212/user/daemon/appdaemon1/$c",
      "workerPath": "akka.tcp://master@127.0.0.1:3000/user/Worker0",
      "submissionTime": "1450758114766",
      "startTime": "1450758117294",
      "user": "lisa"
    }
  ]
}
</code></pre></div>

<h3 id="get-apiv10masterworkerlist">GET api/v1.0/master/workerlist</h3>
<p>Query information of all workers</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/master/workerlist</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>[
  {
    "workerId": "1",
    "state": "active",
    "actorPath": "akka.tcp://master@127.0.0.1:3000/user/Worker0",
    "aliveFor": "431565",
    "logFile": "logs/",
    "executors": [
      {
        "appId": 1,
        "executorId": -1,
        "slots": 1
      },
      {
        "appId": 1,
        "executorId": 0,
        "slots": 1
      }
    ],
    "totalSlots": 1000,
    "availableSlots": 998,
    "homeDirectory": "/usr/lisa/gearpump/",
    "jvmName": "11788@lisa"
  },
  {
    "workerId": "0",
    "state": "active",
    "actorPath": "akka.tcp://master@127.0.0.1:3000/user/Worker1",
    "aliveFor": "431546",
    "logFile": "logs/",
    "executors": [
      {
        "appId": 1,
        "executorId": 1,
        "slots": 1
      }
    ],
    "totalSlots": 1000,
    "availableSlots": 999,
    "homeDirectory": "/usr/lisa/gearpump/",
    "jvmName": "11788@lisa"
  }
]
</code></pre></div>

<h3 id="get-apiv10masterconfig">GET api/v1.0/master/config</h3>
<p>Get the configuration of all masters</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/master/config</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "extensions": [
    "akka.contrib.datareplication.DataReplication$"
  ]
  "akka": {
    "loglevel": "INFO"
    "log-dead-letters": "off"
    "log-dead-letters-during-shutdown": "off"
    "actor": {
      ## Master forms a akka cluster
      "provider": "akka.cluster.ClusterActorRefProvider"
    }
    "cluster": {
      "roles": ["master"]
      "auto-down-unreachable-after": "15s"
    }
    "remote": {
      "log-remote-lifecycle-events": "off"
    }
  }
}
</code></pre></div>

<h3 id="get-apiv10mastermetricsltquerypathgtreadlatestlttruefalsegt">GET api/v1.0/master/metrics/&lt;query_path&gt;?readLatest=&lt;true|false&gt;</h3>
<p>Get the master node metrics.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/master/metrics/master?readLatest<span class="o">=</span><span class="nb">true</span></code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
    "path"
:
    "master", "metrics"
:
    [{
        "time": "1450758725070",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "master:memory.heap.used", "value": "59764272"}
    }, {
        "time": "1450758725070",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "master:thread.daemon.count", "value": "18"}
    }, {
        "time": "1450758725070",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "master:memory.total.committed",
            "value": "210239488"
        }
    }, {
        "time": "1450758725070",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "master:memory.heap.max", "value": "880017408"}
    }, {
        "time": "1450758725070",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "master:memory.total.max", "value": "997457920"}
    }, {
        "time": "1450758725070",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "master:memory.heap.committed",
            "value": "179830784"
        }
    }, {
        "time": "1450758725070",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "master:memory.total.used", "value": "89117352"}
    }, {
        "time": "1450758725070",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "master:thread.count", "value": "28"}
    }]
}
</code></pre></div>

<h3 id="post-apiv10mastersubmitapp">POST api/v1.0/master/submitapp</h3>
<p>Submit a streaming job jar to Gearpump cluster. It functions like command line
<code>
gear app -jar xx.jar -conf yy.conf -executors 1 &lt;command line arguments&gt;
</code></p>

<p>Required MIME type: &#8220;multipart/form-data&#8221;</p>

<p>Required post form fields:</p>

<ol>
  <li>field name &#8220;jar&#8221;, job jar file.</li>
</ol>

<p>Optional post form fields:</p>

<ol>
  <li>&#8220;configfile&#8221;, configuration file, in UTF8 format.</li>
  <li>&#8220;configstring&#8221;, text body of configuration file, in UTF8 format.</li>
  <li>&#8220;executorcount&#8221;, The count of JVM process to start across the cluster for this application job</li>
  <li>&#8220;args&#8221;, command line arguments for this job jar.</li>
</ol>

<p>Example html:</p>

<div class="highlight"><pre><code class="language-bash">&lt;form <span class="nv">id</span><span class="o">=</span><span class="s2">&quot;submitapp&quot;</span> <span class="nv">action</span><span class="o">=</span><span class="s2">&quot;http://127.0.0.1:8090/api/v1.0/master/submitapp&quot;</span>
<span class="nv">method</span><span class="o">=</span><span class="s2">&quot;POST&quot;</span> <span class="nv">enctype</span><span class="o">=</span><span class="s2">&quot;multipart/form-data&quot;</span>&gt;
 
Job Jar <span class="o">(</span>*.jar<span class="o">)</span> <span class="o">[</span>Required<span class="o">]</span>:  &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;file&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;jar&quot;</span>/&gt; &lt;br/&gt; &lt;br/&gt;
 
Config file <span class="o">(</span>*.conf<span class="o">)</span> <span class="o">[</span>Optional<span class="o">]</span>:  &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;file&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;configfile&quot;</span>/&gt; &lt;br/&gt;  &lt;br/&gt;
 
Config String, Config File in string format. <span class="o">[</span>Optional<span class="o">]</span>: &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;text&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;configstring&quot;</span> <span class="nv">value</span><span class="o">=</span><span class="s2">&quot;a.b.c.d=1&quot;</span>/&gt; &lt;br/&gt;&lt;br/&gt;
 
Executor count <span class="o">(</span>integer, how many process to start <span class="k">for </span>this streaming job<span class="o">)</span> <span class="o">[</span>Optional<span class="o">]</span>: &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;text&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;executorcount&quot;</span> <span class="nv">value</span><span class="o">=</span><span class="s2">&quot;1&quot;</span>/&gt; &lt;br/&gt;&lt;br/&gt;
 
Application arguments <span class="o">(</span>String<span class="o">)</span> <span class="o">[</span>Optional<span class="o">]</span>: &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;text&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;args&quot;</span> <span class="nv">value</span><span class="o">=</span><span class="s2">&quot;&quot;</span>/&gt; &lt;br/&gt;&lt;br/&gt;
 
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;submit&quot;</span> <span class="nv">value</span><span class="o">=</span><span class="s2">&quot;Submit&quot;</span>/&gt;
 
&lt;/table&gt;
 
&lt;/form&gt;</code></pre></div>

<h3 id="post-apiv10mastersubmitstormapp">POST api/v1.0/master/submitstormapp</h3>
<p>Submit a storm jar to Gearpump cluster. It functions like command line
<code>
storm app -jar xx.jar -conf yy.yaml &lt;command line arguments&gt;
</code></p>

<p>Required MIME type: &#8220;multipart/form-data&#8221;</p>

<p>Required post form fields:</p>

<ol>
  <li>field name &#8220;jar&#8221;, job jar file.</li>
</ol>

<p>Optional post form fields:</p>

<ol>
  <li>&#8220;configfile&#8221;, .yaml configuration file, in UTF8 format.</li>
  <li>&#8220;args&#8221;, command line arguments for this job jar.</li>
</ol>

<p>Example html:</p>

<div class="highlight"><pre><code class="language-bash">&lt;form <span class="nv">id</span><span class="o">=</span><span class="s2">&quot;submitstormapp&quot;</span> <span class="nv">action</span><span class="o">=</span><span class="s2">&quot;http://127.0.0.1:8090/api/v1.0/master/submitstormapp&quot;</span>
<span class="nv">method</span><span class="o">=</span><span class="s2">&quot;POST&quot;</span> <span class="nv">enctype</span><span class="o">=</span><span class="s2">&quot;multipart/form-data&quot;</span>&gt;
 
Job Jar <span class="o">(</span>*.jar<span class="o">)</span> <span class="o">[</span>Required<span class="o">]</span>:  &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;file&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;jar&quot;</span>/&gt; &lt;br/&gt; &lt;br/&gt;
 
Config file <span class="o">(</span>*.yaml<span class="o">)</span> <span class="o">[</span>Optional<span class="o">]</span>:  &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;file&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;configfile&quot;</span>/&gt; &lt;br/&gt;  &lt;br/&gt;

Application arguments <span class="o">(</span>String<span class="o">)</span> <span class="o">[</span>Optional<span class="o">]</span>: &lt;br/&gt;
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;text&quot;</span> <span class="nv">name</span><span class="o">=</span><span class="s2">&quot;args&quot;</span> <span class="nv">value</span><span class="o">=</span><span class="s2">&quot;&quot;</span>/&gt; &lt;br/&gt;&lt;br/&gt;
 
&lt;input <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;submit&quot;</span> <span class="nv">value</span><span class="o">=</span><span class="s2">&quot;Submit&quot;</span>/&gt;
 
&lt;/table&gt;
 
&lt;/form&gt;</code></pre></div>

<h2 id="worker-service">Worker service</h2>

<h3 id="get-apiv10workerltworkeridgt">GET api/v1.0/worker/&lt;workerId&gt;</h3>
<p>Query worker information.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/worker/0</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "workerId": "0",
  "state": "active",
  "actorPath": "akka.tcp://master@127.0.0.1:3000/user/Worker1",
  "aliveFor": "831069",
  "logFile": "logs/",
  "executors": [
    {
      "appId": 1,
      "executorId": 1,
      "slots": 1
    }
  ],
  "totalSlots": 1000,
  "availableSlots": 999,
  "homeDirectory": "/usr/lisa/gearpump/",
  "jvmName": "11788@lisa"
}
</code></pre></div>

<h3 id="get-apiv10workerltworkeridgtconfig">GET api/v1.0/worker/&lt;workerId&gt;/config</h3>
<p>Query worker config</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/worker/0/config</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "extensions": [
    "akka.contrib.datareplication.DataReplication$"
  ]
  "akka": {
    "loglevel": "INFO"
    "log-dead-letters": "off"
    "log-dead-letters-during-shutdown": "off"
    "actor": {
      ## Master forms a akka cluster
      "provider": "akka.cluster.ClusterActorRefProvider"
    }
    "cluster": {
      "roles": ["master"]
      "auto-down-unreachable-after": "15s"
    }
    "remote": {
      "log-remote-lifecycle-events": "off"
    }
  }
}
</code></pre></div>

<h3 id="get-apiv10workerltworkeridgtmetricsltquerypathgtreadlatestlttruefalsegt">GET api/v1.0/worker/&lt;workerId&gt;/metrics/&lt;query_path&gt;?readLatest=&lt;true|false&gt;</h3>
<p>Get the worker node metrics.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/worker/0/metrics/worker?readLatest<span class="o">=</span><span class="nb">true</span></code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
    "path"
:
    "worker", "metrics"
:
    [{
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.total.used",
            "value": "152931440"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker1:thread.daemon.count", "value": "18"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.heap.used",
            "value": "123139640"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.total.max",
            "value": "997457920"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.heap.committed",
            "value": "179830784"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker0:thread.count", "value": "28"}
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker0:memory.heap.max", "value": "880017408"}
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker1:memory.heap.max", "value": "880017408"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.total.committed",
            "value": "210239488"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.total.used",
            "value": "152931440"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker1:thread.count", "value": "28"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.total.max",
            "value": "997457920"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.heap.committed",
            "value": "179830784"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.total.committed",
            "value": "210239488"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker0:thread.daemon.count", "value": "18"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.heap.used",
            "value": "123139640"
        }
    }]
}
</code></pre></div>

<h2 id="supervisor-service">Supervisor Service</h2>

<p>Supervisor service allows user to add or remove a worker machine.</p>

<h3 id="post-apiv10supervisorstatus">POST api/v1.0/supervisor/status</h3>
<p>Query whether the supervisor service is enabled. If Supervisor service is disabled, you are not allowed to use API like addworker/removeworker.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl -X POST <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/supervisor/status</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{"enabled":true}
</code></pre></div>

<h3 id="get-apiv10supervisor">GET api/v1.0/supervisor</h3>
<p>Get the supervisor path</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/supervisor</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{path: "supervisor actor path"}
</code></pre></div>

<h3 id="post-apiv10supervisoraddworkerltworker-countgt">POST api/v1.0/supervisor/addworker/&lt;worker-count&gt;</h3>
<p>Add workerCount new workers in the cluster. It will use the low level resource scheduler like
YARN to start new containers and then boot Gearpump worker process.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl -X POST <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/supervisor/addworker/2</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{success: true}
</code></pre></div>

<h3 id="post-apiv10supervisorremoveworkerltworker-idgt">POST api/v1.0/supervisor/removeworker/&lt;worker-id&gt;</h3>
<p>Remove single worker instance by specifying a worker Id.</p>

<p><em>*NOTE:</em> Use with caution!</p>

<p><strong>NOTE:</strong> All executors JVMs under this worker JVM will also be destroyed. It will trigger failover for all
applications that have executor started under this worker.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl -X POST <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/supervisor/removeworker/3</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{success: true}
</code></pre></div>

<h2 id="application-service">Application service</h2>

<h3 id="get-apiv10appmasterltappidgtdetaillttruefalsegt">GET api/v1.0/appmaster/&lt;appId&gt;?detail=&lt;true|false&gt;</h3>
<p>Query information of an specific application of Id appId</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/appmaster/1?detail<span class="o">=</span><span class="nb">true</span></code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "appId": 1,
  "appName": "wordCount",
  "processors": [
    [
      0,
      {
        "id": 0,
        "taskClass": "io.gearpump.streaming.examples.wordcount.Split",
        "parallelism": 1,
        "description": "",
        "taskConf": {
          "_config": {}
        },
        "life": {
          "birth": "0",
          "death": "9223372036854775807"
        },
        "executors": [
          1
        ],
        "taskCount": [
          [
            1,
            {
              "count": 1
            }
          ]
        ]
      }
    ],
    [
      1,
      {
        "id": 1,
        "taskClass": "io.gearpump.streaming.examples.wordcount.Sum",
        "parallelism": 1,
        "description": "",
        "taskConf": {
          "_config": {}
        },
        "life": {
          "birth": "0",
          "death": "9223372036854775807"
        },
        "executors": [
          0
        ],
        "taskCount": [
          [
            0,
            {
              "count": 1
            }
          ]
        ]
      }
    ]
  ],
  "processorLevels": [
    [
      0,
      0
    ],
    [
      1,
      1
    ]
  ],
  "dag": {
    "vertexList": [
      0,
      1
    ],
    "edgeList": [
      [
        0,
        "io.gearpump.partitioner.HashPartitioner",
        1
      ]
    ]
  },
  "actorPath": "akka.tcp://app1-executor-1@127.0.0.1:52212/user/daemon/appdaemon1/$c/appmaster",
  "clock": "1450759382430",
  "executors": [
    {
      "executorId": 0,
      "executor": "akka.tcp://app1system0@127.0.0.1:52240/remote/akka.tcp/app1-executor-1@127.0.0.1:52212/user/daemon/appdaemon1/$c/appmaster/executors/0#-1554950276",
      "workerId": "1",
      "status": "active"
    },
    {
      "executorId": 1,
      "executor": "akka.tcp://app1system1@127.0.0.1:52241/remote/akka.tcp/app1-executor-1@127.0.0.1:52212/user/daemon/appdaemon1/$c/appmaster/executors/1#928082134",
      "workerId": "0",
      "status": "active"
    },
    {
      "executorId": -1,
      "executor": "akka://app1-executor-1/user/daemon/appdaemon1/$c/appmaster",
      "workerId": "1",
      "status": "active"
    }
  ],
  "startTime": "1450758117306",
  "uptime": "1268472",
  "user": "lisa",
  "homeDirectory": "/usr/lisa/gearpump/",
  "logFile": "logs/",
  "historyMetricsConfig": {
    "retainHistoryDataHours": 72,
    "retainHistoryDataIntervalMs": 3600000,
    "retainRecentDataSeconds": 300,
    "retainRecentDataIntervalMs": 15000
  }
}
</code></pre></div>

<h3 id="delete-apiv10appmasterltappidgt">DELETE api/v1.0/appmaster/&lt;appId&gt;</h3>
<p>shutdown application appId</p>

<h3 id="get-apiv10appmasterltappidgtstallingtasks">GET api/v1.0/appmaster/&lt;appId&gt;/stallingtasks</h3>
<p>Query list of unhealthy tasks of an specific application of Id appId</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/appmaster/2/stallingtasks</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "tasks": [
    {
      "processorId": 0,
      "index": 0
    }
  ]
}
</code></pre></div>

<h3 id="get-apiv10appmasterltappidgtconfig">GET api/v1.0/appmaster/&lt;appId&gt;/config</h3>
<p>Query the configuration of specific application appId</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/appmaster/1/config</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
    "gearpump" : {
        "appmaster" : {
            "extraClasspath" : "",
            "vmargs" : "-server -Xms512M -Xmx1024M -Xss1M -XX:+HeapDumpOnOutOfMemoryError -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=80 -XX:+UseParNewGC -XX:NewRatio=3"
        },
        "cluster" : {
            "masters" : [
                "127.0.0.1:3000"
            ]
        },
        "executor" : {
            "extraClasspath" : "",
            "vmargs" : "-server -Xms512M -Xmx1024M -Xss1M -XX:+HeapDumpOnOutOfMemoryError -XX:+UseConcMarkSweepGC -XX:CMSInitiatingOccupancyFraction=80 -XX:+UseParNewGC -XX:NewRatio=3"
        },
        "jarstore" : {
            "rootpath" : "jarstore/"
        },
        "log" : {
            "application" : {
                "dir" : "logs"
            },
            "daemon" : {
                "dir" : "logs"
            }
        },
        "metrics" : {
            "enabled" : true,
            "graphite" : {
                "host" : "127.0.0.1",
                "port" : 2003
            },
            "logfile" : {},
            "report-interval-ms" : 15000,
            "reporter" : "akka",
            "retainHistoryData" : {
                "hours" : 72,
                "intervalMs" : 3600000
            },
            "retainRecentData" : {
                "intervalMs" : 15000,
                "seconds" : 300
            },
            "sample-rate" : 10
        },
        "netty" : {
            "base-sleep-ms" : 100,
            "buffer-size" : 5242880,
            "flush-check-interval" : 10,
            "max-retries" : 30,
            "max-sleep-ms" : 1000,
            "message-batch-size" : 262144
        },
        "netty-dispatcher" : "akka.actor.default-dispatcher",
        "scheduling" : {
            "scheduler-class" : "io.gearpump.cluster.scheduler.PriorityScheduler"
        },
        "serializers" : {
            "[B" : "",
            "[C" : "",
            "[D" : "",
            "[F" : "",
            "[I" : "",
            "[J" : "",
            "[Ljava.lang.String;" : "",
            "[S" : "",
            "[Z" : "",
            "io.gearpump.Message" : "io.gearpump.streaming.MessageSerializer",
            "io.gearpump.streaming.task.Ack" : "io.gearpump.streaming.AckSerializer",
            "io.gearpump.streaming.task.AckRequest" : "io.gearpump.streaming.AckRequestSerializer",
            "io.gearpump.streaming.task.LatencyProbe" : "io.gearpump.streaming.LatencyProbeSerializer",
            "io.gearpump.streaming.task.TaskId" : "io.gearpump.streaming.TaskIdSerializer",
            "scala.Tuple1" : "",
            "scala.Tuple2" : "",
            "scala.Tuple3" : "",
            "scala.Tuple4" : "",
            "scala.Tuple5" : "",
            "scala.Tuple6" : "",
            "scala.collection.immutable.$colon$colon" : "",
            "scala.collection.immutable.List" : ""
        },
        "services" : {
            # gear.conf: 112
            "host" : "127.0.0.1",
            # gear.conf: 113
            "http" : 8090,
            # gear.conf: 114
            "ws" : 8091
        },
        "task-dispatcher" : "akka.actor.pined-dispatcher",
        "worker" : {
            # reference.conf: 100
            # # How many slots each worker contains
            "slots" : 100
        }
    }
}

</code></pre></div>

<h3 id="get-apiv10appmasterltappidgtmetricsltquerypathgtreadlatestlttruefalsegtaggregatorltaggregatorclassgt">GET api/v1.0/appmaster/&lt;appId&gt;/metrics/&lt;query_path&gt;?readLatest=&lt;true|false&gt;&amp;aggregator=&lt;aggregator_class&gt;</h3>
<p>Query metrics information of a specific application appId
Filter metrics with path metrics path</p>

<p>aggregator points to a aggregator class, which will aggregate on the current metrics, and return a smaller set.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/appmaster/1/metrics/app1?readLatest<span class="o">=</span><span class="nb">true</span>&amp;aggregator<span class="o">=</span>io.gearpump.streaming.metrics.ProcessorAggregator</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
    "path"
:
    "worker", "metrics"
:
    [{
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.total.used",
            "value": "152931440"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker1:thread.daemon.count", "value": "18"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.heap.used",
            "value": "123139640"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.total.max",
            "value": "997457920"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.heap.committed",
            "value": "179830784"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker0:thread.count", "value": "28"}
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker0:memory.heap.max", "value": "880017408"}
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker1:memory.heap.max", "value": "880017408"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.total.committed",
            "value": "210239488"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker0:memory.total.used",
            "value": "152931440"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker1:thread.count", "value": "28"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.total.max",
            "value": "997457920"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.heap.committed",
            "value": "179830784"
        }
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.total.committed",
            "value": "210239488"
        }
    }, {
        "time": "1450759137860",
        "value": {"$type": "io.gearpump.metrics.Metrics.Gauge", "name": "worker0:thread.daemon.count", "value": "18"}
    }, {
        "time": "1450759137860",
        "value": {
            "$type": "io.gearpump.metrics.Metrics.Gauge",
            "name": "worker1:memory.heap.used",
            "value": "123139640"
        }
    }]
}
</code></pre></div>

<h3 id="get-apiv10appmasterltappidgterrors">GET api/v1.0/appmaster/&lt;appId&gt;/errors</h3>
<p>Get task error messages</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/appmaster/1/errors</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{"time":"0","error":null}
</code></pre></div>

<h3 id="post-apiv10appmasterltappidgtrestart">POST api/v1.0/appmaster/&lt;appId&gt;/restart</h3>
<p>Restart the application</p>

<h2 id="executor-service">Executor Service</h2>

<h3 id="get-apiv10appmasterltappidgtexecutorltexecutoridgtconfig">GET api/v1.0/appmaster/&lt;appId&gt;/executor/&lt;executorid&gt;/config</h3>
<p>Get executor config</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl http://127.0.0.1:8090/api/v1.0/appmaster/1/executor/1/config</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "extensions": [
    "akka.contrib.datareplication.DataReplication$"
  ]
  "akka": {
    "loglevel": "INFO"
    "log-dead-letters": "off"
    "log-dead-letters-during-shutdown": "off"
    "actor": {
      ## Master forms a akka cluster
      "provider": "akka.cluster.ClusterActorRefProvider"
    }
    "cluster": {
      "roles": ["master"]
      "auto-down-unreachable-after": "15s"
    }
    "remote": {
      "log-remote-lifecycle-events": "off"
    }
  }
}
</code></pre></div>

<h3 id="get-apiv10appmasterltappidgtexecutorltexecutoridgt">GET api/v1.0/appmaster/&lt;appId&gt;/executor/&lt;executorid&gt;</h3>
<p>Get executor information.</p>

<p>Example:</p>

<div class="highlight"><pre><code class="language-bash">curl <span class="o">[</span>--cookie outputAuthenticationCookie.txt<span class="o">]</span> http://127.0.0.1:8090/api/v1.0/appmaster/1/executor/1</code></pre></div>

<p>Sample Response:</p>

<div class="highlight"><pre><code>{
  "id": 1,
  "workerId": "0",
  "actorPath": "akka.tcp://app1system1@127.0.0.1:52241/remote/akka.tcp/app1-executor-1@127.0.0.1:52212/user/daemon/appdaemon1/$c/appmaster/executors/1",
  "logFile": "logs/",
  "status": "active",
  "taskCount": 1,
  "tasks": [
    [
      0,
      [
        {
          "processorId": 0,
          "index": 0
        }
      ]
    ]
  ],
  "jvmName": "21304@lisa"
}
</code></pre></div>


  </div> <!-- /container -->

  <script src="js/vendor/jquery-2.1.4.min.js"></script>
  <script src="js/vendor/bootstrap-3.3.5.min.js"></script>
  <script src="js/vendor/anchor-1.1.1.min.js"></script>
  <script src="js/main.js"></script>

  <!-- MathJax Section -->
  <script type="text/x-mathjax-config">
    MathJax.Hub.Config({
      TeX: { equationNumbers: { autoNumber: "AMS" } }
    });
  </script>
  <script>
    // Note that we load MathJax this way to work with local file (file://), HTTP and HTTPS.
    // We could use "//cdn.mathjax...", but that won't support "file://".
    (function(d, script) {
      script = d.createElement('script');
      script.type = 'text/javascript';
      script.async = true;
      script.onload = function(){
        MathJax.Hub.Config({
          tex2jax: {
            inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ],
            displayMath: [ ["$$","$$"], ["\\[", "\\]"] ],
            processEscapes: true,
            skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
          }
        });
      };
      script.src = ('https:' == document.location.protocol ? 'https://' : 'http://') +
        'cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML';
      d.getElementsByTagName('head')[0].appendChild(script);
    }(document));
  </script>
</body>
</html>