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

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

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

• 服务端主动推回状态、日志和进度

此接口是为了和Linkis建立一个WebSocket连接。

• 请求方式 GET

请求执行任务是将用户的作业提交到Linkis进行执行的接口

• 接口 /api/rest_j/entrance/execute

• 提交方式 POST

• 请求JSON示例

• 请求体data中的参数描述如下

                                    表1 请求体参数描述

• 返回示例

• 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 类型

服务器主动推送的内容如下：

{
  "method": "/api/rest_j/v1/entrance/${execID}/log",
  "status": 0,
  "message": "返回日志信息",
  "data": {
    "execID": "${execID}",
    "log": ["error日志","warn日志","info日志", "all日志"],
  "taskID":28594,
    "fromLine": 56
  },
}

• 状态

• 进度

{
  "method": "/api/rest_j/v1/entrance/${execID}/log",
  "status": 0,
  "message": "返回进度信息信息",
  "data": {
    "taskID":28594,
    "progress": 0.2,
      "progressInfo": [
          {
              "id": "job-1",
              "succeedTasks": 2,
              "runningTasks": 5,
              "totalTasks": 10
          },
          {
              "id": "job-2",
              "succeedTasks": 5,
              "failedTasks": 0,
              "runningTasks": 5,
              "totalTasks": 10
          }
      ]
  },