引擎管理

EngineRestfulApi 类

创建引擎连接

接口地址:/api/rest_j/v1/linkisManager/createEngineConn

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:

创建引擎连接

请求参数:

暂无

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

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

执行引擎连接操作

接口地址:/api/rest_j/v1/linkisManager/executeEngineConnOperation

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:

执行引擎连接操作

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
jsonNodejsonNodebodytrueJsonNodeJsonNode

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

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

获取引擎连接

接口地址:/api/rest_j/v1/linkisManager/getEngineConn

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:

获取引擎连接

请求参数:

暂无

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

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

kill引擎连接

接口地址:/api/rest_j/v1/linkisManager/killEngineConn

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:

kill引擎连接

请求参数:

暂无

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

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

所有节点状态

接口地址:/api/rest_j/v1/linkisManager/listAllNodeHealthyStatus

请求方式:GET

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

响应数据类型:application/json

接口描述:

所有节点状态

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
onlyEditableonlyEditablequeryfalseboolean

响应状态:

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

响应参数:

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

响应示例:

  1. {
  2. "method": "/api/linkisManager/listAllNodeHealthyStatus",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "nodeStatus": []
  7. }
  8. }

列表引擎

接口地址:/api/rest_j/v1/linkisManager/listEMEngines

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:

列表引擎

请求示例:

  1. {
  2. em: {
  3. serviceInstance: {
  4. applicationName: "linkis-cg-engineconnmanager",
  5. instance: "bdpdws110003:9102"
  6. }
  7. }
  8. }

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
applicationName引擎标签名称,属于serviceInstance中的值StringfalseString
em入参最外层MapfalseMap
emInstance引擎实例名称跟‘em’一个级别属于最外层StringfalseString
engineType引擎类型跟‘em’一个级别属于最外层StringfalseString
instance实例名称StringfalseString
nodeStatus状态跟‘em’一个级别属于最外层,状态有以下枚举类型 ‘Healthy‘, ‘UnHealthy‘, ‘WARN‘, ’StockAvailable’, ‘StockUnavailable’StringfalseString
owner创建者跟‘em’一个级别属于最外层StringfalseString
serviceInstance入参属于‘’emMapfalseMap

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

  1. {
  2. "method": "/api/linkisManager/listEMEngines",
  3. "status": 0,
  4. "message": "OK",
  5. "data": {
  6. "engines": []
  7. }
  8. }

引擎用户集合

接口地址:/api/rest_j/v1/linkisManager/listUserEngines

请求方式:GET

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

响应数据类型:application/json

接口描述:

引擎用户集合

请求参数:

暂无

响应状态:

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

响应参数:

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

响应示例:

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

编辑引擎实例

接口地址:/api/rest_j/v1/linkisManager/modifyEngineInfo

请求方式:PUT

请求数据类型:application/json

响应数据类型:application/json

接口描述:

编辑引擎实例内容

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
applicationName引擎标签falseStringString
emStatus运行状态falseStringString
instance引擎实例名称falseStringString
labelKey添加内容里面的标签,属于labels集合 内 map里的keyfalseStringString
labels引擎实例更新参数内容,集合存放的是map类型的falseListList
stringValue添加内容里面的标签对于的值,属于labels集合 内 map里的valuefalseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

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

kill引擎

接口地址:/api/rest_j/v1/linkisManager/rm/enginekill

请求方式:POST

请求数据类型:application/json

响应数据类型:application/json

接口描述:

关闭引擎,可关闭一个也可关闭多个

请求示例:

  1. [
  2. {
  3. engineInstance: "",
  4. applicationName:""
  5. }
  6. ]

请求参数:

参数名称参数说明请求类型是否必须数据类型schema
applicationName应用名称,最外层是个数组和engineInstance参数是一个级别falseStringString
engineInstance引擎实例名称,最外层是个数组和applicationName参数是一个级别falseStringString

响应状态:

状态码说明schema
200OKMessage
201Created
401Unauthorized
403Forbidden
404Not Found

响应参数:

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

响应示例:

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