kylin-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From lid...@apache.org
Subject svn commit: r1827471 - in /kylin/site: docs21/howto/howto_use_restapi.html docs23/howto/howto_use_restapi.html feed.xml
Date Thu, 22 Mar 2018 08:54:36 GMT
Author: lidong
Date: Thu Mar 22 08:54:36 2018
New Revision: 1827471

URL: http://svn.apache.org/viewvc?rev=1827471&view=rev
Log:
update doc for rest api

Modified:
    kylin/site/docs21/howto/howto_use_restapi.html
    kylin/site/docs23/howto/howto_use_restapi.html
    kylin/site/feed.xml

Modified: kylin/site/docs21/howto/howto_use_restapi.html
URL: http://svn.apache.org/viewvc/kylin/site/docs21/howto/howto_use_restapi.html?rev=1827471&r1=1827470&r2=1827471&view=diff
==============================================================================
--- kylin/site/docs21/howto/howto_use_restapi.html (original)
+++ kylin/site/docs21/howto/howto_use_restapi.html Thu Mar 22 08:54:36 2018
@@ -4992,16 +4992,20 @@ Get descriptor for specified cube instan
 <h2 id="get-job-list">Get job list</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/jobs</code></p>
 
-<h4 id="path-variable-12">Path Variable</h4>
+<h4 id="request-variables">Request Variables</h4>
 <ul>
-  <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name.</li>
+  <li>cubeName - <code class="highlighter-rouge">optional</code> <code
class="highlighter-rouge">string</code> Cube name.</li>
   <li>projectName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Project name.</li>
-  <li>status - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code> Job status, e.g. (NEW: 0, PENDING: 1, RUNNING:
2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)</li>
+  <li>status - <code class="highlighter-rouge">optional</code> <code
class="highlighter-rouge">int</code> Job status, e.g. (NEW: 0, PENDING: 1, RUNNING:
2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)</li>
   <li>offset - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code> Offset used by pagination.</li>
   <li>limit - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code> Jobs per page.</li>
   <li>timeFilter - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code>, e.g. (LAST ONE DAY: 0, LAST ONE WEEK: 1, LAST
ONE MONTH: 2, LAST ONE YEAR: 3, ALL: 4)</li>
 </ul>
 
