Admin Console Home Page Interface

Admin Console Home Page Interface

QueryRestfulApi class

admin authentication

Interface address:/api/rest_j/v1/jobhistory/governanceStationAdmin

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Used to verify whether it is an administrator, if it is, it will return true if it is not false

Request Parameters:

Response Status:

Status code	Description	schema
200	OK	Message
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters:

parameter name	parameter description	type	schema
data	Dataset	object
message	Description	string
method	request url	string
status	Status	integer(int32)	integer(int32)

Sample Response:

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

global history

Interface address:/api/rest_j/v1/jobhistory/list

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Acquire global historical data list according to conditions and get all by default

Request Parameters:

Parameter name	Parameter description	Request type	Required	Data type
creator	Creator	query	false	string
endDate	End time	query	false	integer(int64)
executeApplicationName	operator	query	false	string
isAdminView	Whether it is in administrator mode or normal mode	query	false	boolean
pageSize	Number of pages	query	false	ref
proxyUser	Proxy User	query	false	string
startDate	Start time	query	false	integer(int64)
status	end time	query	false	string
taskID	ID	query	false	integer(int64)
tpageNow	page number	query	false	ref
pageNow	pageNow	query	false	integer(int32)

Response Status:

Status code	Description	schema
200	OK	Message
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters:

parameter name	parameter description	type	schema
data	Dataset	object
message	Description	string
method	request url	string
status	Status	integer(int32)	integer(int32)

Sample Response:

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

list undo

Interface address:/api/rest_j/v1/jobhistory/listundone

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Undo list

Request Parameters:

Parameter name	Parameter description	Request type	Required	Data type
creator	creator	query	false	string
endDate	End time	query	false	integer(int64)
engineType	engineType	query	false	string
pageNow	pageNow	query	false	ref
pageSize	pageSize	query	false	ref
startDate	Start time	query	false	ref
startTaskID	startTaskID	query	false	integer(int64)
status	status	query	false	string

Response Status:

Status code	Description	schema
200	OK	Message
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters:

parameter name	parameter description	type	schema
data	Dataset	object
message	Description	string
method	request url	string
status	Status	integer(int32)	integer(int32)

Sample Response:

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

History details

Interface address:/api/rest_j/v1/jobhistory/{id}/get

Request method: GET

Request data type: application/x-www-form-urlencoded

Response data type: */*

Interface description:

Get the detailed information of a history through the history ID

Request Parameters:

Parameter name	Parameter description	Request type	Required	Data type	schema
id	HistoryId	query	false	integer(int64)

Response Status:

Status code	Description	schema
200	OK	Message
401	Unauthorized
403	Forbidden
404	Not Found

Response parameters:

parameter name	parameter description	type	schema
data	Dataset	object
message	Description	string
method	request url	string
status	Status	integer(int32)	integer(int32)

Sample Response:

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