You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by xx...@apache.org on 2022/09/09 08:21:38 UTC
[kylin] branch doc5.0 updated: KYLIN-5260 add doc for REST API (#1976)
This is an automated email from the ASF dual-hosted git repository.
xxyu pushed a commit to branch doc5.0
in repository https://gitbox.apache.org/repos/asf/kylin.git
The following commit(s) were added to refs/heads/doc5.0 by this push:
new 4f2e1fa66d KYLIN-5260 add doc for REST API (#1976)
4f2e1fa66d is described below
commit 4f2e1fa66d52b78111f30531c8d2aabfebb769f4
Author: Tengting Xu <34...@users.noreply.github.com>
AuthorDate: Fri Sep 9 16:21:33 2022 +0800
KYLIN-5260 add doc for REST API (#1976)
* KYLIN-5260 add doc for REST API
* KYLIN-5260 add doc for REST API
---
.../docs/modeling/model_design/data_modeling.md | 66 --
website/docs/restapi/acl_api/acl_api.md | 6 +-
website/docs/restapi/acl_api/intro.md | 1 -
website/docs/restapi/acl_api/project_acl_api.md | 16 +-
website/docs/restapi/acl_api/user_api.md | 26 +-
website/docs/restapi/acl_api/user_group_api.md | 20 +-
website/docs/restapi/data_source_api.md | 14 +-
website/docs/restapi/job_api.md | 3 -
website/docs/restapi/model_api/intro.md | 2 -
website/docs/restapi/model_api/model_build_api.md | 2 +-
.../model_api/model_import_and_export_api.md | 8 +-
.../docs/restapi/model_api/model_management_api.md | 712 +--------------------
.../model_api/model_multilevel_partitioning_api.md | 2 +-
website/docs/restapi/project_api.md | 190 +-----
website/docs/restapi/query_api.md | 6 +-
website/docs/restapi/segment_management_api.md | 12 +-
website/docs/restapi/snapshot_management_api.md | 24 +-
website/sidebars.js | 8 +-
18 files changed, 102 insertions(+), 1016 deletions(-)
diff --git a/website/docs/modeling/model_design/data_modeling.md b/website/docs/modeling/model_design/data_modeling.md
deleted file mode 100755
index 9356225bdd..0000000000
--- a/website/docs/modeling/model_design/data_modeling.md
+++ /dev/null
@@ -1,66 +0,0 @@
----
-title: Model design overview
-language: en
-sidebar_label: Model design overview
-pagination_label: Model design overview
-toc_min_heading_level: 2
-toc_max_heading_level: 6
-pagination_prev: null
-pagination_next: null
-keywords:
- - model design overview
-draft: true
-last_update:
- date: 08/19/2022
----
-
-
-Kylin model consists of multiple tables and their join relations. Kylin follows multidimensional modeling theory to build star or snowflake schemas based on tables. Kylin also leverages pre-computation technique and will reuse the pre-computed results to answer queries, so there's no need to traverse all data when there is a query, thus achieving sub-second query times on PB-level data.
-
-### Challenges when dealing with massive data
-
-When analyzing massive data, there are some techniques to speed up computing and storage, but they cannot change the time complexity of query, that is, query latency and data volume are linearly dependent.
-
-If it takes 1 minute to query 100 million entries of data records, querying 10 billion data entries will take about 1 hour and 40 minutes. When companies want to analyze all business data piled up over the years or to add complexity to query, say, with more dimensions, queries will be running extremely slow or even time out.
-
-### Accelerate query with Kylin pre-computation
-
-Kylin leverages pre-computation to avoid the computing pressure brought by the growing data volume. That is, Kylin will precompute the combinations of defined model dimensions and then store the aggregated results as indexes to shorten query latency. In addition, Kylin uses parallel computing and columnar storage techniques to improve computing and storage speed.
-
-
-
-With pre-computation, the number of indexes will be determined by the dimension cardinality only, and will no longer undergo exponential growth as data volume increases. Taking the data analysis of online transactions as an example, with Kylin pre-computation, even if the volume of transaction data increases by 10 times, the query speed against the same analytical dimensions changes little. The computing time complexity can be kept at O(1), helping enterprises to analyze data more efficiently.
-
-
-
-### How to design model and indexes
-
-#### Manual modeling
-
-In addition to intelligent modeling, Kylin also supports users to design their own models and indexes based on their business needs. Kylin provides step-by-step guidance on how to complete basic model settings, including dimensions, measures, join relationships, and indexes. For details, see [Manual modeling](../../model/manual_modeling.en.md).
-
-#### Advanced model design
-
-Kylin offers various advanced features around models and indexes to help users quickly dig out the most valuable data. These features include:
-
-- Accelerated model design: Kylin offers built-in [advanced measures](measure_design/intro.md) like count distinct and Top N to speed up modeling.
-
-- Optimized index efficiency: Kylin uses the [data pruning](aggregation_group.md) technique to filter out less meaningful dimensions for index building efficiency.
-
-For more information, see [Advanced model design](intro.md).
-
-### Basic concepts
-
-Kylin follows multidimensional modeling theory and decomposes complex concepts into specific functional modules to make modeling easier. Below are some of the basic concepts used in Kylin:
-
-- Dimension: Dimension is a perspective of viewing data, which can be used to describe object attributes or characteristics, for example, product category.
-
-- Measure: Measure is an aggregated sum, which is usually a continuous value, for example, product sales.
-
-- Model: Model consists of multiple tables and their join relations, as well as defined dimensions and measures.
-
-- Pre-computation: Pre-computation is the process of aggregating data based on model dimension combinations and of storing the results as indexes to accelerate data query.
-
-- Index: Index is used to accelerate data query. Indexes are divided into:
- - Aggregate Index: Aggregate index is an aggregated combination of multiple dimensions and measures, and can be used to answer aggregate queries such as total sales for a given year.
- - Table Index: Table index is a multi-level index in a wide table and can be used to answer detailed queries such as the last 100 transactions of a certain user.
diff --git a/website/docs/restapi/acl_api/acl_api.md b/website/docs/restapi/acl_api/acl_api.md
index e126e089f7..7d3e77373a 100644
--- a/website/docs/restapi/acl_api/acl_api.md
+++ b/website/docs/restapi/acl_api/acl_api.md
@@ -1,5 +1,5 @@
---
-title: Data ACL API
+title: Data ACL API (BETA)
language: en
sidebar_label: Data ACL API
pagination_label: Data ACL API
@@ -9,7 +9,7 @@ pagination_prev: null
pagination_next: null
keywords:
- data acl api
-draft: false
+draft: true
last_update:
date: 08/12/2022
---
@@ -40,7 +40,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/acl/User/bb?authorized_only=true&project=m' \
+ 'http://host:port/kylin/api/acl/User/bb?authorized_only=true&project=m' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/acl_api/intro.md b/website/docs/restapi/acl_api/intro.md
index dff7e6148f..162ae898fb 100644
--- a/website/docs/restapi/acl_api/intro.md
+++ b/website/docs/restapi/acl_api/intro.md
@@ -15,4 +15,3 @@ last_update:
---
Kylin provides REST APIs on Access Control List Management to help users strictly manage the ACL on projects, tables, users, user group and so on.
-
diff --git a/website/docs/restapi/acl_api/project_acl_api.md b/website/docs/restapi/acl_api/project_acl_api.md
index 1d34c3063e..dba0d0eec3 100644
--- a/website/docs/restapi/acl_api/project_acl_api.md
+++ b/website/docs/restapi/acl_api/project_acl_api.md
@@ -24,7 +24,7 @@ last_update:
- `GET http://host:port/kylin/api/access/project`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- Request Parameters
@@ -43,7 +43,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/access/project?project=Kylin' \
+ 'http://host:port/kylin/api/access/project?project=learn_kylin' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -83,7 +83,7 @@ last_update:
- `POST http://host:port/kylin/api/access/project`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -102,7 +102,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/access/project' \
+ 'http://host:port/kylin/api/access/project' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -131,7 +131,7 @@ last_update:
- `PUT http://host:port/kylin/api/access/project`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- HTTP Body: JSON Object
- `project` - `required` `string`, project name.
@@ -149,7 +149,7 @@ last_update:
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/access/project' \
+ 'http://host:port/kylin/api/access/project' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -178,7 +178,7 @@ last_update:
- `DELETE http://host:port/kylin/api/access/project`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- Request Parameters
@@ -196,7 +196,7 @@ last_update:
```sh
curl -X DELETE \
- 'http://localhost:7070/kylin/api/access/project?project=Kylin&type=user&name=test' \
+ 'http://host:port/kylin/api/access/project?project=learn_kylin&type=user&name=test' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/acl_api/user_api.md b/website/docs/restapi/acl_api/user_api.md
index 45f1995561..8b9ce1edb4 100644
--- a/website/docs/restapi/acl_api/user_api.md
+++ b/website/docs/restapi/acl_api/user_api.md
@@ -25,7 +25,7 @@ last_update:
- `GET http://host:port/kylin/api/user`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- Request Parameters
@@ -44,7 +44,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/user' \
+ 'http://host:port/kylin/api/user' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -92,7 +92,7 @@ last_update:
- `POST http://host:port/kylin/api/user`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -111,7 +111,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/user' \
+ 'http://host:port/kylin/api/user' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -142,7 +142,7 @@ last_update:
- `PUT http://host:port/kylin/api/user`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -159,7 +159,7 @@ last_update:
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/user' \
+ 'http://host:port/kylin/api/user' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -186,7 +186,7 @@ last_update:
- `PUT http://host:port/kylin/api/user/password`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -204,7 +204,7 @@ last_update:
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/user' \
+ 'http://host:port/kylin/api/user' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -230,11 +230,9 @@ last_update:
### Delete User{#delete-user}
-### {#delete-user}
-
- `DELETE http://host:port/kylin/api/user`
-- Introduced in: 4.2.1
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -250,7 +248,7 @@ last_update:
```sh
curl -X DELETE \
- 'http://localhost:7070/kylin/api/user' \
+ 'http://host:port/kylin/api/user' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -276,7 +274,7 @@ last_update:
- `GET http://host:port/kylin/api/access/acls`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- Request Parameters
@@ -294,7 +292,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/access/acls?type=user&name=ADMIN' \
+ 'http://host:port/kylin/api/access/acls?type=user&name=ADMIN' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/acl_api/user_group_api.md b/website/docs/restapi/acl_api/user_group_api.md
index bb4846e15a..5d9cb7c14a 100644
--- a/website/docs/restapi/acl_api/user_group_api.md
+++ b/website/docs/restapi/acl_api/user_group_api.md
@@ -26,7 +26,7 @@ last_update:
- `GET http://host:port/kylin/api/user_group/groups`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- Request Parameters
@@ -45,7 +45,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/user_group/groups`' \
+ 'http://host:port/kylin/api/user_group/groups`' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -79,7 +79,7 @@ last_update:
- `GET http://host:port/kylin/api/user_group/group_members/{group_name}`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- URL Parameters
@@ -101,7 +101,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/user_group/group_members/test' \
+ 'http://host:port/kylin/api/user_group/group_members/test' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -151,7 +151,7 @@ last_update:
- `POST http://host:port/kylin/api/user_group`
-- Introduced in: 4.2.1
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -167,7 +167,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/user_group' \
+ 'http://host:port/kylin/api/user_group' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -195,7 +195,7 @@ last_update:
- `PUT http://host:port/kylin/api/user_group/users`
-- Introduced in: 4.1.4
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -212,7 +212,7 @@ last_update:
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/user_group/users' \
+ 'http://host:port/kylin/api/user_group/users' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -238,7 +238,7 @@ last_update:
- `DELETE http://host:port/kylin/api/user_group`
-- Introduced in: 4.2.1
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -254,7 +254,7 @@ last_update:
```sh
curl -X DELETE \
- 'http://localhost:7070/kylin/api/user_group' \
+ 'http://host:port/kylin/api/user_group' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/data_source_api.md b/website/docs/restapi/data_source_api.md
index 88c816d5ae..eb2347c3ea 100644
--- a/website/docs/restapi/data_source_api.md
+++ b/website/docs/restapi/data_source_api.md
@@ -89,7 +89,7 @@ last_update:
- `GET http://host:port/kylin/api/tables/pre_reload`
-- Introduced in: 4.1.9
+- Introduced in: 5.0
- URL Parameters
@@ -167,7 +167,7 @@ last_update:
- Request Permission: MANAGEMENT permission and above
-- Introduced in: 4.2.0
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -341,7 +341,7 @@ last_update:
- Request Permission: MANAGEMENT permission and above
-- Introduced in: 4.2.0
+- Introduced in: 5.0
- HTTP Body: JSON Object
@@ -390,7 +390,7 @@ last_update:
- Request Permission: Operation permission and above
-- Introduced in: 4.2.0
+- Introduced in: 5.0
- Request Parameters
@@ -443,7 +443,7 @@ last_update:
- Request Permission: READ permission and above.
-- Introduced in: 4.2.0
+- Introduced in: 5.0
- Request Parameters
@@ -465,7 +465,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/tables?project=test&database=SSB&table=KYLIN_SALES' \
+ 'http://host:port/kylin/api/tables?project=test&database=SSB&table=KYLIN_SALES' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -537,5 +537,5 @@ last_update:
"msg": ""
}
```
->Note: Prior to KE version 4.5.17.0, the `total_size` value was the total number of tables the requesting user had permissions on in the project. Due to performance issues, in KE 4.5.17.0 and later, the `total_size` value is adjusted to the total number of all loaded tables in the project and no longer correlates to the actual table permissions the requesting user has in the project.
+>Note: the `total_size` value is adjusted to the total number of all loaded tables in the project and no longer correlates to the actual table permissions the requesting user has in the project.
diff --git a/website/docs/restapi/job_api.md b/website/docs/restapi/job_api.md
index 43f6843145..8fbe91db9e 100644
--- a/website/docs/restapi/job_api.md
+++ b/website/docs/restapi/job_api.md
@@ -14,9 +14,6 @@ last_update:
date: 08/12/2022
---
-
-## Job API
-
> Reminders:
>
> 1. Please read [Access and Authentication REST API](authentication.md) and understand how authentication works.
diff --git a/website/docs/restapi/model_api/intro.md b/website/docs/restapi/model_api/intro.md
index 966c869d88..8697d243ac 100644
--- a/website/docs/restapi/model_api/intro.md
+++ b/website/docs/restapi/model_api/intro.md
@@ -15,6 +15,4 @@ last_update:
---
-## Model API
-
Kylin provides REST APIs on checking model information, index build and model management.
diff --git a/website/docs/restapi/model_api/model_build_api.md b/website/docs/restapi/model_api/model_build_api.md
index 95f0de1959..61da57a451 100644
--- a/website/docs/restapi/model_api/model_build_api.md
+++ b/website/docs/restapi/model_api/model_build_api.md
@@ -48,7 +48,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/models/SSB_LINEORDER/segments' \
+ 'http://host:port/kylin/api/models/SSB_LINEORDER/segments' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/model_api/model_import_and_export_api.md b/website/docs/restapi/model_api/model_import_and_export_api.md
index 830dead62d..86ba128093 100644
--- a/website/docs/restapi/model_api/model_import_and_export_api.md
+++ b/website/docs/restapi/model_api/model_import_and_export_api.md
@@ -40,7 +40,7 @@ last_update:
- Curl Request Example
```sh
- curl --location --request GET 'http://localhost:7070/kylin/api/metastore/previews/models?project=target_project&model_names=model_index' \
+ curl --location --request GET 'http://host:port/kylin/api/metastore/previews/models?project=target_project&model_names=model_index' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -112,7 +112,7 @@ last_update:
- Curl Request Example
```sh
- curl --remote-name --remote-header-name --location --request POST 'http://localhost:7070/kylin/api/metastore/backup/models?project=original_project' \
+ curl --remote-name --remote-header-name --location --request POST 'http://host:port/kylin/api/metastore/backup/models?project=original_project' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Content-Type: application/json;charset=utf-8' \
@@ -153,7 +153,7 @@ last_update:
- Curl Request Example
```sh
- curl --location --request POST 'http://localhost:7070/kylin/api/metastore/validation/models?project=original_project' \
+ curl --location --request POST 'http://host:port/kylin/api/metastore/validation/models?project=original_project' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -291,7 +291,7 @@ last_update:
- Curl Request Example
```sh
- curl --location --request POST 'http://localhost:7070/kylin/api/metastore/import/models?project=original_project' \
+ curl --location --request POST 'http://host:port/kylin/api/metastore/import/models?project=original_project' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/model_api/model_management_api.md b/website/docs/restapi/model_api/model_management_api.md
index b77fcd281b..23b6ed4edb 100644
--- a/website/docs/restapi/model_api/model_management_api.md
+++ b/website/docs/restapi/model_api/model_management_api.md
@@ -89,7 +89,7 @@ last_update:
- `primary_key` - `required` `string[]`, primary key
- `simplified_non_equi_join_conditions` - `optional` `JSON Object`, non-equivalent join conditions
- (note1: The support of this settings should have 'Support History Table' enabled in advance. Seeing [Slowly Changing Dimension](#TODO))
+ (note1: The support of this settings should have 'Support History Table' enabled in advance. Seeing [Slowly Changing Dimension](../../modeling/model_design/slowly_changing_dimension.md))
(note2: Join relationship >= and < must be used in pairs, and same column must be joint in both conditions)
@@ -102,7 +102,7 @@ last_update:
- `join_relation_type` - `optional` `string`, join type: MANY_TO_ONE,MANY_TO_MANY, default: MANY_TO_ONE
- `partition_desc` - `optional` `JSON Object`, partition columns info
- `partition_date_column` - `required` `string`, partition date column, format: TABLE.COLUMN
- - `partition_date_format` - `required` `string`, partition date column format, including: yyyy-MM-dd, yyyyMMdd... Supported date format please check "[Model Design Basics](#TODO)"
+ - `partition_date_format` - `required` `string`, partition date column format, including: yyyy-MM-dd, yyyyMMdd... Supported date format please check "[Model Design Basics](../../modeling/data_modeling.md)"
- `partition_type` - `optional` `string`, partition type, including: APPEND, default: APPEND
- `owner` - `optional` `string`, the owner of model, default current user
- `description` - `optional` `string`, model description
@@ -114,12 +114,14 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/models' \
+ 'http://host:port/kylin/api/models' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
-H 'Content-Type: application/json;charset=utf-8' \
- # Stringify the following JSON Object when use
+
+ ### Stringify the following JSON Object when use
+
-d '{
"project": "pj01",
"fact_table": "SSB.P_LINEORDER",
@@ -262,7 +264,7 @@ last_update:
"msg": "KE-010001002(Empty Project Name):Can’t find project information. Please select a project.",
"stacktrace": "KE-010001002(Empty Project Name) \norg.apache.kylin.common.exception.KylinException: KE-010001002(Empty Project Name):Can’t find project information. ...",
"exception": "KE-010001002(Empty Project Name):Can’t find project information. Please select a project.",
- "url": "http://localhost:7070/kylin/api/models"
+ "url": "http://host:port/kylin/api/models"
}
```
@@ -306,7 +308,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/models?project=doc_expert' \
+ 'http://host:port/kylin/api/models?project=doc_expert' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -360,7 +362,7 @@ last_update:
> [!NOTE]
>
- > For parameters not listed in this page, you may go to the [Kylin Console](#TODO) for details.
+ > For parameters not listed in this page, you may go to the [Model Concepts and Operations](../../modeling/model_concepts_operations.md) for details.
```json
{
@@ -504,7 +506,7 @@ last_update:
- `hierarchy_dims`: `JSON`, dimension hierarchy
- `mandatory_dims`: `JSON`, required hierarchy
- `joint_dims`: `JSON`, joint dimensions
- - `computed_columns`: `JSON`, [Computed Column](#TODO)
+ - `computed_columns`: `JSON`, [Computed Column](../../modeling/model_design/computed_column.md)
- `tableIdentity`: `String`, table ID
- `tableAlias`: `String`, table alias
- `columnName`: `String`, column name
@@ -689,130 +691,6 @@ last_update:
}
```
-### Define Partition Column(Deprecated){#Define-Partition-Column-Deprecated}
-
-- `PUT http://host:port/kylin/api/models/{project}/{model_name}/partition_desc`
-
-- URL Parameters
-
- - `model_name` - `required` `string`, model name.
- - `project` - `required` `string`, project name.
-
-- HTTP Header
-
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
-- HTTP Body: JSON Object
-
- - `partition_desc` - `optional` `string`, indicate the column name and data format of partition column.
-
- - `start` - `optional` `string`, start time of segment (partition column exist), default value is `1`, type: timestamp, unit: ms.
-
- - `end` - `optional` `string`, end time of segment (partition column exist), default value is`9223372036854775806`, type: timestamp, unit: ms.
-
- > If you need to set the model partition column, the above parameters need to be filled in. Otherwise, if you want the model to be defined as a non-partition, please leave these parameters blank.
-
-- Curl Request Example
-
- ```sh
- curl -X PUT \
- 'http://localhost:7070/kylin/api/models/ssb/test/partition_desc' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{
- "partition_desc":{
- "partition_date_column":"LINEORDER.LO_ORDERDATE",
- "partition_date_format":"yyyy-MM-dd"},
- "start":"0",
- "end":"1111"
- }'
- ```
-
-- Response Example
-
- ```json
- {
- "code":"000",
- "data":"",
- "msg":""
- }
- ```
-
-
-
-### Model Validation{#Model-Validation}
-
-> Used to determine whether the SQLs can be answered by an existing model which includes the original model and the models with recommendations.
->
-
-- `POST http://host:port/kylin/api/models/model_validation`
-
-- HTTP Header
-
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
-
- - `Content-Type: application/json;charset=utf-8`
-
-- HTTP Body: JSON Object
-
- - `project` - `required` `string`, project name.
- - `sqls` - `required` `array`, query list.
-
-* Curl Request Example
-
- ```sh
- curl -X POST \
- 'http://localhost:7070/kylin/api/models/model_validation' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{"project":"ssb", "sqls":["select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY1", "SELECT LO_SHIPPRIOTITY,count(1) FROM SSB.LINEORDER GROUP BY LO_SHIPPRIOTITY"]}'
- ```
-
-* Response Details
-
- * `valid_sqls`, valid queries and the corresponding model. If there is no answerable model, the list will be empty.
- * `error_sqls`, queries failed to pass the syntax check.
- * `error_sqls_detail`, detailed error message of queries failed to pass the syntax check
-
-* Response Example
-
- ```json
- {
- "code":"000",
- "data":{
- "valid_sqls":{
- "SELECT LO_SHIPPRIOTITY,count(1) FROM SSB.LINEORDER GROUP BY LO_SHIPPRIOTITY":[
- "AUTO_MODEL_LINEORDER_2"
- ]
- },
- "error_sqls":[
- "select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY1"
- ],
- "error_sqls_detail": [
- {
- "sql": "select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY1",
- "sql_advices": [
- {
- "suggestion": "Please add column LO_CUSTKEY1 to data source.",
- "incapable_reason": "Column 'LO_CUSTKEY1' not found in any table."
- }
- ]
- }
- ]
- },
- "msg":""
- }
- ```
-
-
-
### Get index list{#get-index-list}
> Get indexes of given model.
@@ -841,7 +719,7 @@ last_update:
+ Curl Request Example
```shell
- curl -X GET 'http://localhost:7070/kylin/api/models/m1/indexes?project=ssb&batch_index_ids=1,10001,20001' \
+ curl -X GET 'http://host:port/kylin/api/models/m1/indexes?project=ssb&batch_index_ids=1,10001,20001' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -928,551 +806,13 @@ last_update:
}
```
-
-
-### Create a Model by SQL{#sql}
-
-- `POST http://host:port/kylin/api/models/model_suggestion`
-- HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-- HTTP Body: JSON Object
-
- - `project` - `required` `string`, project name.
- - `sqls` - `required` `array`, queries to create models
- - `with_segment` - `optional`, `bool`, create an empty segment, default is true
- - `with_model_online` - `optional`, `bool`, model online or not, default is false
-
-* Curl Request Example
-
- ```sh
- curl -X POST \
- 'http://localhost:7070/kylin/api/models/model_suggestion' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{"project":"ssb", "sqls":["select count(*) from ssb.P_LINEORDER", "SELECT 1"]}'
- ```
-
-* Response Details
-
- * `models`, model details
- * `uuid`, model UUID
- * `alias`, model name
- * `version`, model version
- * `rec_items`, new model information. Please note that there will be some model detail info such as dimensions or measure shown as a recommendation, but it will not truly generate such a recommendation.
- * `sqls`, sqls used by one recommendation item
- * `index_id`, reused index id, if the value is -1, a new model created
- * `dimensions`, all dimensions used, `new` used to indicate whether it is newly created or reused
- * `measues`, all measures used, `new` used to indicate whether it is newly created or reused
- * `computed_columns`, all computed_columns used, `new` used to indicate whether it is newly created or reused
- * `error_sqls`, failed SQLs
-
-* Response Example
-
- ```json
- {
- "code": "000",
- "data": {
- "models": [
- {
- "uuid": "364e4485-433c-4fe2-be57-02c59170b5d4",
- "alias": "AUTO_MODEL_P_LINEORDER_1",
- "version": "4.0.0.0",
- "rec_items": [
- {
- "sqls": [
- "select count(*) from ssb.P_LINEORDER"
- ],
- "index_id": -1,
- "dimensions": [],
- "measures": [
- {
- "measure": {
- "name": "COUNT_ALL",
- "function": {
- "expression": "COUNT",
- "parameters": [
- {
- "type": "constant",
- "value": "1"
- }
- ],
- "returntype": "bigint"
- },
- "id": 100000
- },
- "new": true
- }
- ],
- "computed_columns": []
- }
- ]
- }
- ],
- "error_sqls": [
- "SELECT 1"
- ]
- },
- "msg": ""
- }
- ```
-
-
-
-### Model Optimization{#Optimize-Model}
-
-
-- `POST http://host:port/kylin/api/models/model_optimization`
-- HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
-
- - `Content-Type: application/json;charset=utf-8`
-- HTTP Body: JSON Object
-
- - `project` - `required` `string`, project name.
- - `sqls` - `required` `array`, queries to optimize models.
- - `accept_recommendation` - `optionalboolean`, default value is `false`, in which case the recommendations will be saved into the recommendation list. When it is set as `true`, the recommendations will be transferred to index directly.
-
-
-* Curl Request Example
-
- ```sh
- curl -X POST \
- 'http://localhost:7070/kylin/api/models/model_optimization' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{"project":"ssb", "sqls":["select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY", "SELECT 1"]}'
- ```
-
-* Response Details
-
- * `models` , model details
- * `alias`, model name
- * `rec_items`, recommendation details
- * `sqls`, sqls used by one recommendation
- * `index_id`, a temporary index id
- * `dimensions`, all dimensions used by this recommendation
- * `measures`, all measures used by this recommendation
- * `computed_column`, all computed columns used by this recommendation
- * `error_sqls`, failed SQLs
-
-* Response Example
-
- ```json
- {
- "code": "000",
- "data": {
- "models": [
- {
- "uuid": "364e4485-433c-4fe2-be57-02c59170b5d4",
- "alias": "AUTO_MODEL_P_LINEORDER_1",
- "version": "4.0.0.0",
- "rec_items": [
- {
- "sqls": [
- "select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY"
- ],
- "index_id": 10001,
- "dimensions": [
- {
- "dimension": {
- "id": 1,
- "name": "P_LINEORDER_0_DOT_0_LO_CUSTKEY",
- "column": "P_LINEORDER.LO_CUSTKEY",
- "status": "DIMENSION"
- },
- "dataType": "integer",
- "new": true
- }
- ],
- "measures": [
- {
- "measure": {
- "name": "COUNT_ALL",
- "function": {
- "expression": "COUNT",
- "parameters": [
- {
- "type": "constant",
- "value": "1"
- }
- ],
- "returntype": "bigint"
- },
- "id": 100000
- },
- "new": false
- }
- ],
- "computed_columns": []
- }
- ]
- }
- ],
- "error_sqls": [
- "SELECT 1"
- ]
- },
- "msg": ""
- }
- ```
-
-
-
-### Accelerate SQL{#Accelerate-sql}
-
- - `POST http://host:port/kylin/api/models/sql_acceleration`
- - HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
- - HTTP Body: JSON Object
-
- - `project` - `required` `string`, project name.
- - `sqls` - `required` `array`, queries to optimize models.
- - `accept_recommendation` - `optionalboolean`, default value is `false`, in which case the recommendations will be saved into the recommendation list. When it is set as `true`, the recommendations will be transferred to index directly.
- - `with_segment` - `optional`, `bool`, create an empty segment, default is true
- - `with_model_online` - `optional`, `bool`, model online or not, default is false
-
- * Curl Request Example
-
- ```sh
- curl -X POST \
- 'http://localhost:7070/kylin/api/models/sql_acceleration' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{"project":"ssb", "sqls":["select count(*) from SSB.LINEORDER","select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY", "SELECT 1"]}'
- ```
-
- * Response Details
-
- * `optimized_models` , optimized model details
- * `alias`, model name
- * `rec_items`, recommendation details
- * `sqls`, sqls used by one recommendation
- * `index_id`, a temporary index id
- * `dimensions`, all dimensions used by this recommendation
- * `measures`, all measures used by this recommendation
- * `computed_columns`, all computed columns used by this recommendation
-
- * `created_models`, created model details
- * `uuid`, model UUID
- * `alias`, model name
- * `version`, model version
- * `rec_items`, new model information. Please note that there will be some model detail info such as dimensions or measure shown as a recommendation, but it will not truly generate such a recommendation.
- * `sqls`, sqls used by one recommendation item
- * `index_id`, reused index id, if the value is -1, a new model created
- * `dimensions`, all dimensions used, `new` used to indicate whether it is newly created or reused
- * `measures`, all measures used, `new` used to indicate whether it is newly created or reused
- * `computed_columns`, all computed_columns used, `new` used to indicate whether it is newly created or reused
-
-* `optimal_models`, optimal models details
-
- * `uuid`, model UUID
-
- - `alias`, model name
-
- - `version`, model version
-
- - `rec_items`, query response details
- - `sqls`, sql used by one query
- - `index_id`, index used by one query
- - `dimensions`, all dimensions about index
- - `measures`, all measures about index
- - `computed_columns`, all coputed_columns about index
-
- * `error_sqls`, failed SQLs
-
- * Response Example
-
- ```json
- {
- "code": "000",
- "data": {
- "optimized_models": [
- {
- "uuid": "364e4485-433c-4fe2-be57-02c59170b5d4",
- "alias": "AUTO_MODEL_P_LINEORDER_1",
- "version": "4.0.0.0",
- "rec_items": [
- {
- "sqls": [
- "select LO_CUSTKEY, count(1) from SSB.P_LINEORDER GROUP BY LO_CUSTKEY"
- ],
- "index_id": 10001,
- "dimensions": [
- {
- "dimension": {
- "id": 1,
- "name": "P_LINEORDER_0_DOT_0_LO_CUSTKEY",
- "column": "P_LINEORDER.LO_CUSTKEY",
- "status": "DIMENSION"
- },
- "dataType": "integer",
- "new": true
- }
- ],
- "measures": [
- {
- "measure": {
- "name": "COUNT_ALL",
- "function": {
- "expression": "COUNT",
- "parameters": [
- {
- "type": "constant",
- "value": "1"
- }
- ],
- "returntype": "bigint"
- },
- "id": 100000
- },
- "new": false
- }
- ],
- "computed_columns": []
- }
- ]
- }
- ],
- "created_models": [
- {
- "uuid": "364e4485-433c-4fe2-be57-02c59170b5d4",
- "alias": "AUTO_MODEL_LINEORDER_1",
- "version": "4.0.0.0",
- "rec_items": [
- {
- "sqls": [
- "select count(*) from SSB.LINEORDER"
- ],
- "index_id": -1,
- "dimensions": [],
- "measures": [
- {
- "measure": {
- "name": "COUNT_ALL",
- "function": {
- "expression": "COUNT",
- "parameters": [
- {
- "type": "constant",
- "value": "1"
- }
- ],
- "returntype": "bigint"
- },
- "id": 100000
- },
- "new": true
- }
- ],
- "computed_columns": []
- }
- ]
- }
- ],
- "optimal_models":[
- {
- "uuid":"6731928e-0f6c-6a79-f430-9e2c938689de",
- "alias":"CONSTANT",
- "version":"4.0.0.0",
- "rec_items":[
- {
- "sqls":[
- "select 1"
- ],
- "index_id":-1,
- "dimensions":[
-
- ],
- "measures":[
-
- ],
- "computed_columns":[
-
- ]
- }
- ]
- },
- ],
- "error_sqls": [
- "SELECT SELECT"
- ]
- },
- "msg": ""
- }
- ```
-
-
-
-### Get Model Recommendations{#Get_Model_Recommendations}
-
-> Call this API to get model recommendations for certain models. For SQL queries answered by pushdown rather than the models, Kylin will generate corresponding recommendations. Making this API call returns recommendations for specified models.
-
-- `GET http://host:port/kylin/api/models/{model_name}/recommendations`
-
-- URL Parameters
-
- - `model_name` - `required` `string`, model name.
- - `project` - `required` `string`, project name.
-
-- HTTP Header
-
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
-- Curl Request Example
-
- ```shell
- curl -X GET \
- 'http://host:port/kylin/api/models/ssb_test/recommendations?project=ssb'\
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8'
- ```
-
-* Response Details
-
- * `layouts`, all index recommendations
- * `add`, recommendation used for adding or removing index
- * `agg`, index related to this recommendation is AggIndex or TableIndex
- * `item_id`, recommendation id
- * `is_agg`, the same to `agg`
- * `is_add`, the same to `add`
- * `type`, recommendation type, including ADD_AGG_INDEX, REMOVE_AGG_INDEX, ADD_TABLE_INDEX, REMOVE_TABLE_INDEX
- * `create_time`, create time of recommendation
- * `last_modified`, last modified time of recommendation
- * `hit_count`, used times of this recommendation in history
- * `index_id`, ID of indexes in recommendations and if parameter `add` is true, this one should be ignored
- * `data_size`, data size of indexes in recommendations and if parameter `add` is true, this one will be `-1`
- * `memo_info`, comments of recommendations of deleting indexes
- * `size`, all index recommendation size
- * `model_id`, model id
- * `project`, project name
-
-* Response Example
-
- ```json
- {
- "code": "000",
- "data": {
- "layouts": [{
- "add": true,
- "agg": true,
- "item_id": 34,
- "is_agg": true,
- "is_add": true,
- "type": "ADD_AGG_INDEX",
- "create_time": 1601027171262,
- "last_modified": 1601028480033,
- "hit_count": 20,
- "index_id": 0,
- "data_size": -1,
- "memo_info": {}
- }, {
- "add": false,
- "agg": true,
- "item_id": 35,
- "is_agg": true,
- "is_add": false,
- "type": "REMOVE_AGG_INDEX",
- "create_time": 1601028374011,
- "last_modified": 1601028491121,
- "hit_count": 2,
- "index_id": 1,
- "data_size": 155219,
- "memo_info": {
- "index_opt_reason": "INCLUDED"
- }
- }],
- "size": 2,
- "model_id": "931c95ba-a6c1-4d7e-8f30-b4599dae16ed",
- "project": "ssb"
- },
- "msg": ""
- }
- ```
-
-
-
-### Approve Model Recommendation in batch{#Approve_Model_Recommendation_in_batch}
-
-> Call this API to accept recommendations for certain models in batch. The recommendations are provided on a model level, that is, you can accept or reject all recommendations for certain model.
-
-- `PUT http://host:port/kylin/api/models/recommendations/batch`
-- HTTP Body: JSON Object
- - `project` - `required` `string`, project name.
- - `filter_by_models ` - `required` `boolean` , whether to approve recommendations by models. The default value is `true`, which means you only approve the recommendations under the models specified by `model_names` . Otherwise, all the recommendations in this project will be approved.
- - `model_names` - `optional` `array`, model name list.
-- HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
-
- - `Content-Type: application/json;charset=utf-8`
-
-* Curl Request Example
-
- ```sh
- curl -X PUT \
- 'http://localhost:7070/kylin/api/models/recommendations/batch' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{
- "project": "ssb",
- "filter_by_models": "true",
- "model_names": ["ssb_test"]
- }'
- ```
-
-* Response Details
-
- - project, project name
- - models, information of affected models
- - uuid, model uuid
- - alias, model name
- - added_indexes：the added index IDs among approved recommendations
- - deleted_indexes：the removed index IDs among approved recommendations
-
-* Response Example
-
- ```json
- {
- "code": "000",
- "data": {
- "project": "ssb",
- "models": [
- {
- "uuid": "364e4485-433c-4fe2-be57-02c59170b5d4",
- "alias": "ssb_test",
- "added_indexes": [20001,30001],
- "deleted_indexes": []
- }]
- },
- "msg": ""
- }
- ```
-
### Delete Model {#Delete_Model}
- `DELETE http://host:port/kylin/api/models/{model_name}`
- Request Permission: MANAGEMENT permission and above
-- Introduced in: 4.2.0
+- Introduced in: 5.0
- URL Parameters
@@ -1509,7 +849,7 @@ last_update:
}
```
-### Export TDS File {#EXPORT_TDS}
+### Export TDS File (BETA) {#EXPORT_TDS}
- `GET http://host:port/kylin/api/models/{model_name}/export`
- URL Parameters
@@ -1533,10 +873,10 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/models/a3/export?project=test_project&export_as=TABLEAU_ODBC_TDS&element=AGG_INDEX_COL&server_host=host&server_port=7080' \
+ 'http://host:port/kylin/api/models/a3/export?project=test_project&export_as=TABLEAU_ODBC_TDS&element=AGG_INDEX_COL&server_host=host&server_port=7080' \
-H 'accept: application/vnd.apache.kylin-v4-public+json' \
-H 'authorization: Basic QURNSU46S1lMSU4=' \
- -H'Content-Type: application/json;charset=utf-8' \
+ -H 'Content-Type: application/json;charset=utf-8' \
```
@@ -1544,7 +884,7 @@ curl -X GET \
- `PUT http://host:port/kylin/api/models/{model_name}/name`
-- Introduced in: 4.5.4
+- Introduced in: 5.0
- URL Parameters
@@ -1565,12 +905,12 @@ curl -X GET \
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/models/sytest/name' \
- -H'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H'Accept-Language: cn' \
- -H'Authorization: Basic QURNSU46S1lMSU4=' \
+ 'http://host:port/kylin/api/models/test_model/name' \
+ -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
+ -H 'Accept-Language: cn' \
+ -H 'Authorization: Basic QURNSU46S1lMSU4=' \
-H 'Content-Type: application/json;charset=utf-8' \
- -d'{"project":"ssb", "new_model_name":"testNewName"}'
+ -d '{"project":"ssb", "new_model_name":"testNewName"}'
```
- Response Example
@@ -1591,7 +931,7 @@ curl -X GET \
- Request Permission: MANAGEMENT permission and above
-- Introduced in: 4.5.11
+- Introduced in: 5.0
- URL Parameters
@@ -1611,7 +951,7 @@ curl -X GET \
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/models/model_test1/status' \
+ 'http://host:port/kylin/api/models/model_test1/status' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -1638,7 +978,7 @@ curl -X GET \
"msg": "KE-010001002(Empty Project Name):Can’t find project information. Please select a project.",
"stacktrace": "KE-010001002(Empty Project Name) \norg.apache.kylin.common.exception.KylinException: KE-010001002(Empty Project Name):Can’t find project information. ...",
"exception": "KE-010001002(Empty Project Name):Can’t find project information. Please select a project.",
- "url": "http://localhost:7070/kylin/api/models"
+ "url": "http://host:port/kylin/api/models"
}
```
@@ -1648,7 +988,7 @@ curl -X GET \
- `KE-010001002`: Empty Project Name
- `KE-010000003`: Invalid Parameter
-### Export TDS File based on user rights {#Export_TDS_File_based_on_user_rights}
+### Export TDS File based on user rights (BETA) {#Export_TDS_File_based_on_user_rights}
- `GET http://host:port/kylin/api/models/bi_export`
- URL Parameters
@@ -1691,7 +1031,7 @@ curl -X GET \
"msg": "KE-010002022(The table not contains unauthenticated columns):Please add permissions to columns in the table!",
"stacktrace": "KE-010002022(The table not contains unauthenticated columns) \norg.apache.kylin.common.exception.KylinException: KE-010002022(The table not contains unauthenticated columns):Please add permissions to columns in the table!8)...。",
"exception": "KE-010002022(The table not contains unauthenticated columns):Please add permissions to columns in the table!",
- "url": "http://localhost:7070/kylin/api/models/bi_export"
+ "url": "http://host:port/kylin/api/models/bi_export"
}
```
diff --git a/website/docs/restapi/model_api/model_multilevel_partitioning_api.md b/website/docs/restapi/model_api/model_multilevel_partitioning_api.md
index 9bb5043a13..ceaaf43ab2 100644
--- a/website/docs/restapi/model_api/model_multilevel_partitioning_api.md
+++ b/website/docs/restapi/model_api/model_multilevel_partitioning_api.md
@@ -234,7 +234,7 @@ For building multi-level partition model, please refer directly to [Load Segment
```
### Get Segment List {#Get Segment List}
-Please refer to [Get Segment List](../segment_managment_api.md) for multi-level partition model to get Segment list.
+Please refer to [Get Segment List](../segment_management_api.md) for multi-level partition model to get Segment list.
### Get Segment details {#Get Segment details}
- `GET http://host:port/kylin/api/models/{model_name}/segments/multi_partition`
diff --git a/website/docs/restapi/project_api.md b/website/docs/restapi/project_api.md
index 80deaf9293..10a10d1f6e 100644
--- a/website/docs/restapi/project_api.md
+++ b/website/docs/restapi/project_api.md
@@ -14,9 +14,6 @@ last_update:
date: 08/12/2022
---
-
-## Project Setting API
-
> Reminders:
>
> 1. Please read [Access and Authentication REST API](authentication.md) and understand how authentication works.
@@ -138,137 +135,6 @@ last_update:
}
```
-
-### General Setting {#general-setting}
-
-- `PUT http://host:port/kylin/api/projects/{project}/project_general_info`
-
-- URL Parameters
-
- - `project` - `required` `string`, project name.
-
-- HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
-- HTTP Body: JSON Object
- - `description` - `optional` `string`, project description.
- - `semi_automatic_mode` - `optional` `boolean`, whether to turn
- on Recommendation Mode. `True` means to turn on, `false` means to turn off. The default value is `false`.
-
-- Curl Request Example
-
- ```sh
- curl -X PUT \
- 'http://host:port/kylin/api/projects/b/project_general_info' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{
- "description":"description",
- "semi_automatic_mode":true
- }'
- ```
-
-- Response Example
-
- ```json
- {
- "code":"000",
- "data":null,
- "msg":""
- }
- ```
-
-
-### Storage Quota {#storage-quota}
-
-- `PUT http://host:port/kylin/api/projects/{project}/storage_quota`
-
-- URL Parameters
-
- - `project` - `required` `string`, project name.
-
-- HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
-- HTTP Body: JSON Object
-
-- `storage_quota_size` - `required` `long`, project storage quota, unit byte. Optional values: positive numbers and be equal or greater than `1099511627776` , which means equal or greater than 1 TB.
-
-- Curl Request Example
-
- ```sh
- curl -X PUT \
- 'http://host:port/kylin/api/projects/b/storage_quota' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{
- "storage_quota_size": 1099511627776
- }'
- ```
-
-- Response Example
-
- ```json
- {
- "code":"000",
- "data":null,
- "msg":""
- }
- ```
-
-
-### Low Usage Storage {#inefficient-storage}
-
-- `PUT http://host:port/kylin/api/projects/{project}/garbage_cleanup_config`
-
-- URL Parameters
- - `project` - `required` `string`, project name.
-
-
-- HTTP Header
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
-- HTTP Body: JSON Object
- - `frequency_time_window` - `required` `string`, low usage storage calculation period. Optional values: `MONTH`, `WEEK`, `DAY`.
- - `low_frequency_threshold` - `required` `int`, the number of use of low usage storage. Optional values: positive integer and `0`. For example, you can set when usage is lower than 10 times, then the storage of indices would be regarded as low usage storage.
-
-- Curl Request Example
-
- ```sh
- curl -X PUT \
- 'http://host:port/kylin/api/projects/b/garbage_cleanup_config' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{
- "frequency_time_window": "WEEK",
- "low_frequency_threshold": 7
- }'
- ```
-
-- Response Example
-
- ```json
- {
- "code":"000",
- "data":null,
- "msg":""
- }
- ```
-
-
-
### <span id="Pushdown">Pushdown Setting</span>
- `PUT http://host:port/kylin/api/projects/{project}/push_down_config`
@@ -305,7 +171,7 @@ last_update:
```json
{
"code":"000",
- "data":null,
+ "data":"",
"msg":""
}
```
@@ -351,7 +217,7 @@ last_update:
```json
{
"code":"000",
- "data":null,
+ "data":"",
"msg":""
}
```
@@ -420,7 +286,7 @@ last_update:
```json
{
"code":"000",
- "data":null,
+ "data":"",
"msg":""
}
```
@@ -463,7 +329,7 @@ last_update:
```json
{
"code":"000",
- "data":null,
+ "data":"",
"msg":""
}
```
@@ -510,7 +376,7 @@ last_update:
```json
{
"code":"000",
- "data":null,
+ "data":"",
"msg":""
}
```
@@ -547,48 +413,6 @@ last_update:
}'
```
-- Response Example
-
- ```json
- {
- "code": "000",
- "data": null,
- "msg": ""
- }
- ```
-
-
-
-### <span id="update-job-engine">Update the Linking Relationship between Projects and Job Engines</span>
-
-**Note:** This Rest API need to cooperate with multi-active job engines. For more details, please refer to [Kylin Multi-Active Job Engines](#TODO).
-
-- `POST http://host:port/kylin/api/epoch`
-
-- HTTP Body: JSON Object
-
- - `projects` - `required` `string`, projects name. If the array is empty, it will update the relationship for all projects
- - `force` - `required` `boolean`, whether to update the relationship directly. For `false`, it will check whether the relationship is outdated. If it is outdated, the system will update it based on current projects and job engines. For `true`, the system will skip the check step and update directly.
-
-- HTTP Header
-
- - `Accept: application/vnd.apache.kylin-v4-public+json`
- - `Accept-Language: en`
- - `Content-Type: application/json;charset=utf-8`
-
-- Curl Request Example
-
- ```sh
- curl -X POST \
- 'http://host:port/kylin/api/epoch' \
- -H 'Accept: application/vnd.apache.kylin-v4-public+json' \
- -H 'Accept-Language: en' \
- -H 'Authorization: Basic QURNSU46S1lMSU4=' \
- -H 'Content-Type: application/json;charset=utf-8' \
- -d '{"projects":["Project_A"],"force":true}'
- ```
-
-
- Response Example
```json
@@ -694,7 +518,3 @@ The Low Usage Storage, Segment Settings, Storage Quota and Job Notification can
- `"data_load_empty_notification_enabled":false`
- `"job_error_notification_enabled":false`
- `"job_notification_emails"` is null
-
-- The default values for Storage Quota
-
- - `"kylin.storage.quota-in-giga-bytes": 10240`
diff --git a/website/docs/restapi/query_api.md b/website/docs/restapi/query_api.md
index 1615afe456..e92ce87ab4 100755
--- a/website/docs/restapi/query_api.md
+++ b/website/docs/restapi/query_api.md
@@ -472,7 +472,7 @@ Calling this API will refresh the table cache of the Spark SQL Context for all q
-### Download query history SQL {#Download-query-history-SQL}
+### Download query history {#Download-query-history}
- `GET http://host:port/kylin/api/query/download_query_histories`
@@ -499,7 +499,7 @@ Calling this API will refresh the table cache of the Spark SQL Context for all q
```
curl -X GET \
- ' http://host:port/kylin/api/query/download_ query_ histories?timezone_ offset_ hour=8&realization=&query_ status=&submitter=&project=default&start_ time_ from=&start_ time_ to=&latency_ from=&latency_ to=&sql=' \
+ ' http://host:port/kylin/api/query/download_query_histories?timezone_offset_hour=8&realization=&query_status=&submitter=&project=default&start_time_from=&start_time_to=&latency_from=&latency_to=&sql=' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -534,7 +534,7 @@ Calling this API will refresh the table cache of the Spark SQL Context for all q
```
curl -X GET \
- ' http://host:port/kylin/api/query/download_ query_ histories_ sql?timezone_ offset_ hour=8&realization=&query_ status=&submitter=&project=default&start_ time_ from=&start_ time_ to=&latency_ from=&latency_ to=&sql=' \
+ ' http://host:port/kylin/api/query/download_query_histories_sql?timezone_offset_hour=8&realization=&query_status=&submitter=&project=default&start_time_from=&start_time_to=&latency_from=&latency_to=&sql=' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/segment_management_api.md b/website/docs/restapi/segment_management_api.md
index b63b008248..4f132b0c26 100644
--- a/website/docs/restapi/segment_management_api.md
+++ b/website/docs/restapi/segment_management_api.md
@@ -44,7 +44,7 @@ last_update:
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/models/SSB_LINEORDER/segments?project=doc_expert' \
+ 'http://host:port/kylin/api/models/SSB_LINEORDER/segments?project=doc_expert' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -152,7 +152,7 @@ last_update:
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/models/SSB_LINEORDER/segments' \
+ 'http://host:port/kylin/api/models/SSB_LINEORDER/segments' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -197,7 +197,7 @@ last_update:
```sh
curl -X DELETE \
- 'http://localhost:7070/kylin/api/models/SSB_LINEORDER/segments?project=doc_expert&ids=291b9926-eaba-42d1-9d70-0a587992bea7&purge=false' \
+ 'http://host:port/kylin/api/models/SSB_LINEORDER/segments?project=doc_expert&ids=291b9926-eaba-42d1-9d70-0a587992bea7&purge=false' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -247,7 +247,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/models/ssb_model/segments/check' \
+ 'http://host:port/kylin/api/models/ssb_model/segments/check' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -313,7 +313,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/models/ssb_test/indexes' \
+ 'http://host:port/kylin/api/models/ssb_test/indexes' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -367,7 +367,7 @@ last_update:
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/models/m1/segments/completion?project=ssb&names=19900101000000_19950101000000,19950101000000_19970101000000' \
+ 'http://host:port/kylin/api/models/m1/segments/completion?project=ssb&names=19900101000000_19950101000000,19950101000000_19970101000000' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/docs/restapi/snapshot_management_api.md b/website/docs/restapi/snapshot_management_api.md
index 329cf09c43..2a86d81634 100644
--- a/website/docs/restapi/snapshot_management_api.md
+++ b/website/docs/restapi/snapshot_management_api.md
@@ -26,7 +26,7 @@ last_update:
- `PUT http://host:port/kylin/api/projects/{project}/snapshot_config`
- Request Permission: ADMIN permission and above
-- Introduced in: 4.2.2
+- Introduced in: 5.0
- URL Parameters
- `project` - `required` `string`, project name.
- HTTP Body: JSON Object
@@ -38,7 +38,7 @@ last_update:
- Curl Request Example
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/projects/gc_test/snapshot_config' \
+ 'http://host:port/kylin/api/projects/gc_test/snapshot_config' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -60,7 +60,7 @@ curl -X PUT \
- `POST http://host:port/kylin/api/snapshots`
- Request Permission: OPERATION permission and above
-- Introduced in: 4.2.2 (Partition building: since 4.2.6)
+- Introduced in: 5.0 (Partition building: since 5.0)
- HTTP Body: JSON Object
- `project` - `required` `string`, project name.
- `tables` - `optional` `array[string]`, load tables with the format `DB.TABLE`
@@ -81,7 +81,7 @@ curl -X PUT \
- Curl Request Example
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/snapshots' \
+ 'http://host:port/kylin/api/snapshots' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -111,7 +111,7 @@ curl -X POST \
- `POST http://host:port/kylin/api/snapshots/config`
- Request Permission: OPERATION permission and above
-- Introduced in: 4.2.6
+- Introduced in: 5.0
- HTTP Body: JSON Object
- `project` - `required` `string`, project name.
- `table_partition_col` - `required` `map[string:string]` The mapping from table (DB.TABLE) to chosen partition column.
@@ -122,7 +122,7 @@ curl -X POST \
- Curl Request Example
```sh
curl -X POST \
- 'http://localhost:7070/kylin/api/snapshots/config' \
+ 'http://host:port/kylin/api/snapshots/config' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -146,7 +146,7 @@ curl -X POST \
- Request Permission: OPERATION permission and above
-- Introduced in: 4.2.2 (Partition building: since 4.2.6)
+- Introduced in: 5.0 (Partition building: since 5.0)
- HTTP Body: JSON Object
- `project` - `required` `string`, project name.
@@ -179,7 +179,7 @@ curl -X POST \
- Curl Request Example
```sh
curl -X PUT \
- 'http://localhost:7070/kylin/api/snapshots' \
+ 'http://host:port/kylin/api/snapshots' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -208,7 +208,7 @@ curl -X PUT \
- `DELETE http://host:port/kylin/api/snapshots`
- Request Permission: OPERATION permission and above
-- Introduced in: 4.2.2
+- Introduced in: 5.0
- URL Parameters
- `project` - `required` `string`, project name.
- `tables` - `required` `array[string]`, snapshot tables to be deleted, for example：DB.TABLE, multiple tables are splitted by comma. Because the http protocol has a limit on the size of the request header, it is recommended that the length of url is less than 100.
@@ -219,7 +219,7 @@ curl -X PUT \
- Curl Request Example
```sh
curl -X DELETE \
- 'http://localhost:7070/kylin/api/snapshots?project=gc_test&tables=SSB.P_LINEORDER%2CDEFAULT.TEST_KYLIN_FACT' \
+ 'http://host:port/kylin/api/snapshots?project=gc_test&tables=SSB.P_LINEORDER%2CDEFAULT.TEST_KYLIN_FACT' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
@@ -254,7 +254,7 @@ curl -X DELETE \
- `GET http://host:port/kylin/api/snapshots`
- Request Permission: QUERY permission and above
-- Introduced in: 4.2.2
+- Introduced in: 5.0
- URL Parameters
- `project` - `required` `string`, project name.
- `table` - `optional` `string`, search key word. Default value is an empty string, will display all the snapshots.
@@ -269,7 +269,7 @@ curl -X DELETE \
- Curl Request Example
```sh
curl -X GET \
- 'http://localhost:7070/kylin/api/snapshots?project=gc_test' \
+ 'http://host:port/kylin/api/snapshots?project=gc_test' \
-H 'Accept: application/vnd.apache.kylin-v4-public+json' \
-H 'Accept-Language: en' \
-H 'Authorization: Basic QURNSU46S1lMSU4=' \
diff --git a/website/sidebars.js b/website/sidebars.js
index 922dd4badc..81f87a36ec 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -796,10 +796,10 @@ const sidebars = {
type: 'doc',
id: 'restapi/acl_api/project_acl_api'
},
- {
- type: 'doc',
- id: 'restapi/acl_api/acl_api'
- },
+ // {
+ // type: 'doc',
+ // id: 'restapi/acl_api/acl_api'
+ // },
],
},
{