任务提交执行 Rest API 文档

  • Linkis Restful接口的返回，都遵循以下的标准返回格式：
1. {
2. "method": "",
3. "status": 0,
4. "message": "",
5. "data": {}
6. }

约定：

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

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

1. 提交执行

  • 接口 /api/rest_j/v1/entrance/execute
  • 提交方式 POST
1. {
2. "executeApplicationName": "hive", //引擎类型
3. "requestApplicationName": "dss", //客户端服务类型
4. "executionCode": "show tables",
5. "params": {"variable": {}, "configuration": {}},
6. "runType": "hql", //运行的脚本类型
7. "source": {"scriptPath":"file:///tmp/hadoop/1.hql"}
8. }
  • 接口 /api/rest_j/v1/entrance/submit
  • 提交方式 POST
1. {
2. "executionContent": {"code": "show tables", "runType":  "sql"},
3. "params": {"variable": {}, "configuration": {}},
4. "source":  {"scriptPath": "file:///mnt/bdp/hadoop/1.hql"},
5. "labels": {
6. "engineType": "spark-2.4.3",
7. "userCreator": "hadoop-IDE"
8. }
9. }
  • 返回示例
1. {
2. "method": "/api/rest_j/v1/entrance/execute",
3. "status": 0,
4. "message": "请求执行成功",
5. "data": {
6. "execID": "030418IDEhivebdpdwc010004:10087IDE_hadoop_21",
7. "taskID": "123"
8. }
9. }
  • execID是用户任务提交到 Linkis 之后，为该任务生成的唯一标识执行ID，为 String 类型，这个ID只在任务运行时有用，类似PID的概念。ExecID 的设计为(requestApplicationName长度)(executeAppName长度)(Instance长度)${requestApplicationName}${executeApplicationName}${entranceInstance信息ip+port}${requestApplicationName}_${umUser}_${index}
  • taskID 是表示用户提交task的唯一ID，这个ID由数据库自增生成，为 Long 类型

2. 获取状态

  • 接口 /api/rest_j/v1/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/v1/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/v1/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/v1/entrance/${execID}/kill
  • 提交方式 GET
1. {
2. "method": "/api/rest_j/v1/entrance/{execID}/kill",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "execID":"${execID}"
7. }
8. }