The Replica Query Server has a number of endpoints for accessing the information about a running Onyx cluster. Below we display the HTTP method, the URI, the docstring for the route, and any associated parameters that it takes in its query string.
/job/catalog/job/flow-conditions/job/lifecycles/job/task/job/triggers/job/windows/job/workflow/replica/replica/completed-jobs/replica/job-allocations/replica/job-scheduler/replica/jobs/replica/killed-jobs/replica/peer-site/replica/peer-state/replica/peers/replica/task-allocations/replica/task-scheduler/replica/tasks[:get] /job/catalog
{"job-id" java.lang.String}
Given a job id, returns catalog for this job.
[:get] /job/flow-conditions
{"job-id" java.lang.String}
Given a job id, returns flow conditions for this job.
[:get] /job/lifecycles
{"job-id" java.lang.String}
Given a job id, returns lifecycles for this job.
[:get] /job/task
{"job-id" java.lang.String, "task-id" java.lang.String}
Given a job id and task id, returns catalog entry for this task.
[:get] /job/triggers
{"job-id" java.lang.String}
Given a job id, returns triggers for this job.
[:get] /job/windows
{"job-id" java.lang.String}
Given a job id, returns windows for this job.
[:get] /job/workflow
{"job-id" java.lang.String}
Given a job id, returns workflow for this job.
[:get] /replica
``
Derefences the replica as an immutable value.
[:get] /replica/completed-jobs
``
Lists all the job ids that have been completed.
[:get] /replica/job-allocations
``
Returns a map of job id -> task id -> peer ids, denoting which peers are assigned to which tasks.
[:get] /replica/job-scheduler
``
Returns the job scheduler for this tenancy of the cluster.
[:get] /replica/jobs
``
Lists all non-killed, non-completed job ids.
[:get] /replica/killed-jobs
``
Lists all the job ids that have been killed.
[:get] /replica/peer-site
{"peer-id" java.lang.String}
Given a peer id, returns the Aeron hostname and port that this peer advertises to the rest of the cluster.
[:get] /replica/peer-state
{"peer-id" java.lang.String}
Given a peer id, returns its current execution state (e.g. :idle, :active, etc).
[:get] /replica/peers
``
Lists all the peer ids.
[:get] /replica/task-allocations
``
Given a job id, returns a map of task id -> peer ids, denoting which peers are assigned to which tasks for this job only.
[:get] /replica/task-scheduler
{"job-id" java.lang.String}
Given a job id, returns the task scheduler for this job.
[:get] /replica/tasks
{"job-id" java.lang.String}
Given a job id, returns all the task ids for this job.
Can you improve this documentation?Edit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |