API endpoint mapping¶
In the client implementation, the API end points are categorized based on their functionality:
cluster level: API endpoints for managing the whole cluster.
jobmanager: API endpoints for managing the job manager(s).
taskmanager: API endpoints for managing the taskmanagers.
jars: API endpoints for managing the uploaded jars.
jobs: API endpoints for managing the submitted jobs.
You can find the original REST API documentation here: REST API documentation
In the following sections we provide the REST API endpoint -> python method mapping.
from flink_rest_client import FlinkRestClient
rest_client = FlinkRestClient.get(host="localhost", port=8082)
Cluster level¶
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/overview |
GET |
rest_client.overview |
/config |
GET |
rest_client.config |
/cluster |
DELETE |
rest_client.delete_cluster |
/datasets |
GET |
rest_client.datasets |
/datasets/:datasetid |
DELETE |
rest_client.delete_dataset |
Jobmanager¶
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/jobmanager/config |
GET |
rest_client.jobmanager.config |
/jobmanager/logs |
GET |
rest_client.jobmanager.logs |
/jobmanager/logs/:log_file |
GET |
rest_client.jobmanager.get_log |
/jobmanager/metrics |
GET |
rest_client.jobmanager.metrics |
Note
The [GET] /jobmanager/logs/:log_file end point is not part of the official API documentation.
Taskmanager¶
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/taskmanagers |
GET |
rest_client.taskmanager.all |
/taskmanagers/metrics |
GET |
rest_client.taskmanager.metrics |
/taskmanagers/:taskmanagerid |
GET |
rest_client.taskmanager.get |
/taskmanagers/:taskmanagerid/logs |
GET |
rest_client.taskmanager.get_logs |
/taskmanagers/:taskmanagerid/metrics |
GET |
rest_client.taskmanager.get_metrics |
/taskmanagers/:taskmanagerid/thread-dump |
GET |
rest_client.taskmanager.get_thread_dump |
Jars¶
Note
We also provided the rest_client.jars.upload_and_run helper method to upload and start a jar in one method call.
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/jars |
GET |
rest_client.jars.all |
/jars/upload |
POST |
rest_client.jars.upload |
/jars/:jarid/plan |
POST |
rest_client.jars.get_plan |
/jars/:jarid/run |
POST |
rest_client.jars.run |
/jars/:jarid |
DELETE |
rest_client.jars.delete |
Jobs¶
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/jobs |
GET |
rest_client.jobs.all |
/jobs/overview |
GET |
rest_client.jobs.overview |
/jobs/metrics |
GET |
rest_client.jobs.metrics |
/jobs/:jobid |
GET |
rest_client.jobs.get |
/jobs/:jobid/config |
GET |
rest_client.jobs.get_config |
/jobs/:jobid/exceptions |
GET |
rest_client.jobs.get_exceptions |
/jobs/:jobid/execution-result |
GET |
rest_client.jobs.get_execution_results |
/jobs/:jobid/metrics |
GET |
rest_client.jobs.get_metrics |
/jobs/:jobid/plan |
GET |
rest_client.jobs.get_plan |
/jobs/:jobid/accumulators |
GET |
rest_client.jobs.get_accumulators |
/jobs/:jobid/checkpoints/config |
GET |
rest_client.jobs.get_checkpointing_configuration |
/jobs/:jobid/checkpoints |
GET |
rest_client.jobs.get_checkpoints |
/jobs/:jobid/checkpoints/details/:checkpointid |
GET |
rest_client.jobs.get_checkpoint_details |
/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid |
GET |
rest_client.jobs.get_checkpoint_details |
/jobs/:jobid/rescaling |
GET |
rest_client.jobs.rescale |
/jobs/:jobid/savepoints |
GET |
rest_client.jobs.create_savepoint |
/jobs/:jobid |
PATCH |
rest_client.jobs.terminate |
/jobs/:jobid/stop |
GET |
rest_client.jobs.stop |
Information about jobs’ vertices can be queried via rest_client.jobs.get_vertex:
from flink_rest_client import FlinkRestClient
rest_client = FlinkRestClient.get(host="localhost", port=8082)
# We already uploaded and started a job and we also received a valid job_id
job_id = rest_client.jars.upload_and_run(path_to_jar=path_to_my_jar)
# Listing the vertex ids that belongs to the job.
job_vertex_ids = rest_client.jobs.get_vertex_ids(job_id=job_id)
# Getting the first job_vertex via get_vertex method
job_vertex = rest_client.jobs.get_vertex(job_id=job_id, vertex_id=job_vertex_ids[0])
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/jobs/:jobid/vertices/:vertexid |
GET |
job_vertex.details |
/jobs/:jobid/vertices/:vertexid/backpressure |
GET |
job_vertex.backpressure |
/jobs/:jobid/vertices/:vertexid/metrics |
GET |
job_vertex.metrics |
/jobs/:jobid/vertices/:vertexid/subtasktimes |
GET |
job_vertex.subtasktimes |
/jobs/:jobid/vertices/:vertexid/taskmanagers |
GET |
job_vertex.taskmanagers |
/jobs/:jobid/vertices/:vertexid/watermarks |
GET |
job_vertex.watermarks |
The job vertex substasks are accessible via job_vertex.subtasks property:
REST API endpoint |
HTTP method |
Python method |
|---|---|---|
/jobs/:jobid/vertices/:vertexid/accumulators |
GET |
job_vertex.subtasks.accumulators |
/jobs/:jobid/vertices/:vertexid/subtasks/metrics |
GET |
job_vertex.subtasks.metrics |
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex |
GET |
job_vertex.subtasks.get |
/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt |
GET |
job_vertex.subtasks.get_attempt |
/jobs/:jobid/vertices/:vertexid/subtasks/accumulators |
GET |
job_vertex.subtasks.get_attempt_accumulators |