Skip to main content
Version: Next(1.7.0)

Engine Management

EngineRestfulApi class

create engine connection

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

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

Create engine connection

Request Parameters:

No

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:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Execute engine connection operation

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

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

Execute engine connection operation

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
jsonNodejsonNodebodytrueJsonNodeJsonNode

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:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Get engine connection

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

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

Get engine connection

Request Parameters:

No

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:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

##kill engine connection

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

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

kill engine connection

Request Parameters:

No

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:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

All node states

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

Request method: GET

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

Response data type: application/json

Interface description:

All node status

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
onlyEditableonlyEditablequeryfalseboolean

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

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

Sample Response:

{
"method": "/api/linkisManager/listAllNodeHealthyStatus",
"status": 0,
"message": "OK",
"data": {
"nodeStatus": []
}
}

List engine

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

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

List Engine

Request example:

{
em: {
serviceInstance: {
applicationName: "linkis-cg-engineconnmanager",
instance: "localhost110003:9102"
}
}
}

Request Parameters:

Parameter nameParameter descriptionRequest typeRequiredData typeschema
applicationNameEngine tag name, which belongs to the value in serviceInstanceStringfalseString
emThe outermost layer of the input parameterMapfalseMap
emInstanceThe name of the engine instance and the level of 'em' belong to the outermost layerStringfalseString
engineTypeThe engine type belongs to the outermost level with the same level as 'em'StringfalseString
instanceInstance nameStringfalseString
nodeStatusThe status is the outermost level with 'em', and the status has the following enumeration types 'Healthy', 'UnHealthy', 'WARN', 'StockAvailable', 'StockUnavailable'StringfalseString
ownerThe creator is at the same level as 'em' and belongs to the outermost layerStringfalseString
serviceInstanceThe input parameter belongs to ''emMapfalseMap

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:

{
"method": "/api/linkisManager/listEMEngines",
"status": 0,
"message": "OK",
"data": {
"engines": []
}
}

Engine user collection

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

Request method: GET

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

Response data type: application/json

Interface description:

Engine user set

Request Parameters:

No

Response Status:

Status codeDescriptionschema
200OKMessage
401Unauthorized
403Forbidden
404Not Found

Response parameters:

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

Sample Response:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

Edit engine instance

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

Request method: PUT

Request data type: application/json

Response data type: application/json

Interface description:

Edit engine instance content

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
applicationNameEngine LabelfalseStringString
emStatusRunning StatusfalseStringString
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:

{
"data": {},
"message": "",
"method": "",
"status": 0
}

##kill engine

Interface address: /api/rest_j/v1/linkisManager/rm/enginekill

Request method: POST

Request data type: application/json

Response data type: application/json

Interface description:

Close the engine, one or more can be closed

Request example:

    [
{
engineInstance: "",
applicationName:""
}
]

Request Parameters:

Parameter nameParameter descriptionRequiredRequest typeData typeschema
applicationNameThe application name, the outermost layer is an array and the engineInstance parameter is a levelfalseStringString
engineInstanceThe name of the engine instance, the outermost layer is an array and the applicationName parameter is a levelfalseStringString

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:

{
"data": {},
"message": "",
"method": "",
"status": 0
}