Restful Api

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

1 Linkis接口规范

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

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

2 HTTP接口汇总

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

• 提交执行
• 获取状态
• 获取日志
• 获取进度
• Kill任务

3 接口详解

3.1 提交执行

• 接口 /api/rest_j/v1/entrance/execute
• 提交方式 POST

1. {
2. "method":"/api/rest_j/v1/entrance/execute",
3. "params": {
4. "variable":{
5. "k1":"v1"
6. },
7. "configuration":{
8. "special":{
9. "k2":"v2"
10. },
11. "runtime":{
12. "k3":"v3"
13. },
14. "startup":{
15. "k4":"v4"
16. }
17. }
18. },
19. "executeApplicationName":"spark",
20. "executionCode":"show tables",
21. "runType":"sql",
22. "source":{
23. "scriptPath": "/home/Linkis/Linkis.sql"
24. }
25. }

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

• 返回示例

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

3.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.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. }

3.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. }

3.5 kill任务

• 接口 /api/rest_j/v1/entrance/${execID}/kill
• 提交方式 GET
• 返回示例，其中返回的fromLine需要下次日志请求的参数

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

3.6 系统用户代理设置

• gateway代理设置

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

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

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

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

1. ```