ECM Resource Information Management

ECResourceInfoRestfulApi class

Interface address:/api/rest_j/v1/linkisManager/ecinfo/delete/{ticketid}}

Request method: DELETE

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

Response data type: application/json

Interface description:

Delete EC information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
ticketidticketidpathtruestring

Response Status:

Status codeDescriptionschema
200OKMessage
204No Content
401Unauthorized
403Forbidden

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

Interface address: /api/rest_j/v1/linkisManager/ecinfo/get

Request method: GET

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

Response data type: application/json

Interface description:

Get EC information

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
ticketidticketidquerytruestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

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

Interface address: /api/rest_j/v1/linkisManager/listAllEMs

Request method: GET

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

Response data type: application/json

Interface description:

Get a detailed list of all ECM resources, which can be queried according to conditions, and query all by default

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
instanceinstance namequeryfalsestring
nodeHealthyStatus, the status has the following enumeration types ‘Healthy’, ‘UnHealthy’, ‘WARN’, ‘StockAvailable’, ‘StockUnavailable’queryfalsestring
ownerCreatorqueryfalsestring

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

  1. {
  2. "method": "/api/linkisManager/listAllEMs",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "EMs": [{
  7. "labels": [{
  8. "stringValue": "",
  9. "labelKey": "",
  10. "feature": "",
  11. "instance": "",
  12. "serviceInstance": {
  13. "instance": "",
  14. "applicationName": ""
  15. },
  16. "serviceName": "",
  17. "featureKey": "",
  18. "empty":
  19. }],
  20. "applicationName": "",
  21. "instance": ":",
  22. "resourceType": "",
  23. "maxResource": {
  24. "memory": ,
  25. "cores": ,
  26. "instance":
  27. },
  28. "minResource": {
  29. "memory": ,
  30. "cores": ,
  31. "instance":
  32. },
  33. "usedResource": {
  34. "memory": ,
  35. "cores": ,
  36. "instance":
  37. },
  38. "lockedResource": {
  39. "memory": 0,
  40. "cores": 0,
  41. "instance": 0
  42. },
  43. "expectedResource": {
  44. "memory": 0,
  45. "cores": 0,
  46. "instance": 0
  47. },
  48. "leftResource": {
  49. "memory": ,
  50. "cores": ,
  51. "instance":
  52. },
  53. "owner": "",
  54. "runningTasks": null,
  55. "pendingTasks": null,
  56. "succeedTasks": null,
  57. "failedTasks": null,
  58. "maxMemory": ,
  59. "usedMemory": ,
  60. "systemCPUUsed": null,
  61. "systemLeftMemory": ,
  62. "nodeHealthy": "",
  63. "msg": "",
  64. "startTime":
  65. }]
  66. }
  67. }

Interface address: /api/rest_j/v1/linkisManager/modifyEMInfo

Request method: PUT

Request data type: application/json

Response data type: application/json

Interface description:

Edit or modify the instance under EMC management

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
applicationNameEngine LabelfalseStringString
emStatusInstance status, the status has the following enumeration types ‘Healthy’, ‘UnHealthy’, ‘WARN’, ‘StockAvailable’, ‘StockUnavailable’falseStringString
instanceEngine instance namefalseStringString
labelKeyThe label in the added content belongs to the key in the map in the labels collectionfalseStringString
labelsThe engine instance updates the parameter content, and the collection stores the map typefalseListList
stringValueThe value of the label in the added content belongs to the value in the map in the labels collectionfalseStringString

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

  1. {
  2. "method": "/api/linkisManager/modifyEMInfo",
  3. "status": 0,
  4. "message": "success",
  5. "data": {}
  6. }

Interface address: /api/rest_j/v1/linkisManager/openEngineLog

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

Open the engine log, the stdout type engine log is opened by default

Request example:

  1. {
  2. applicationName: ""
  3. emInstance: ""
  4. instance: ""
  5. parameters: {
  6. pageSize: ,
  7. fromLine: ,
  8. logType: ""
  9. }
  10. }

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
applicationNameEngine LabelStringfalseString
emInstanceInstance nameStringfalseString
fromLineFrom LineStringfalseString
instanceEngine instance nameStringfalseString
logTypeLog type, default stdout type, belonging to parametersStringfalseString
pageSizePage SizeStringfalseString
parametersPagination informationMapfalseMap

Response Status:

Status codeDescriptionschema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

Response parameters:

parameter nameparameter descriptiontypeschema
dataDatasetobject
messageDescriptionstring
methodrequest urlstring
statusStatusinteger(int32)integer(int32)

Sample Response:

  1. {
  2. "method": "/api/linkisManager/openEngineLog",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "result": {
  7. "logPath": "",
  8. "logs": [""],
  9. "endLine": ,
  10. "rows":
  11. },
  12. "isError": false,
  13. "errorMsg": ""
  14. }
  15. }