You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by li...@apache.org on 2016/03/29 05:31:43 UTC
svn commit: r1736941 - in /kylin/site: docs/howto/howto_use_restapi.html
docs15/howto/howto_use_restapi.html feed.xml
Author: lidong
Date: Tue Mar 29 03:31:43 2016
New Revision: 1736941
URL: http://svn.apache.org/viewvc?rev=1736941&view=rev
Log:
Update RestAPI about get job status
Modified:
kylin/site/docs/howto/howto_use_restapi.html
kylin/site/docs15/howto/howto_use_restapi.html
kylin/site/feed.xml
Modified: kylin/site/docs/howto/howto_use_restapi.html
URL: http://svn.apache.org/viewvc/kylin/site/docs/howto/howto_use_restapi.html?rev=1736941&r1=1736940&r2=1736941&view=diff
==============================================================================
--- kylin/site/docs/howto/howto_use_restapi.html (original)
+++ kylin/site/docs/howto/howto_use_restapi.html Tue Mar 29 03:31:43 2016
@@ -2001,6 +2001,7 @@
<ul>
<li><a href="#resume-job">Resume job</a></li>
<li><a href="#discard-job">Discard job</a></li>
+ <li><a href="#get-job-status">Get job status</a></li>
<li><a href="#get-job-step-output">Get job step output</a></li>
</ul>
</li>
@@ -2864,16 +2865,27 @@ Get descriptor for specified cube instan
<h4 id="response-sample-11">Response Sample</h4>
<p>(Same as âResume jobâ)</p>
+<h2 id="get-job-status">Get Job Status</h2>
+<p><code class="highlighter-rouge">GET /jobs/{jobId}</code></p>
+
+<h4 id="path-variable-9">Path variable</h4>
+<ul>
+ <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li>
+</ul>
+
+<h4 id="response-sample-12">Response Sample</h4>
+<p>(Same as âResume Jobâ)</p>
+
<h2 id="get-job-step-output">Get job step output</h2>
<p><code class="highlighter-rouge">GET /{jobId}/steps/{stepId}/output</code></p>
-<h4 id="path-variable-9">Path Variable</h4>
+<h4 id="path-variable-10">Path Variable</h4>
<ul>
<li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li>
<li>stepId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Step id; the step id is composed by jobId with step sequence id; for example, the jobId is âfb479e54-837f-49a2-b457-651fc50be110â, its 3rd step id is âfb479e54-837f-49a2-b457-651fc50be110-3â,</li>
</ul>
-<h4 id="response-sample-12">Response Sample</h4>
+<h4 id="response-sample-13">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"cmd_output"</span><span class="p">:</span><span class="s2">"log string"</span><span class="w">
</span><span class="p">}</span><span class="w">
@@ -2890,7 +2902,7 @@ Get descriptor for specified cube instan
<li>tableName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> table name to find.</li>
</ul>
-<h4 id="response-sample-13">Response Sample</h4>
+<h4 id="response-sample-14">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span>
uuid: <span class="s2">"69cc92c0-fc42-4bb9-893f-bd1141c91dbe"</span>,
name: <span class="s2">"SAMPLE_07"</span>,
@@ -2925,7 +2937,7 @@ Get descriptor for specified cube instan
<li>tableName - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">string</code> table name to find.</li>
</ul>
-<h4 id="response-sample-14">Response Sample</h4>
+<h4 id="response-sample-15">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"minFileSize"</span><span class="p">:</span><span class="w"> </span><span class="s2">"46055"</span><span class="p">,</span><span class="w">
</span><span class="nt">"totalNumberFiles"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="p">,</span><span class="w">
@@ -2955,7 +2967,7 @@ Get descriptor for specified cube instan
<li>ext- <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">boolean</code> set true to get extend info of table.</li>
</ul>
-<h4 id="response-sample-15">Response Sample</h4>
+<h4 id="response-sample-16">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="o">[</span>
<span class="o">{</span>
uuid: <span class="s2">"53856c96-fe4d-459e-a9dc-c339b1bc3310"</span>,
@@ -3011,7 +3023,7 @@ Get descriptor for specified cube instan
<li>project - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">String</code> the project which the tables will be loaded into.</li>
</ul>
-<h4 id="response-sample-16">Response Sample</h4>
+<h4 id="response-sample-17">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"result.loaded"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"DEFAULT.SAMPLE_07"</span><span class="p">],</span><span class="w">
</span><span class="nt">"result.unloaded"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"sapmle_08"</span><span class="p">]</span><span class="w">
@@ -3024,7 +3036,7 @@ Get descriptor for specified cube instan
<h2 id="wipe-cache">Wipe cache</h2>
<p><code class="highlighter-rouge">PUT /cache/{type}/{name}/{action}</code></p>
-<h4 id="path-variable-10">Path variable</h4>
+<h4 id="path-variable-11">Path variable</h4>
<ul>
<li>type - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> âMETADATAâ or âCUBEâ</li>
<li>name - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cache key, e.g the cube name.</li>
Modified: kylin/site/docs15/howto/howto_use_restapi.html
URL: http://svn.apache.org/viewvc/kylin/site/docs15/howto/howto_use_restapi.html?rev=1736941&r1=1736940&r2=1736941&view=diff
==============================================================================
--- kylin/site/docs15/howto/howto_use_restapi.html (original)
+++ kylin/site/docs15/howto/howto_use_restapi.html Tue Mar 29 03:31:43 2016
@@ -1678,6 +1678,7 @@
<ul>
<li><a href="#resume-job">Resume job</a></li>
<li><a href="#discard-job">Discard job</a></li>
+ <li><a href="#get-job-status">Get job status</a></li>
<li><a href="#get-job-step-output">Get job step output</a></li>
</ul>
</li>
@@ -2541,16 +2542,27 @@ Get descriptor for specified cube instan
<h4 id="response-sample-11">Response Sample</h4>
<p>(Same as âResume jobâ)</p>
+<h2 id="get-job-status">Get Job Status</h2>
+<p><code class="highlighter-rouge">GET /jobs/{jobId}</code></p>
+
+<h4 id="path-variable-9">Path variable</h4>
+<ul>
+ <li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li>
+</ul>
+
+<h4 id="response-sample-12">Response Sample</h4>
+<p>(Same as âResume Jobâ)</p>
+
<h2 id="get-job-step-output">Get job step output</h2>
<p><code class="highlighter-rouge">GET /{jobId}/steps/{stepId}/output</code></p>
-<h4 id="path-variable-9">Path Variable</h4>
+<h4 id="path-variable-10">Path Variable</h4>
<ul>
<li>jobId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Job id.</li>
<li>stepId - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Step id; the step id is composed by jobId with step sequence id; for example, the jobId is âfb479e54-837f-49a2-b457-651fc50be110â, its 3rd step id is âfb479e54-837f-49a2-b457-651fc50be110-3â,</li>
</ul>
-<h4 id="response-sample-12">Response Sample</h4>
+<h4 id="response-sample-13">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"cmd_output"</span><span class="p">:</span><span class="s2">"log string"</span><span class="w">
</span><span class="p">}</span><span class="w">
@@ -2567,7 +2579,7 @@ Get descriptor for specified cube instan
<li>tableName - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> table name to find.</li>
</ul>
-<h4 id="response-sample-13">Response Sample</h4>
+<h4 id="response-sample-14">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="o">{</span>
uuid: <span class="s2">"69cc92c0-fc42-4bb9-893f-bd1141c91dbe"</span>,
name: <span class="s2">"SAMPLE_07"</span>,
@@ -2602,7 +2614,7 @@ Get descriptor for specified cube instan
<li>tableName - <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">string</code> table name to find.</li>
</ul>
-<h4 id="response-sample-14">Response Sample</h4>
+<h4 id="response-sample-15">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"minFileSize"</span><span class="p">:</span><span class="w"> </span><span class="s2">"46055"</span><span class="p">,</span><span class="w">
</span><span class="nt">"totalNumberFiles"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1"</span><span class="p">,</span><span class="w">
@@ -2632,7 +2644,7 @@ Get descriptor for specified cube instan
<li>ext- <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">boolean</code> set true to get extend info of table.</li>
</ul>
-<h4 id="response-sample-15">Response Sample</h4>
+<h4 id="response-sample-16">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="o">[</span>
<span class="o">{</span>
uuid: <span class="s2">"53856c96-fe4d-459e-a9dc-c339b1bc3310"</span>,
@@ -2688,7 +2700,7 @@ Get descriptor for specified cube instan
<li>project - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">String</code> the project which the tables will be loaded into.</li>
</ul>
-<h4 id="response-sample-16">Response Sample</h4>
+<h4 id="response-sample-17">Response Sample</h4>
<div class="highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nt">"result.loaded"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"DEFAULT.SAMPLE_07"</span><span class="p">],</span><span class="w">
</span><span class="nt">"result.unloaded"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"sapmle_08"</span><span class="p">]</span><span class="w">
@@ -2701,7 +2713,7 @@ Get descriptor for specified cube instan
<h2 id="wipe-cache">Wipe cache</h2>
<p><code class="highlighter-rouge">PUT /cache/{type}/{name}/{action}</code></p>
-<h4 id="path-variable-10">Path variable</h4>
+<h4 id="path-variable-11">Path variable</h4>
<ul>
<li>type - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> âMETADATAâ or âCUBEâ</li>
<li>name - <code class="highlighter-rouge">required</code> <code class="highlighter-rouge">string</code> Cache key, e.g the cube name.</li>
Modified: kylin/site/feed.xml
URL: http://svn.apache.org/viewvc/kylin/site/feed.xml?rev=1736941&r1=1736940&r2=1736941&view=diff
==============================================================================
--- kylin/site/feed.xml (original)
+++ kylin/site/feed.xml Tue Mar 29 03:31:43 2016
@@ -19,8 +19,8 @@
<description>Apache Kylin Home</description>
<link>http://kylin.apache.org/</link>
<atom:link href="http://kylin.apache.org/feed.xml" rel="self" type="application/rss+xml"/>
- <pubDate>Thu, 24 Mar 2016 11:16:29 -0700</pubDate>
- <lastBuildDate>Thu, 24 Mar 2016 11:16:29 -0700</lastBuildDate>
+ <pubDate>Tue, 29 Mar 2016 04:30:13 -0700</pubDate>
+ <lastBuildDate>Tue, 29 Mar 2016 04:30:13 -0700</lastBuildDate>
<generator>Jekyll v2.5.3</generator>
<item>