Apache Kylin : Analytical Data Warehouse for Big Data
Welcome to Kylin Wiki.
Resume Job
PUT /kylin/api/jobs/{jobId}/resume
Path variable
Variable name | Necessary | Type | Description |
---|---|---|---|
jobId | yes | string | Job id you want to resume |
Response Sample
Pause Job
PUT /kylin/api/jobs/{jobId}/pause
Path variable
Variable name | Necessary | Type | Description |
---|---|---|---|
jobId | yes | string | Job id you want to pause |
Response Sample
Discard Job
PUT /kylin/api/jobs/{jobId}/pause
Path variable
Variable name | Necessary | Type | Description |
---|---|---|---|
jobId | yes | string | Job id you want to discard |
Response Sample
Drop Job
DELETE /kylin/api/jobs/{jobId}/drop
Path variable
Variable name | Necessary | Type | Description |
---|---|---|---|
jobId | yes | string | Job id you want to delete |
Response Sample
Get Job Status
GET /kylin/api/jobs/{jobId}
Path variable
Variable name | Necessary | Type | Description |
---|---|---|---|
jobId | yes | string | Job id you want to check |
Response Sample
Get job step output
GET /kylin/api/jobs/{jobId}/steps/{stepId}/output
Path Variable
Variable name | Necessary | Type | Description |
---|---|---|---|
jobId | yes | string | Job id you want to check |
stepId | yes | string | 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-03” |
Response Sample
Get job list
GET /kylin/api/jobs
Request Variables
Variable name | Necessary | Type | Description |
---|---|---|---|
cubeName | yes | string | Cube name |
projectName | yes | string | Project name |
status | no | int | Job status, e.g. (NEW: 0, PENDING: 1, RUNNING: 2, STOPPED: 32, FINISHED: 4, ERROR: 8, DISCARDED: 16) |
offset | no | int | Offset used by pagination |
limit | no | int | Jobs per page |
timeFilter | no | 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
Get Job Status Overview
GET /kylin/api/jobs/overview
Request Variables
(Same as “Get job list”)
Response Sample
Overview
Content Tools
ThemeBuilder
Apps