You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by sh...@apache.org on 2018/03/22 08:49:38 UTC
[kylin] branch document updated: update doc for rest api
This is an automated email from the ASF dual-hosted git repository.
shaofengshi pushed a commit to branch document
in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/document by this push:
new 9a3d849 update doc for rest api
9a3d849 is described below
commit 9a3d8493275f3ea4d99755ba12c627fab9853928
Author: shaofengshi <sh...@apache.org>
AuthorDate: Thu Mar 22 16:49:17 2018 +0800
update doc for rest api
---
website/_docs21/howto/howto_use_restapi.md | 12 ++++++++----
website/_docs23/howto/howto_use_restapi.md | 13 +++++++++----
2 files changed, 17 insertions(+), 8 deletions(-)
diff --git a/website/_docs21/howto/howto_use_restapi.md b/website/_docs21/howto/howto_use_restapi.md
index 1170d13..4915d10 100644
--- a/website/_docs21/howto/howto_use_restapi.md
+++ b/website/_docs21/howto/howto_use_restapi.md
@@ -907,14 +907,18 @@ curl -X PUT -H "Authorization: Basic XXXXXXXXX" -H 'Content-Type: application/js
## Get job list
`GET /kylin/api/jobs`
-#### Path Variable
-* cubeName - `required` `string` Cube name.
+#### Request Variables
+* cubeName - `optional` `string` Cube name.
* projectName - `required` `string` Project name.
-* status - `required` `int` Job status, e.g. (NEW: 0, PENDING: 1, RUNNING: 2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)
+* status - `optional` `int` Job status, e.g. (NEW: 0, PENDING: 1, RUNNING: 2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)
* offset - `required` `int` Offset used by pagination.
* limit - `required` `int` Jobs per page.
* timeFilter - `required` `int`, e.g. (LAST ONE DAY: 0, LAST ONE WEEK: 1, LAST ONE MONTH: 2, LAST ONE YEAR: 3, ALL: 4)
+For example, to get the job list in project 'learn_kylin' for cube 'kylin_sales_cube' in lastone week:
+
+`GET: /kylin/api/jobs?cubeName=kylin_sales_cube&limit=15&offset=0&projectName=learn_kylin&timeFilter=1`
+
#### Response Sample
```
[
@@ -973,7 +977,7 @@ curl -X PUT -H "Authorization: Basic XXXXXXXXX" -H 'Content-Type: application/js
## Get Hive Table
`GET /kylin/api/tables/{project}/{tableName}`
-#### Request Parameters
+#### Path Parameters
* project - `required` `string` project name
* tableName - `required` `string` table name to find.
diff --git a/website/_docs23/howto/howto_use_restapi.md b/website/_docs23/howto/howto_use_restapi.md
index 23b03c1..f40c1f3 100644
--- a/website/_docs23/howto/howto_use_restapi.md
+++ b/website/_docs23/howto/howto_use_restapi.md
@@ -907,14 +907,19 @@ curl -X PUT -H "Authorization: Basic XXXXXXXXX" -H 'Content-Type: application/js
## Get job list
`GET /kylin/api/jobs`
-#### Path Variable
-* cubeName - `required` `string` Cube name.
+#### Request Variables
+* cubeName - `optional` `string` Cube name.
* projectName - `required` `string` Project name.
-* status - `required` `int` Job status, e.g. (NEW: 0, PENDING: 1, RUNNING: 2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)
+* status - `optional` `int` Job status, e.g. (NEW: 0, PENDING: 1, RUNNING: 2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16)
* offset - `required` `int` Offset used by pagination.
* limit - `required` `int` Jobs per page.
* timeFilter - `required` `int`, e.g. (LAST ONE DAY: 0, LAST ONE WEEK: 1, LAST ONE MONTH: 2, LAST ONE YEAR: 3, ALL: 4)
+For example, to get the job list in project 'learn_kylin' for cube 'kylin_sales_cube' in lastone week:
+
+`GET: /kylin/api/jobs?cubeName=kylin_sales_cube&limit=15&offset=0&projectName=learn_kylin&timeFilter=1`
+
+
#### Response Sample
```
[
@@ -973,7 +978,7 @@ curl -X PUT -H "Authorization: Basic XXXXXXXXX" -H 'Content-Type: application/js
## Get Hive Table
`GET /kylin/api/tables/{project}/{tableName}`
-#### Request Parameters
+#### Path Parameters
* project - `required` `string` project name
* tableName - `required` `string` table name to find.
--
To stop receiving notification emails like this one, please contact
shaofengshi@apache.org.