/blobserver/port | |
Verb: GET |
Response code: 200 OK |
Returns the port of blob server which can be used to upload jars. | |
|
|
|
/cluster | |
Verb: DELETE |
Response code: 200 OK |
Shuts down the cluster | |
|
|
|
/config | |
Verb: GET |
Response code: 200 OK |
Returns the configuration of the WebUI. | |
|
|
|
/jars | |
Verb: GET |
Response code: 200 OK |
Returns a list of all jars previously uploaded via '/jars/upload'. | |
|
|
|
/jars/upload | |
Verb: POST |
Response code: 200 OK |
Uploads a jar to the cluster. The jar must be sent as multi-part data. Make sure that the "Content-Type" header is set to "application/x-java-archive", as some http libraries do not add the header by default. Using 'curl' you can upload a jar via 'curl -X POST -H "Expect:" -F "jarfile=#path/to/flink-job.jar" http://hostname:port/jars/upload'. | |
|
|
|
/jars/:jarid | |
Verb: DELETE |
Response code: 200 OK |
Deletes a jar previously uploaded via '/jars/upload'. | |
Path parameters | |
|
|
|
|
|
/jars/:jarid/plan | |
Verb: GET |
Response code: 200 OK |
Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jars/:jarid/run | |
Verb: POST |
Response code: 200 OK |
Submits a job by running a jar previously uploaded via '/jars/upload'. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobmanager/config | |
Verb: GET |
Response code: 200 OK |
Returns the cluster configuration. | |
|
|
|
/jobmanager/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to job manager metrics. | |
Query parameters | |
|
|
|
|
|
/jobs | |
Verb: GET |
Response code: 200 OK |
Returns an overview over all jobs and their current state. | |
|
|
|
/jobs | |
Verb: POST |
Response code: 202 Accepted |
Submits a job. This call is primarily intended to be used by the Flink client. | |
|
|
|
/jobs/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to aggregated job metrics. | |
Query parameters | |
|
|
|
|
|
/jobs/overview | |
Verb: GET |
Response code: 200 OK |
Returns an overview over all jobs. | |
|
|
|
/jobs/:jobid | |
Verb: GET |
Response code: 200 OK |
Returns details of a job. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid | |
Verb: PATCH |
Response code: 202 Accepted |
Terminates a job. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/accumulators | |
Verb: GET |
Response code: 200 OK |
Returns the accumulators for all tasks of a job, aggregated across the respective subtasks. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/checkpoints | |
Verb: GET |
Response code: 200 OK |
Returns checkpointing statistics for a job. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/checkpoints/config | |
Verb: GET |
Response code: 200 OK |
Returns the checkpointing configuration. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/checkpoints/details/:checkpointid | |
Verb: GET |
Response code: 200 OK |
Returns details for a checkpoint. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid | |
Verb: GET |
Response code: 200 OK |
Returns checkpoint statistics for a task and its subtasks. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/config | |
Verb: GET |
Response code: 200 OK |
Returns the configuration of a job. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/exceptions | |
Verb: GET |
Response code: 200 OK |
Returns the non-recoverable exceptions that have been observed by the job. The truncated flag defines whether more exceptions occurred, but are not listed, because the response would otherwise get too big. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/execution-result | |
Verb: GET |
Response code: 200 OK |
Returns the result of a job execution. Gives access to the execution time of the job and to all accumulators created by this job. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to job metrics. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/plan | |
Verb: GET |
Response code: 200 OK |
Returns the dataflow plan of a job. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/rescaling | |
Verb: PATCH |
Response code: 200 OK |
Triggers the rescaling of a job. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/rescaling/:triggerid | |
Verb: GET |
Response code: 200 OK |
Returns the status of a rescaling operation. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/savepoints | |
Verb: POST |
Response code: 202 Accepted |
Triggers a savepoint, and optionally cancels the job afterwards. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/savepoints/:triggerid | |
Verb: GET |
Response code: 200 OK |
Returns the status of a savepoint operation. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid | |
Verb: GET |
Response code: 200 OK |
Returns details for a task, with a summary for each of its subtasks. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/accumulators | |
Verb: GET |
Response code: 200 OK |
Returns user-defined accumulators of a task, aggregated across all subtasks. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/accumulators | |
Verb: GET |
Response code: 200 OK |
Returns user-defined accumulators of a task, aggregated across all subtasks. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/backpressure | |
Verb: GET |
Response code: 200 OK |
Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to task metrics. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/subtasks/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to aggregated subtask metrics. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex | |
Verb: GET |
Response code: 200 OK |
Returns details of the current or latest execution attempt of a subtask. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt | |
Verb: GET |
Response code: 200 OK |
Returns details of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators | |
Verb: GET |
Response code: 200 OK |
Returns the accumulators of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to subtask metrics. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/subtasktimes | |
Verb: GET |
Response code: 200 OK |
Returns time-related information for all subtasks of a task. | |
Path parameters | |
|
|
|
|
|
/jobs/:jobid/vertices/:vertexid/taskmanagers | |
Verb: GET |
Response code: 200 OK |
Returns task information aggregated by task manager. | |
Path parameters | |
|
|
|
|
|
/overview | |
Verb: GET |
Response code: 200 OK |
Returns an overview over the Flink cluster. | |
|
|
|
/savepoint-disposal | |
Verb: POST |
Response code: 200 OK |
Triggers the desposal of a savepoint. | |
|
|
|
/savepoint-disposal/:triggerid | |
Verb: GET |
Response code: 200 OK |
Returns the status of a savepoint disposal operation. | |
Path parameters | |
|
|
|
|
|
/taskmanagers | |
Verb: GET |
Response code: 200 OK |
Returns an overview over all task managers. | |
|
|
|
/taskmanagers/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to aggregated task manager metrics. | |
Query parameters | |
|
|
|
|
|
/taskmanagers/:taskmanagerid | |
Verb: GET |
Response code: 200 OK |
Returns details for a task manager. | |
Path parameters | |
|
|
|
|
|
/taskmanagers/:taskmanagerid/metrics | |
Verb: GET |
Response code: 200 OK |
Provides access to task manager metrics. | |
Path parameters | |
|
|
Query parameters | |
|
|
|
|
|