Ballista Scheduler

REST API

The scheduler also provides a REST API that allows jobs to be monitored.

This is optional scheduler feature which should be enabled with the rest-api feature.

API	Method	Description
/api/jobs	GET	Get a list of jobs that have been submitted to the cluster.
/api/job/{job_id}	GET	Get a summary of a submitted job.
/api/job/{job_id}/dot	GET	Produce a query plan in DOT (graphviz) format.
/api/job/{job_id}/dot_svg	GET	Produce a query plan in SVG format. (graphviz-support required)
/api/job/{job_id}	PATCH	Cancel a currently running job
/api/job/{job_id}/config	GET	Get session configuration for a job.
/api/job/{job_id}/stage/{stage_id}/dot	GET	Produces stage plan in DOT (graphviz) format
/api/metrics	GET	Return current scheduler metric set

Web TUI Configuration

When the Scheduler is built with the rest-api feature, several command-line options control its integration with the Web TUI:

Option	Description
--web-tui-route	HTTP path that redirects to the hosted Web TUI. The default route is /.
--cors-allowed-origins	Comma-separated list of allowed CORS origins. By default, http://localhost:8080 and https://nightlies.apache.org are allowed.
--cors-allowed-methods	Comma-separated list of allowed CORS methods. By default, GET, PATCH, and OPTIONS are allowed.

For example, to expose the Web TUI redirect at http://localhost:50050/tui:

ballista-scheduler --web-tui-route /tui

The CORS options can be customized when hosting the Web TUI from another origin.