OpenAPI Specification
openapi: 3.0.3
info:
title: Apache Kylin REST Authentication Jobs API
description: REST API for Apache Kylin OLAP engine providing SQL queries, model management, cube management, job management, and project administration.
version: 5.0.0
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
contact:
email: dev@kylin.apache.org
servers:
- url: http://localhost:7070/kylin/api
description: Apache Kylin server
security:
- basicAuth: []
tags:
- name: Jobs
description: Build job management
paths:
/jobs:
get:
operationId: listJobs
summary: Apache kylin Apache Kylin List Jobs
description: List all build jobs optionally filtered by project and status.
tags:
- Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- name: projectName
in: query
schema:
type: string
example: learn_kylin
- name: status
in: query
schema:
type: integer
example: 0
description: Job status code (0=READY, 1=RUNNING, 2=ERROR, 4=STOPPED, 8=FINISHED, 32=DISCARDED)
- name: limit
in: query
schema:
type: integer
example: 20
- name: offset
in: query
schema:
type: integer
example: 0
responses:
'200':
description: List of jobs
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Job'
examples:
listJobs200Example:
summary: Default listJobs 200 response
x-microcks-default: true
value: {}
/jobs/{jobId}:
get:
operationId: getJob
summary: Apache kylin Apache Kylin Get Job
description: Get details of a specific build job.
tags:
- Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- name: jobId
in: path
required: true
schema:
type: string
example: job-1234
responses:
'200':
description: Job details
content:
application/json:
schema:
$ref: '#/components/schemas/Job'
examples:
getJob200Example:
summary: Default getJob 200 response
x-microcks-default: true
value:
uuid: job-1234
name: BUILD CUBE - kylin_sales_cube
type: BUILD
relatedCube: kylin_sales_cube
relatedSegment: segment-1234
status: FINISHED
submitTime: 1718153645993
duration: 120
mrWaiting: 10
/jobs/{jobId}/resume:
put:
operationId: resumeJob
summary: Apache kylin Apache Kylin Resume Job
description: Resume a paused or error build job.
tags:
- Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- name: jobId
in: path
required: true
schema:
type: string
example: job-1234
responses:
'200':
description: Job resumed
/jobs/{jobId}/cancel:
put:
operationId: cancelJob
summary: Apache kylin Apache Kylin Cancel Job
description: Cancel a running build job.
tags:
- Jobs
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
parameters:
- name: jobId
in: path
required: true
schema:
type: string
example: job-1234
responses:
'200':
description: Job cancelled
components:
schemas:
Job:
type: object
description: A Kylin build job
properties:
uuid:
type: string
example: job-1234
name:
type: string
example: BUILD CUBE - kylin_sales_cube
type:
type: string
example: BUILD
relatedCube:
type: string
example: kylin_sales_cube
relatedSegment:
type: string
example: segment-1234
status:
type: string
enum:
- READY
- RUNNING
- ERROR
- STOPPED
- FINISHED
- DISCARDED
example: FINISHED
submitTime:
type: integer
description: Submit time as Unix timestamp
example: 1718153645993
duration:
type: integer
description: Job duration in seconds
example: 120
mrWaiting:
type: integer
description: MapReduce waiting time
example: 10
securitySchemes:
basicAuth:
type: http
scheme: basic