+<p>For example, to get the job list in project ‘learn_kylin’ for cube ‘kylin_sales_cube’
in lastone week:</p>
+
+<p><code class="highlighter-rouge">GET: /kylin/api/jobs?cubeName=kylin_sales_cube&amp;limit=15&amp;offset=0&amp;projectName=learn_kylin&amp;timeFilter=1</code></p>
+
 <h4 id="response-sample-13">Response Sample</h4>
 <div class="highlighter-rouge"><pre class="highlight"><code>[
   { 
@@ -5060,7 +5064,7 @@ Get descriptor for specified cube instan
 <h2 id="get-hive-table">Get Hive Table</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/tables/{project}/{tableName}</code></p>
 
-<h4 id="request-parameters-2">Request Parameters</h4>
+<h4 id="path-parameters">Path Parameters</h4>
 <ul>
   <li>project - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> project name</li>
   <li>tableName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> table name to find.</li>
@@ -5096,7 +5100,7 @@ Get descriptor for specified cube instan
 <h2 id="get-hive-tables">Get Hive Tables</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/tables</code></p>
 
-<h4 id="request-parameters-3">Request Parameters</h4>
+<h4 id="request-parameters-2">Request Parameters</h4>
 <ul>
   <li>project- <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> will list all tables in the project.</li>
   <li>ext- <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">boolean</code>
 set true to get extend info of table.</li>
@@ -5152,7 +5156,7 @@ Get descriptor for specified cube instan
 <h2 id="load-hive-tables">Load Hive Tables</h2>
 <p><code class="highlighter-rouge">POST /kylin/api/tables/{tables}/{project}</code></p>
 
-<h4 id="request-parameters-4">Request Parameters</h4>
+<h4 id="request-parameters-3">Request Parameters</h4>
 <ul>
   <li>tables - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> table names you want to load from hive, separated
with comma.</li>
   <li>project - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">String</code>  the project which the tables will be loaded
into.</li>
@@ -5171,7 +5175,7 @@ Get descriptor for specified cube instan
 <h2 id="wipe-cache">Wipe cache</h2>
 <p><code class="highlighter-rouge">PUT /kylin/api/cache/{type}/{name}/{action}</code></p>
 
-<h4 id="path-variable-13">Path variable</h4>
+<h4 id="path-variable-12">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>
@@ -5185,7 +5189,7 @@ Get descriptor for specified cube instan
 
 <p><code class="highlighter-rouge">PUT /kylin/api/cubes/{cubeName}/init_start_offsets</code></p>
 
-<h4 id="path-variable-14">Path variable</h4>
+<h4 id="path-variable-13">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>
@@ -5203,7 +5207,7 @@ Get descriptor for specified cube instan
 
 <p>This API is specific for stream cube’s building;</p>
 
-<h4 id="path-variable-15">Path variable</h4>
+<h4 id="path-variable-14">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>
@@ -5247,7 +5251,7 @@ Get descriptor for specified cube instan
 <h2 id="check-segment-holes">Check segment holes</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/cubes/{cubeName}/holes</code></p>
 
-<h4 id="path-variable-16">Path variable</h4>
+<h4 id="path-variable-15">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>
@@ -5255,7 +5259,7 @@ Get descriptor for specified cube instan
 <h2 id="fill-segment-holes">Fill segment holes</h2>
 <p><code class="highlighter-rouge">PUT /kylin/api/cubes/{cubeName}/holes</code></p>
 
-<h4 id="path-variable-17">Path variable</h4>
+<h4 id="path-variable-16">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>

Modified: kylin/site/docs23/howto/howto_use_restapi.html
URL: http://svn.apache.org/viewvc/kylin/site/docs23/howto/howto_use_restapi.html?rev=1827471&r1=1827470&r2=1827471&view=diff
==============================================================================
--- kylin/site/docs23/howto/howto_use_restapi.html (original)
+++ kylin/site/docs23/howto/howto_use_restapi.html Thu Mar 22 08:54:36 2018
@@ -5172,16 +5172,20 @@ Get descriptor for specified cube instan
 <h2 id="get-job-list">Get job list</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/jobs</code></p>
 
-<h4 id="path-variable-12">Path Variable</h4>
+<h4 id="request-variables">Request Variables</h4>
 <ul>
-  <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name.</li>
+  <li>cubeName - <code class="highlighter-rouge">optional</code> <code
class="highlighter-rouge">string</code> Cube name.</li>
   <li>projectName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Project name.</li>
-  <li>status - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code> Job status, e.g. (NEW: 0, PENDING: 1, RUNNING:
2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)</li>
+  <li>status - <code class="highlighter-rouge">optional</code> <code
class="highlighter-rouge">int</code> Job status, e.g. (NEW: 0, PENDING: 1, RUNNING:
2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)</li>
   <li>offset - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code> Offset used by pagination.</li>
   <li>limit - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code> Jobs per page.</li>
   <li>timeFilter - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">int</code>, e.g. (LAST ONE DAY: 0, LAST ONE WEEK: 1, LAST
ONE MONTH: 2, LAST ONE YEAR: 3, ALL: 4)</li>
 </ul>
 
+<p>For example, to get the job list in project ‘learn_kylin’ for cube ‘kylin_sales_cube’
in lastone week:</p>
+
+<p><code class="highlighter-rouge">GET: /kylin/api/jobs?cubeName=kylin_sales_cube&amp;limit=15&amp;offset=0&amp;projectName=learn_kylin&amp;timeFilter=1</code></p>
+
 <h4 id="response-sample-13">Response Sample</h4>
 <div class="highlighter-rouge"><pre class="highlight"><code>[
   { 
@@ -5240,7 +5244,7 @@ Get descriptor for specified cube instan
 <h2 id="get-hive-table">Get Hive Table</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/tables/{project}/{tableName}</code></p>
 
-<h4 id="request-parameters-2">Request Parameters</h4>
+<h4 id="path-parameters">Path Parameters</h4>
 <ul>
   <li>project - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> project name</li>
   <li>tableName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> table name to find.</li>
@@ -5276,7 +5280,7 @@ Get descriptor for specified cube instan
 <h2 id="get-hive-tables">Get Hive Tables</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/tables</code></p>
 
-<h4 id="request-parameters-3">Request Parameters</h4>
+<h4 id="request-parameters-2">Request Parameters</h4>
 <ul>
   <li>project- <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> will list all tables in the project.</li>
   <li>ext- <code class="highlighter-rouge">optional</code> <code class="highlighter-rouge">boolean</code>
 set true to get extend info of table.</li>
@@ -5332,7 +5336,7 @@ Get descriptor for specified cube instan
 <h2 id="load-hive-tables">Load Hive Tables</h2>
 <p><code class="highlighter-rouge">POST /kylin/api/tables/{tables}/{project}</code></p>
 
-<h4 id="request-parameters-4">Request Parameters</h4>
+<h4 id="request-parameters-3">Request Parameters</h4>
 <ul>
   <li>tables - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> table names you want to load from hive, separated
with comma.</li>
   <li>project - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">String</code>  the project which the tables will be loaded
into.</li>
@@ -5351,7 +5355,7 @@ Get descriptor for specified cube instan
 <h2 id="wipe-cache">Wipe cache</h2>
 <p><code class="highlighter-rouge">PUT /kylin/api/cache/{type}/{name}/{action}</code></p>
 
-<h4 id="path-variable-13">Path variable</h4>
+<h4 id="path-variable-12">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>
@@ -5365,7 +5369,7 @@ Get descriptor for specified cube instan
 
 <p><code class="highlighter-rouge">PUT /kylin/api/cubes/{cubeName}/init_start_offsets</code></p>
 
-<h4 id="path-variable-14">Path variable</h4>
+<h4 id="path-variable-13">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>
@@ -5383,7 +5387,7 @@ Get descriptor for specified cube instan
 
 <p>This API is specific for stream cube’s building;</p>
 
-<h4 id="path-variable-15">Path variable</h4>
+<h4 id="path-variable-14">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>
@@ -5427,7 +5431,7 @@ Get descriptor for specified cube instan
 <h2 id="check-segment-holes">Check segment holes</h2>
 <p><code class="highlighter-rouge">GET /kylin/api/cubes/{cubeName}/holes</code></p>
 
-<h4 id="path-variable-16">Path variable</h4>
+<h4 id="path-variable-15">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>
@@ -5435,7 +5439,7 @@ Get descriptor for specified cube instan
 <h2 id="fill-segment-holes">Fill segment holes</h2>
 <p><code class="highlighter-rouge">PUT /kylin/api/cubes/{cubeName}/holes</code></p>
 
-<h4 id="path-variable-17">Path variable</h4>
+<h4 id="path-variable-16">Path variable</h4>
 <ul>
   <li>cubeName - <code class="highlighter-rouge">required</code> <code
class="highlighter-rouge">string</code> Cube name</li>
 </ul>

Modified: kylin/site/feed.xml
URL: http://svn.apache.org/viewvc/kylin/site/feed.xml?rev=1827471&r1=1827470&r2=1827471&view=diff
==============================================================================
--- kylin/site/feed.xml (original)
+++ kylin/site/feed.xml Thu Mar 22 08:54:36 2018
@@ -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, 15 Mar 2018 01:11:27 -0700</pubDate>
-    <lastBuildDate>Thu, 15 Mar 2018 01:11:27 -0700</lastBuildDate>
+    <pubDate>Thu, 22 Mar 2018 01:51:49 -0700</pubDate>
+    <lastBuildDate>Thu, 22 Mar 2018 01:51:49 -0700</lastBuildDate>
     <generator>Jekyll v2.5.3</generator>
     
       <item>



Mime
View raw message