Resource Management
RMMonitorRest class
All user resources
Interface address:/api/rest_j/v1/linkisManager/rm/allUserResource
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
All user resources
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| creator | creator | query | false | string | |
| engineType | engineType | query | false | string | |
| page | page | query | false | integer(int32) | |
| size | size | query | false | integer(int32) | |
| username | username | 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. "method": null,
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "total": 34,
7. "resources": [{
8. "id": ,
9. "username": "",
10. "creator": "",
11. "engineTypeWithVersion": "",
12. "resourceType": "",
13. "maxResource": {
14. "memory": ,
15. "cores": ,
16. "instance":
17. },
18. "minResource": {
19. "memory": ,
20. "cores": "instance": 0
21. },
22. "usedResource": {
23. "memory": ,
24. "cores": ,
25. "instance":
26. },
27. "lockedResource": {
28. "memory": 0,
29. "cores": 0,
30. "instance": 0
31. },
32. "expectedResource": null,
33. "leftResource": {
34. "memory": ,
35. "cores": ,
36. "instance":
37. },
38. "createTime": ,
39. "updateTime": ,
40. "loadResourceStatus": "",
41. "queueResourceStatus":
42. }]
43. }
44. }
Application List
Interface address: /api/rest_j/v1/linkisManager/rm/applicationlist
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
Get the list of application engines in resource management
Request example:
1. {
2. userCreator: ""
3. }
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| userCreator | userCreator | query | true | String |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 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": ,
3. "status": ,
4. "message": "",
5. "data": {
6. "applications": [{
7. "creator": "",
8. "applicationList": {
9. "usedResource": {
10. "memory": ,
11. "cores": ,
12. "instance":
13. },
14. "maxResource": {
15. "memory": ,
16. "cores": ,
17. "instance":
18. },
19. "lockedResource": {
20. "memory": ,
21. "cores": ,
22. "instance":
23. },
24. "minResource": {
25. "memory": ,
26. "cores": ,
27. "instance":
28. },
29. "engineInstances": [{
30. "resource": {
31. "resourceType": "",
32. "maxResource": {
33. "memory": ,
34. "cores": ,
35. "instance":
36. },
37. "minResource": {
38. "memory": ,
39. "cores": ,
40. "instance":
41. },
42. "usedResource": {
43. "memory": ,
44. "cores": ,
45. "instance":
46. },
47. "lockedResource": {
48. "memory": ,
49. "cores": ,
50. "instance":
51. },
52. "expectedResource": null,
53. "leftResource": {
54. "memory": ,
55. "cores": ,
56. "instance":
57. }
58. },
59. "engineType": "",
60. "owner": "",
61. "instance": "",
62. "creator": "",
63. "startTime": "",
64. "status": "",
65. "label": ""
66. }]
67. }
68. }]
69. }
70. }
EngineType
Interface address: /api/rest_j/v1/linkisManager/rm/engineType
Request method: GET
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface Description:
Engine Type
Request Parameters:
No
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. }
Engine manager
Interface address: /api/rest_j/v1/linkisManager/rm/engines
Request method: POST
Request data type: application/json
Response data type: */*
Interface Description:
Engine Manager
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| param | param | body | false | object |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 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. }
queue manager
Interface address: /api/rest_j/v1/linkisManager/rm/queueresources
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
Queue Manager
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| param | param | body | true | object |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 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. }
queue
Interface address: /api/rest_j/v1/linkisManager/rm/queues
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
Queue
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| param | param | body | false | object |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 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. }
reset resources
Interface address:/api/rest_j/v1/linkisManager/rm/resetResource
Request method: DELETE
Request data type: application/x-www-form-urlencoded
Response data type: */*
Interface description:
Reset resources
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| resourceId | resourceId | query | false | integer(int32) |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 204 | No Content | |
| 401 | Unauthorized | |
| 403 | Forbidden |
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. }
Resource information
Interface address: /api/rest_j/v1/linkisManager/rm/userresources
Request method: POST
Request data type: application/json
Response data type: */*
Interface description:
Query resource list and detailed resource data such as usage percentage
Request Parameters:
| Parameter name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| param | param | body | false | object |
Response Status:
| Status code | Description | schema |
|---|---|---|
| 200 | OK | Message |
| 201 | Created | |
| 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": null,
3. "status": 0,
4. "message": "OK",
5. "data": {
6. "userResources": [{
7. "userCreator": "",
8. "engineTypes": [{
9. "engineType": "",
10. "percent": ""
11. }],
12. "percent": ""
13. }]
14. }
15. }
