任务提交执行 Rest API 文档

• Linkis Restful接口的返回，都遵循以下的标准返回格式：

• method：返回请求的Restful API URI，主要是 WebSocket 模式需要使用。
• status：返回状态信息，其中：-1表示没有登录，0表示成功，1表示错误，2表示验证失败，3表示没该接口的访问权限。
• data：返回具体的数据。
• message：返回请求的提示信息。如果status非0时，message返回的是错误信息，其中data有可能存在stack字段，返回具体的堆栈信息。

更多关于 Linkis Restful 接口的规范，请参考：Linkis Restful 接口规范

• 接口

• 提交方式 POST

{
    "executeApplicationName": "hive", //引擎类型
    "requestApplicationName": "dss", //客户端服务类型
    "executionCode": "show tables",
    "params": {"variable": {}, "configuration": {}},
    "runType": "hql", //运行的脚本类型
   "source": {"scriptPath":"file:///tmp/hadoop/1.hql"}
}

• 提交方式 POST

• 返回示例

{
 "method": "/api/rest_j/v1/entrance/execute",
 "status": 0,
 "message": "请求执行成功",
   "execID": "030418IDEhivebdpdwc010004:10087IDE_hadoop_21",
   "taskID": "123"  
 }
}

• taskID 是表示用户提交task的唯一ID，这个ID由数据库自增生成，为 Long 类型

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

• 提交方式 GET

• 返回示例

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

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

• 返回示例，其中返回的fromLine需要作为下次请求该接口的参数

  "method": "/api/rest_j/v1/entrance/${execID}/log",
  "status": 0,
  "message": "返回日志信息",
  "data": {
    "execID": "${execID}",
    "fromLine": 56
  }
}

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

• 提交方式 GET

• 返回示例

• 提交方式 GET

{
 "method": "/api/rest_j/v1/entrance/{execID}/kill",
 "status": 0,
 "message": "OK",
 "data": {
   "execID":"${execID}"
}