常用的Flink Rest API接口使用

官方FlinkRestAPI文档

Flink接口调用地址

用户可以通过flink提供的RestAPI管理应用。RestAPI可供用户或脚本直接访问，它可以对外公开有关Flink集群和应用的信息。flink使用Web服务器来同时支持RestAPI和WebUI，该服务器会作为Dispatcher进程的一部分来运行。默认情况下二者都会使用8081端口。我们可以通过./conf/flink-conyaml来设置web服务器的ip和端口：rest.address，rest.port，同时为了避免我们提交的项目在每次集群启动时被删掉，我们需要配置项目的固定存储地址weuploadir，这样我们通过web提交的项目就会被保存到这个位置，如果不配置该地址，提交的项目会被放到临时文件中去，集群重启就会被删掉，很不方便。如下所示：

上传jar包

请求路径：http://1916193:8081/v1/jars/upload请求方式：POST请求参数：设置请求头application/java-archive返回结果：

{
       'status': 'success',
       'filename': 'a9ffd519-5222-40aa-9228-22464417a055_examples-java-1.0.jar'
}

请求实例：

或者可以使用Flink的webui页面自己提交项目程序：

获取提交的项目id

请求路径：http://1916193:8081/v1/jars请求方式：GET请求参数：无返回结果：

{
    'address': 'http://0.0.0.0:8081',
    'files': [
        {
            'id': 'a9ffd519-5222-40aa-9228-22464417a055_examples-java-1.0.jar',
            'name': 'examples-java-1.0.jar',
            'uploaded': 1590635755000,
            'entry': []
        }
    ]
}

运行程序接口

请求路径：http://1916193:8081/v1/jars/项目id/run?entry-class=xxxx&program-args=xxxx请求方式：POST请求参数：

返回结果：jobid

请求示例

1、http://192.168.196.3:8081/jars/a9ffd519-5222-40aa-9228-22464417a055_examples-java-1.0.jar/run?entry-class=io.github.streamingwithflink.demo.BatchCountFromJdbc&programArgsList=--bootstrap.servers hadoop2.test.yunwei.puppet.dh:6667,hadoop3.test.yunwei.puppet.dh:6667,hadoop4.test.yunwei.puppet.dh:6667 --group.id m3gcn_tab_map_race_3 --client.id m3gcn_tab_map_race_3 --config.file hdfs://DHTestCluster/user/gezhihui/flink/configuration/m3gcn_tab_map_race2.txt --job.name m3gcn_tab_map_race
2、http://192.168.196.3:8081/jars/a9ffd519-5222-40aa-9228-22464417a055_examples-java-1.0.jar/run
{
    'entryClass':'io.github.streamingwithflink.demo.BatchCountFromJdbc'
    'programArgsList': [
        '--name',
        'zhansan']
}

请求体中的programArgsList可以传值到main函数的string[]args，取值可以通过ParameterTool parameters = 
ParameterTool.fromArgs(args);String name = parameters.get('name');所以他的key-value的格式是key为'--key'或者'-key',
value为key的下一行，根据上述代码，value不要以'-'作为开头，这里也可以自己去解析String[]，这里args就对应我们programArgsList
的传参，如3所示

3、http://192.168.196.3:8081/jars/a9ffd519-5222-40aa-9228-22464417a055_examples-java-1.0.jar/run
{
    'entryClass':'io.github.streamingwithflink.demo.BatchCountFromJdbc'
    'programArgsList': [
        'lisi',
        'zhansan']
}

请求示例