• 1.Linkis接口规范
  • 2.HTTP接口汇总
    • 3.接口详解
    • 1).提交执行
    • 2).获取状态
    • 3).获取日志
    • 4).获取进度
    • 5).kill任务
    • 6)系统用户代理设置

    Linkis 提供了方便的HTTP接口方便前端上层应用或者后台通过Restful接口进行调用

    1.Linkis接口规范

    Linkis在前后端进行交互的时候，定义了一套自己的接口规范。

    如果您对接口规范感兴趣，请点击这里查看接口规范

    2.HTTP接口汇总

    我们提供以下几个接口，方便用户快速提交执行Job，获取执行结果。

    • 提交执行

    • 获取状态

    • 获取日志

    • 获取进度

    • Kill任务

    3.接口详解

    1).提交执行

    • 接口 /api/rest_j/entrance/execute

    • 提交方式 POST

    1. {
    2.      "method":"/api/rest_j/v1/entrance/execute",
    3.      "data":{
    4.         "params": {
    5.             "variable":{
    6.                 "k1":"v1"
    7.             },
    8.             "configuration":{
    9.                 "special":{
    10.                     "k2":"v2"
    11.                 },
    12.                 "runtime":{
    13.                     "k3":"v3"
    14.                 },
    15.                 "startup":{
    16.                     "k4":"v4"
    17.                 }
    18.             }
    19.         },
    20.         "executeApplicationName":"spark",
    21.         "executionCode":"show tables",
    22.         "runType":"sql",
    23.         "source":{
    24.             "scriptPath": "/home/Linkis/Linkis.sql"
    25.         },
    26.     "websocketTag":"37fcbd8b762d465a0c870684a0261c6e"
    27.     }
    28. }
    • 请求体data中的参数描述如下
    参数名 参数定义 类型 备注
    executeApplicationName 用户所期望使用的引擎服务，如Spark、hive等 String 不可为空
    requestApplicationName 发起请求的系统名 String 可以为空
    params 用户指定的运行服务程序的参数 Map 必填，里面的值可以为空
    executionCode 用户提交的执行代码 String 不可为空
    runType 当用户执行如spark服务时，可以选择python、R、SQL等runType String 不可为空
    scriptPath 用户提交代码脚本的存放路径 String 如果是IDE的话，与executionCode不能同时为空 
    1.                                     表1 请求体参数描述
    • 返回示例
    1. {
    2.  "method": "/api/rest_j/v1/entrance/execute",
    3.  "status": 0,
    4.  "message": "请求执行成功",
    5.  "data": {
    6.    "execID": "030418IDEhivebdpdwc010004:10087IDE_johnnwang_21",
    7.    "taskID": "123"  
    8.  }
    9. }
    • execID是用户任务提交到UJES之后，为该任务生成的唯一标识的执行ID，为String类型，这个ID只在任务运行时有用，类似PID的概念。ExecID的设计为(requestApplicationName长度)(executeAppName长度1)(Instance长度2)${requestApplicationName}${executeApplicationName}${entranceInstance信息ip+port}${requestApplicationName}${umUser}${index}
    • taskID 是表示用户提交task的唯一ID，这个ID由数据库自增生成，为Long 类型

    2).获取状态

    • 接口 /api/rest_j/entrance/${execID}/status

    • 提交方式 GET

    • 返回示例

    1. {
    2.  "method": "/api/rest_j/v1/entrance/{execID}/status",
    3.  "status": 0,
    4.  "message": "获取状态成功",
    5.  "data": {
    6.    "execID": "${execID}",
    7.    "status": "Running"
    8.  }
    9. }

    3).获取日志

    • 接口 /api/rest_j/entrance/${execID}/log?fromLine=${fromLine}&size=${size}

    • 提交方式 GET

    • 请求参数fromLine是指从第几行开始获取，size是指该次请求获取几行日志

    • 返回示例，其中返回的fromLine需要下次日志请求的参数

    1. {
    2.   "method": "/api/rest_j/v1/entrance/${execID}/log",
    3.   "status": 0,
    4.   "message": "返回日志信息",
    5.   "data": {
    6.     "execID": "${execID}",
    7.     "log": ["error日志","warn日志","info日志", "all日志"],
    8.     "fromLine": 56
    9.   }
    10. }

    4).获取进度

    • 接口 /api/rest_j/entrance/${execID}/progress

    • 提交方式 GET

    • 返回示例

    1. {
    2.   "method": "/api/rest_j/v1/entrance/{execID}/progress",
    3.   "status": 0,
    4.   "message": "返回进度信息",
    5.   "data": {
    6.     "execID": "${execID}",
    7.     "progress": 0.2,
    8.     "progressInfo": [
    9.         {
    10.             "id": "job-1",
    11.             "succeedTasks": 2,
    12.             "failedTasks": 0,
    13.             "runningTasks": 5,
    14.             "totalTasks": 10
    15.         },
    16.         {
    17.             "id": "job-2",
    18.             "succeedTasks": 5,
    19.             "failedTasks": 0,
    20.             "runningTasks": 5,
    21.             "totalTasks": 10
    22.         }
    23.     ]
    24.   }
    25. }

    5).kill任务

    • 接口 /api/rest_j/entrance/${execID}/kill

    • 提交方式 POST

    • 返回示例，其中返回的fromLine需要下次日志请求的参数

    1. {
    2.  "method": "/api/rest_j/v1/entrance/{execID}/kill",
    3.  "status": 0,
    4.  "message": "OK",
    5.  "data": {
    6.    "execID":"${execID}"
    7.   }
    8. }

    6)系统用户代理设置

    • gateway代理设置

      在gateway安装目录conf中修改proxy.properties文件，添加内容： token=user1,user2

      说明：token为给到系统用户的秘钥，右边为系统用户可以代理的其它用户，如token=*，则不限制用户。

    • http请求代理设置

      在请求的Headers参数中添加两个参数设置

      1.   Proxy-User = 代理用户xxx
      2.   Validation-Code = gateway配置的系统token