管理台首页API

QueryRestfulApi 类

管理员验证

接口地址:/api/rest_j/v1/jobhistory/governanceStationAdmin

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

用来验证是否为管理员，如果是则返回true不是则false

请求参数:

暂无

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. data: {solution: null, admin: true}
3. message: "OK"
4. method: "/api/jobhistory/governanceStationAdmin"
5. status: 0
6. }

全局历史

接口地址:/api/rest_j/v1/jobhistory/list

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

根据条件获取全局历史数据列表默认获取全部

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
creator 创建者 query false string
endDate 结束时间 query false integer(int64)
executeApplicationName 操作人 query false string
isAdminView 是否为管理员模式或者普通模式 query false boolean
pageSize 页面数量 query false ref
proxyUser 代理用户 query false string
startDate 开始时间 query false integer(int64)
status 结束时间 query false string
taskID ID query false integer(int64)
tpageNow 页码 query false ref
pageNow pageNow query false integer(int32)

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. {
3. "method": "/api/jobhistory/list",
4. "status": 0,
5. "message": "OK",
6. "data": {
7. "solution": null,
8. "totalPage": 90,
9. "tasks": [{
10. "taskID": ,
11. "instance": ",
12. "execId": "",
13. "umUser": "",
14. "engineInstance": null,
15. "executionCode": "",
16. "progress": "",
17. "logPath": "",
18. "resultLocation": "",
19. "status": "",
20. "createdTime": ,
21. "updatedTime": ,
22. "engineType": "",
23. "errCode": 0,
24. "errDesc": "",
25. "executeApplicationName": "",
26. "requestApplicationName": "",
27. "runType": "datachecker",
28. "paramsJson": "",
29. "costTime": 1000,
30. "strongerExecId": "",
31. "sourceJson": "",
32. "sourceTailor": "",
33. "engineStartTime": null,
34. "labels": [],
35. "canRetry": ,
36. "subJobs":
37. }]
38. }
39. }
40. }

获取未完成任务列表

接口地址:/api/rest_j/v1/jobhistory/listundone

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

获取未完成任务列表

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
creator creator query false string
endDate 结束时间 query false integer(int64)
engineType engineType query false string
pageNow pageNow query false ref
pageSize pageSize query false ref
startDate 开始时间 query false ref
startTaskID startTaskID query false integer(int64)
status status query false string

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "data": {},
3. "message": "",
4. "method": "",
5. "status": 0
6. }

job任务详细记录

接口地址:/api/rest_j/v1/jobhistory/{id}/get

请求方式:GET

请求数据类型:application/x-www-form-urlencoded

响应数据类型:*/*

接口描述:

job任务详细记录

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
id 历史记录Id query false integer(int64)

响应状态:

状态码 说明 schema
200 OK Message
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
data 数据集 object
message 描述 string
method 请求url string
status 状态 integer(int32) integer(int32)

响应示例:

1. {
2. "method": "/api/jobhistory/1928730/get",
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "task": {
7. "taskID": ,
8. "instance": "",
9. "execId": "",
10. "umUser": "",
11. "engineInstance": "",
12. "executionCode": "",
13. "progress": "",
14. "logPath": "",
15. "resultLocation": "",
16. "status": "",
17. "createdTime":,
18. "updatedTime": ,
19. "engineType": "",
20. "errCode": ,
21. "errDesc": "",
22. "executeApplicationName": "",
23. "requestApplicationName": "",
24. "runType": "hql",
25. "paramsJson": "",
26. "costTime": ,
27. "strongerExecId": "",
28. "sourceJson": "",
29. "sourceTailor": "",
30. "engineStartTime": null,
31. "labels": [""],
32. "canRetry": false,
33. "subJobs": null
34. }
35. }
36. }