Flink REST API 的使用

一、前言

    Flink有一个监视 API，可以用来查询正在运行的作业以及最近完成的作业的状态和统计信息。这个监视API由Flink自己的仪表板使用，但也被设计用于定制监视工具。

    监视API是一个REST-ful API，它接受HTTP请求并使用JSON数据进行响应。

    默认情况下，此服务器监听8081端口，可以在flink-conf.yaml中配置rest.port。注意，监视 API web服务器 和 web dashboard

web 服务器目前是运行在同一个端口上的。只不过，它们响应不同的HTTP url。

二、分析

REST API 位于 flink-runtime 项目中。核心类是org.apache.flink.runtime.webmonitor.WebMonitorEndpoint，用于设置服务器和请求路由。 

三、API接口使用

（1）修改flink-conf.yaml，开启 rest.port。端口可修改。

rest.port: 8081

（2）关闭集群

curl -X DELETE http://ip:8081/v1/config

（3）查看web ui 配置信息

curl http://ip:8081/v1/config

（4）查看通过web ui上传到集群的jar包

curl http://ip:8081/v1/jars

（5）查看JobManager的配置信息

curl http://ip:8081/v1/jobmanager/config

 （6）查看JobManager的监控指标信息

curl http://ip:8081/v1/jobmanager/metrics

（7）查看所有的任务以及状态

curl http://ip:8081/v1/jobs

（8）查看所有的任务概述信息

curl http://ip:8081/v1/jobs/overview

（9）查看某个任务的详细概述信息

curl http://ip:8081/v1/jobs/:jobid

curl http://ip:8081/v1/jobs/343334ef99303b5ab6c187f73e57572a

（10）查看某个任务的检查点统计信息

curl http://ip:8081/v1/jobs/:jobid/checkpoints

curl http://ip:8081/v1/jobs/343334ef99303b5ab6c187f73e57572a/checkpoints

（11）查看某个任务的检查点配置参数信息

curl http://ip:8081/v1/jobs/:jobid/checkpoints/config

curl http://ip:8081/v1/jobs/343334ef99303b5ab6c187f73e57572a/checkpoints/config

（12）查看某个任务的某个检查点的详细信息

curl http://ip:8081/v1/jobs/:jobid/checkpoints/details/:checkpointid

curl http://ip:8081/v1/jobs/343334ef99303b5ab6c187f73e57572a/checkpoints/details/1052

……

还有很多。具体可见 官网

【一起学习】