我的书签
添加书签
移除书签Engine Management
EngineRestfulApi class
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 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:
{"data": {},"message": "","method": "","status": 0}
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 name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| jsonNode | jsonNode | body | true | JsonNode | JsonNode |
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:
{"data": {},"message": "","method": "","status": 0}
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 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:
{"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 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:
{"data": {},"message": "","method": "","status": 0}
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 name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| onlyEditable | onlyEditable | query | false | boolean |
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:
{"method": "/api/linkisManager/listAllNodeHealthyStatus","status": 0,"message": "OK","data": {"nodeStatus": []}}
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 name | Parameter description | Request type | Required | Data type | schema |
|---|---|---|---|---|---|
| applicationName | Engine tag name, which belongs to the value in serviceInstance | String | false | String | |
| em | The outermost layer of the input parameter | Map | false | Map | |
| emInstance | The name of the engine instance and the level of ‘em’ belong to the outermost layer | String | false | String | |
| engineType | The engine type belongs to the outermost level with the same level as ‘em’ | String | false | String | |
| instance | Instance name | String | false | String | |
| nodeStatus | The status is the outermost level with ‘em’, and the status has the following enumeration types ‘Healthy’, ‘UnHealthy’, ‘WARN’, ‘StockAvailable’, ‘StockUnavailable’ | String | false | String | |
| owner | The creator is at the same level as ‘em’ and belongs to the outermost layer | String | false | String | |
| serviceInstance | The input parameter belongs to ‘’em | Map | false | Map |
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:
{"method": "/api/linkisManager/listEMEngines","status": 0,"message": "OK","data": {"engines": []}}
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 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:
{"data": {},"message": "","method": "","status": 0}
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 name | Parameter description | Required | Request type | Data type | schema |
|---|---|---|---|---|---|
| applicationName | Engine Label | false | String | String | |
| emStatus | Running Status | false | String | String | |
| instance | Engine instance name | false | String | String | |
| labelKey | The label in the added content belongs to the key in the map in the labels collection | false | String | String | |
| labels | The engine instance updates the parameter content, and the collection stores the map type | false | List | List | |
| stringValue | The value of the label in the added content belongs to the value in the map in the labels collection | false | String | 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:
{"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 name | Parameter description | Required | Request type | Data type | schema |
|---|---|---|---|---|---|
| applicationName | The application name, the outermost layer is an array and the engineInstance parameter is a level | false | String | String | |
| engineInstance | The name of the engine instance, the outermost layer is an array and the applicationName parameter is a level | false | String | 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:
{"data": {},"message": "","method": "","status": 0}
