You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@linkis.apache.org by ca...@apache.org on 2022/07/04 07:46:58 UTC
[incubator-linkis-website] branch dev updated: Submission of linkis interface documents (#402)
This is an automated email from the ASF dual-hosted git repository.
casion pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-linkis-website.git
The following commit(s) were added to refs/heads/dev by this push:
new a1df926f7 Submission of linkis interface documents (#402)
a1df926f7 is described below
commit a1df926f7e8fb31d76785e8364ddc0050aec5af6
Author: 成彬彬 <10...@users.noreply.github.com>
AuthorDate: Mon Jul 4 15:46:53 2022 +0800
Submission of linkis interface documents (#402)
* Linkis interface documentation and linkis debugging documentation modification
Co-authored-by: casionone<ca...@gmail.com>
---
docs/api/http/bm-operation-management-api.md | 443 +++++++++
docs/api/http/bml-resource-management-api.md | 803 +++++++++++++++
docs/api/http/bmlfs-management-api.md | 200 ++++
docs/api/http/context-history-service-api.md | 320 ++++++
docs/api/http/context-listening-service-api.md | 188 ++++
docs/api/http/context-logging-service-api.md | 378 +++++++
docs/api/http/context-service-api.md | 698 +++++++++++++
docs/api/http/currency-api.md | 62 ++
docs/api/http/ec-resource-management-api.md | 127 +++
docs/api/http/ecm-resource-management-api.md | 402 ++++++++
docs/api/http/engine-management-api.md | 579 +++++++++++
docs/api/http/engine-plugin-api.md | 124 +++
docs/api/http/file-system-api.md | 1036 +++++++++++++++++++
docs/api/http/global-variable-api.md | 78 ++
docs/api/http/homepage-function-interface-api.md | 328 ++++++
docs/api/http/instance-management-api.md | 289 ++++++
docs/api/http/link-error-code.md | 64 ++
docs/api/http/mdq-table-interface-api.md | 438 ++++++++
docs/api/http/parameter-configuration-api.md | 887 +++++++++++++++++
docs/api/http/resource-management-api.md | 606 ++++++++++++
docs/api/http/rpc-api.md | 183 ++++
docs/api/http/task-management-api.md | 128 +++
docs/api/http/task-operation-api.md | 565 +++++++++++
docs/development/linkis_debug.md | 17 +-
.../api/http/bm-operation-management-api.md | 450 +++++++++
.../api/http/bml-resource-management-api.md | 812 +++++++++++++++
.../current/api/http/bmlfs-management-api.md | 201 ++++
.../api/http/context-history-service-api.md | 322 ++++++
.../api/http/context-listening-service-api.md | 189 ++++
.../api/http/context-logging-service-api.md | 384 ++++++++
.../current/api/http/context-service-api.md | 703 +++++++++++++
.../current/api/http/currency-api.md | 62 ++
.../current/api/http/ec-resource-management-api.md | 128 +++
.../api/http/ecm-resource-management-api.md | 462 +++++++++
.../current/api/http/engine-management-api.md | 585 +++++++++++
.../current/api/http/engine-plugin-api.md | 125 +++
.../current/api/http/file-system-api.md | 1041 ++++++++++++++++++++
.../current/api/http/global-variable-api.md | 79 ++
.../api/http/homepage-function-interface-api.md | 327 ++++++
.../current/api/http/instance-management-api.md | 288 ++++++
.../current/api/http/jobhistory-api.md | 12 +-
.../current/api/http/link-error-code.md | 65 ++
.../current/api/http/mdq-table-interface-api.md | 437 ++++++++
.../api/http/parameter-configuration-api.md | 891 +++++++++++++++++
.../current/api/http/resource-management-api.md | 612 ++++++++++++
.../current/api/http/rpc-api.md | 183 ++++
.../current/api/http/task-management-api.md | 129 +++
.../current/api/http/task-operation-api.md | 569 +++++++++++
.../current/development/linkis_debug.md | 19 +-
.../version-1.0.2/development/linkis_debug.md | 12 +-
.../version-1.0.3/development/linkis_debug.md | 14 +-
.../version-1.1.0/development/linkis_debug.md | 18 +-
.../version-1.1.1/development/linkis_debug.md | 20 +-
static/Images/development/debug_application.png | Bin 78783 -> 108021 bytes
54 files changed, 18033 insertions(+), 49 deletions(-)
diff --git a/docs/api/http/bm-operation-management-api.md b/docs/api/http/bm-operation-management-api.md
new file mode 100644
index 000000000..8a1158236
--- /dev/null
+++ b/docs/api/http/bm-operation-management-api.md
@@ -0,0 +1,443 @@
+---
+title: BM Project Operation Management
+sidebar_position: 29
+---
+
+** BmlProjectRestful class **
+
+
+## Attachment resource item
+
+
+**Interface address**:`/api/rest_j/v1/bml/attachResourceAndProject`
+
+
+**Request mode**:`POST`
+
+
+**Request data type**:`application/json`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Attachment resource item</p>
+
+
+
+**Request parameters**:
+
+
+|parameter name | parameter description | request type | must be | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|projectName | project name | string | false | string|
+|resourceid | resource name | string | false | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## Create BML project
+
+
+**Interface address**:`/api/rest_j/v1/bml/createBmlProject`
+
+
+**Request mode**:`POST`
+
+
+**Request data type**:`application/json`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Create BML project</p>
+
+
+
+**Request parameters**:
+
+
+|parameter name | parameter description | request type | must be | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|accessusers | access users | string | false | string|
+|editusers | edit user | string | false | string|
+|projectName | project name | string | false | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## Download shared resources
+
+
+**Interface address**:`/api/rest_j/v1/bml/downloadShareResource`
+
+
+**Request mode**:`GET`
+
+
+**Request data type**:`application/x-www-form-urlencoded`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Download shared resources</p>
+
+
+
+**Request parameters**:
+
+
+|Parameter name | parameter description | request type | must be | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|Resourceid | resource ID | query | false | string||
+|Version | version | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## Project information
+
+
+**Interface address**:`/api/rest_j/v1/bml/getProjectInfo`
+
+
+**Request mode**:`GET`
+
+
+**Request data type**:`application/x-www-form-urlencoded`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Project information</p>
+
+
+
+**Request parameters**:
+
+
+|Parameter name | parameter description | request type | must be | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|ProjectName | project name | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## Update project user
+
+
+**Interface address**:`/api/rest_j/v1/bml/updateProjectUsers`
+
+
+**Request mode**:`POST`
+
+
+**Request data type**:`application/json`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Update project users</p>
+
+
+
+**Request parameters**:
+
+
+|parameter name | parameter description | whether it is required | request type | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|accessusers | access users | false | string | string|
+|editusers | edit user | false | string | string|
+|projectName | project name | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## Update shared resources
+
+
+**Interface address**:`/api/rest_j/v1/bml/updateShareResource`
+
+
+**Request mode**:`POST`
+
+
+**Request data type**:`multipart/form-data`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Update shared resources</p>
+
+
+
+**Request parameters**:
+
+
+|parameter name | parameter description | request type | must be | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|file | file | formdata | false | ref||
+|resourceid | resource ID | query | false | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## Upload shared resources
+
+
+**Interface address**:`/api/rest_j/v1/bml/uploadShareResource`
+
+
+**Request mode**:`POST`
+
+
+**Request data type**:`application/json`
+
+
+**Response data type**:`*/*`
+
+
+**Interface description**:<p>Upload shared resources</p>
+
+
+
+**Request parameters**:
+
+
+|parameter name | parameter description | request type | must be | data type | schema|
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|expireTime | expiration time | query | false | string||
+|expiretype | failure type | query | false | string||
+|file | file set | formdata | false | ref||
+|isexpire | invalid | query | false | string||
+|maxversion | MAV version | query | false | ref||
+|projectName | project name | query | false | string||
+|resourceheader | resource header | query | false | string||
+|system | system | query | false | 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 | integer |
+
+
+**Response example**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
diff --git a/docs/api/http/bml-resource-management-api.md b/docs/api/http/bml-resource-management-api.md
new file mode 100644
index 000000000..482277d4d
--- /dev/null
+++ b/docs/api/http/bml-resource-management-api.md
@@ -0,0 +1,803 @@
+---
+title: BML Resource Management
+sidebar_position: 30
+---
+** BmlRestfulApi class **
+
+
+## update owner
+
+
+**Interface address**:`/api/rest_j/v1/bml/changeOwner`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Update owner</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|newOwner|Old Owner||false|String|String|
+|oldOwner|New Owner||false|String|String|
+|resourceId|ResourceId||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+## Copy resources to other users
+
+
+**Interface address**:`/api/rest_j/v1/bml/copyResourceToAnotherUser`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Copy resources to specified user</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|anotherUser|specified user||false|String|String|
+|resourceId|ResourceId||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## delete resource
+
+
+**Interface address**:`/api/rest_j/v1/bml/deleteResource`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete version</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|ResourceId||true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## delete multiple resources
+
+
+**Interface address**:`/api/rest_j/v1/bml/deleteResources`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete multiple resources</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceIds| Collection of resource IDs, delete multiple resources||true|List|List|
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## delete version
+
+
+**Interface address**:`/api/rest_j/v1/bml/deleteVersion`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete version</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|ResourceId||true|String|String|
+|version|version||true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Download resources
+
+
+**Interface address**:`/api/rest_j/v1/bml/download`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get the resources corresponding to download through the two parameters of resourceId and version</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|ResourceId|query|false|string||
+|version|Resource version, if not specified, defaults to latest |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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+## Get Basic
+
+
+**Interface address**:`/api/rest_j/v1/bml/getBasic`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get Basic</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|ResourceId|query|true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get resource information
+
+
+**Interface address**:`/api/rest_j/v1/bml/getResourceInfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get resource information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|ResourceId|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get resource information
+
+
+**Interface address**:`/api/rest_j/v1/bml/getResources`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get resource information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|currentPage|page number|query|false|string||
+|pageSize|page size|query|false|string||
+|system|system|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+## Get version information
+
+
+**Interface address**: `/api/rest_j/v1/bml/getVersions`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get bml version information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|currentPage|page number|query|false|string||
+|pageSize|page size|query|false|string||
+|resourceId|Resource ID|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## rollback version
+
+
+**Interface address**:`/api/rest_j/v1/bml/rollbackVersion`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Rollback version</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|ResourceId||false|String|String|
+|version|Rollback version||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## update resource
+
+
+**Interface address**:`/api/rest_j/v1/bml/updateVersion`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `multipart/form-data`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Users update resource files through http</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|file|filefile|formData|true|ref||
+|resourceId|resourceId|query|true|string|| of the resource the user wishes to update
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## upload resources
+
+
+**Interface address**:`/api/rest_j/v1/bml/upload`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Upload resources</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|file|file|formData|true|array|file|
+|expireTime|expireTime|query|false|string||
+|expireType|expireType|query|false|string||
+|isExpire|isExpire|query|false|string||
+|maxVersion|maxVersion|query|false|integer(int32)||
+|resourceHeader|resourceHeader|query|false|string||
+|system|system|query|false|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/bmlfs-management-api.md b/docs/api/http/bmlfs-management-api.md
new file mode 100644
index 000000000..a235a5dcf
--- /dev/null
+++ b/docs/api/http/bmlfs-management-api.md
@@ -0,0 +1,200 @@
+---
+title: BMLFs Management
+sidebar_position: 18
+---
+** BMLFsRestfulApi class **
+
+
+
+## Open ScriptFromBML
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/openScriptFromBML`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>openScriptFromBML</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|fileName|File name|query|true|string||
+|creator|Creator|query|false|string||
+|projectName|Project name|query|false|string||
+|resourceId|ResourceId|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## -product-openScriptFromBML
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/product/openScriptFromBML`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>/product/openScriptFromBML</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|fileName|File name|query|true|string||
+|creator|Creator|query|false|string||
+|resourceId|ResourceId|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Save script from BML
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/saveScriptToBML`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Save script from BML</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|Creator||true|String|String|
+|fileName|File name||true|String|String|
+|metadata|metadata||true|String|String|
+|projectName|Project Name||true|String|String|
+|resourceId|Resource ID||true|String|String|
+|scriptContent|Content||true|String|String|
+|SaveScriptToBML|json|body|true|SaveScriptToBML|SaveScriptToBML|
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/context-history-service-api.md b/docs/api/http/context-history-service-api.md
new file mode 100644
index 000000000..0b06e4a86
--- /dev/null
+++ b/docs/api/http/context-history-service-api.md
@@ -0,0 +1,320 @@
+---
+title: Context History Service
+sidebar_position: 14
+---
+** ContextHistoryRestfulApi class **
+
+
+
+## create history
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/createHistory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface Description**:<p>Create History</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextHistory|History context||false|String|String|
+|contextID|context id||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get multiple histories
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/getHistories`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get multiple history records</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get history
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/getHistory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get history records</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|ContextId||false|String|String|
+|source|Context Source||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## delete history
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/removeHistory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete history records</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextHistory|History context||false|String|String|
+|contextID|context id||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## search history
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/searchHistory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Search history</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|ContextId||false|String|String|
+|keywords|Keywords||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/context-listening-service-api.md b/docs/api/http/context-listening-service-api.md
new file mode 100644
index 000000000..5d71b9d2c
--- /dev/null
+++ b/docs/api/http/context-listening-service-api.md
@@ -0,0 +1,188 @@
+---
+title: Context Listening Service
+sidebar_position: 16
+---
+** ContextListenerRestfulApi class **
+
+
+# Context listener service
+
+
+## heartbeat
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/heartbeat`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## onBindIDListener
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/onBindIDListener`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## onBindKeyListener
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/onBindKeyListener`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/context-logging-service-api.md b/docs/api/http/context-logging-service-api.md
new file mode 100644
index 000000000..e830b1523
--- /dev/null
+++ b/docs/api/http/context-logging-service-api.md
@@ -0,0 +1,378 @@
+---
+title: Context Logging Service
+sidebar_position: 17
+---
+** ContextIDRestfulApi class **
+
+
+## create text record
+
+
+**Interface address**: `/api/rest_j/v1/contextservice/createContextID`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Create text record</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|ContextId||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get text ID
+
+
+**Interface address**: `/api/rest_j/v1/contextservice/getContextID`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get text ID</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|contextId|ContextId|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## delete text ID
+
+
+**Interface address**: `/api/rest_j/v1/contextservice/removeContextID`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete text ID</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextId|ContextId||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## reset text ID
+
+
+**Interface address**: `/api/rest_j/v1/contextservice/resetContextID`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface Description**:<p>Reset Text ID</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextId|ContextId||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Search text Id execution time
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/searchContextIDByTime`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Search text ID execution time</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|accessTimeEnd|Access end time|query|false|string||
+|accessTimeStart|Access Start Time|query|false|string||
+|createTimeEnd|Create end time|query|false|string||
+|createTimeStart|create time|query|false|string||
+|pageNow|page number|query|false|string||
+|pageSize|page size|query|false|string||
+|updateTimeEnd|Update end time|query|false|string||
+|updateTimeStart|Update time|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Modify text ID
+
+
+**Interface address**: `/api/rest_j/v1/contextservice/updateContextID`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Modify text ID</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextId|ContextId||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
diff --git a/docs/api/http/context-service-api.md b/docs/api/http/context-service-api.md
new file mode 100644
index 000000000..018f46cb1
--- /dev/null
+++ b/docs/api/http/context-service-api.md
@@ -0,0 +1,698 @@
+---
+title: Context Service
+sidebar_position: 15
+---
+** ContextRestfulApi class **
+
+
+
+## Clear all context by ID
+
+
+**Interface address**: `/api/rest_j/v1/contextservice/clearAllContextByID`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Clear all context by ID</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|idList|Context id 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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Clear all context by time
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/clearAllContextByTime`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Clear so context by time</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|bodyMap|bodyMap|body|true|object||
+|accessTimeEnd|Access Time End||false|String|String|
+|accessTimeStart|Access Time Start||false|String|String|
+|createTimeEnd|Create time end||false|String|String|
+|createTimeStart|Create Time||false|String|String|
+|updateTimeStart|Update start time||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## Get context content
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/getContextValue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get context content</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||false|String|String|
+|contextKey|contextKey||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## delete all values
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/removeAllValue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete all values</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||false|String|String|
+|contextKey|contextKey||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Remove all values by value prefix
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/removeAllValueByKeyPrefix`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Remove all values by prefix and context type</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|contextID||false|String|String|
+|keyPrefix|keyPrefix||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Remove all values by key prefix and context type
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/removeAllValueByKeyPrefixAndContextType`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Remove all values by prefix and context type</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextKeyType|contextKeyType||false|String|String|
+|keyPrefix|keyPrefix||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+## delete value
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/removeValue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||false|String|String|
+|contextKey|contextKey||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## reset value
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/resetValue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Reset value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||false|String|String|
+|contextKey|contextKey||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## search context content
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/searchContextValue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Search context content</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|condition|condition||false|String|String|
+|contextID|context id||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## set value
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/setValue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Set value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||false|String|String|
+|contextKeyValue|contextKeyValue||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## set key
+
+
+**Interface address**:`/api/rest_j/v1/contextservice/setValueByKey`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Set key for value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|contextID|context id||false|String|String|
+|contextKey|contextKey||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/currency-api.md b/docs/api/http/currency-api.md
new file mode 100644
index 000000000..49da2eb7f
--- /dev/null
+++ b/docs/api/http/currency-api.md
@@ -0,0 +1,62 @@
+---
+title: Ceneric Api
+sidebar_position: 6
+---
+** CommonRestfulApi class **
+
+## offline
+
+
+**Interface address**:`/api/rest_j/v1/offline`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Offline</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/ec-resource-management-api.md b/docs/api/http/ec-resource-management-api.md
new file mode 100644
index 000000000..b0e4bea73
--- /dev/null
+++ b/docs/api/http/ec-resource-management-api.md
@@ -0,0 +1,127 @@
+---
+title: EC Resource Information Management
+sidebar_position: 10
+---
+** ECResourceInfoRestfulApi class **
+
+
+
+
+## delete EC info
+
+
+**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**:<p>Delete EC information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|ticketid|ticketid|path|true|string||
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get EC information
+
+
+**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**:<p>Get EC information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|ticketid|ticketid|query|true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/ecm-resource-management-api.md b/docs/api/http/ecm-resource-management-api.md
new file mode 100644
index 000000000..7c28e6cba
--- /dev/null
+++ b/docs/api/http/ecm-resource-management-api.md
@@ -0,0 +1,402 @@
+---
+title: EC Resource Information Management
+sidebar_position: 10
+---
+** ECResourceInfoRestfulApi class **
+
+
+
+
+## delete EC info
+
+
+**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**:<p>Delete EC information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|ticketid|ticketid|path|true|string||
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get EC information
+
+
+**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**:<p>Get EC information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|ticketid|ticketid|query|true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+ }
+````
+## ECM resource list
+
+
+**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**:<p>Get a detailed list of all ECM resources, which can be queried according to conditions, and query all by default</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|instance|instance name|query|false|string||
+|nodeHealthy|Status, the status has the following enumeration types 'Healthy', 'UnHealthy', 'WARN', 'StockAvailable', 'StockUnavailable'|query|false|string||
+|owner|Creator|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**:
+````javascript
+{
+ "method": "/api/linkisManager/listAllEMs",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "EMs": [{
+ "labels": [{
+ "stringValue": "",
+ "labelKey": "",
+ "feature": "",
+ "instance": "",
+ "serviceInstance": {
+ "instance": "",
+ "applicationName": ""
+ },
+ "serviceName": "",
+ "featureKey": "",
+ "empty":
+ }],
+ "applicationName": "",
+ "instance": ":",
+ "resourceType": "",
+ "maxResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "minResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "usedResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "lockedResource": {
+ "memory": 0,
+ "cores": 0,
+ "instance": 0
+ },
+ "expectedResource": {
+ "memory": 0,
+ "cores": 0,
+ "instance": 0
+ },
+ "leftResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "owner": "",
+ "runningTasks": null,
+ "pendingTasks": null,
+ "succeedTasks": null,
+ "failedTasks": null,
+ "maxMemory": ,
+ "usedMemory": ,
+ "systemCPUUsed": null,
+ "systemLeftMemory": ,
+ "nodeHealthy": "",
+ "msg": "",
+ "startTime":
+ }]
+ }
+}
+````
+
+
+## Edit EMC instance
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/modifyEMInfo`
+
+
+**Request method**: `PUT`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `application/json`
+
+
+**Interface description**:<p>Edit or modify the instance under EMC management</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|applicationName|Engine Label||false|String|String|
+|emStatus|Instance status, the status has the following enumeration types 'Healthy', 'UnHealthy', 'WARN', 'StockAvailable', 'StockUnavailable'||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**:
+````javascript
+{
+ "method": "/api/linkisManager/modifyEMInfo",
+ "status": 0,
+ "message": "success",
+ "data": {}
+}
+````
+
+
+## Open engine log
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/openEngineLog`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `application/json`
+
+
+**Interface description**:<p>Open the engine log, the stdout type engine log is opened by default</p>
+
+**Request example**:
+````javascript
+{
+ applicationName: ""
+ emInstance: ""
+ instance: ""
+ parameters: {
+ pageSize: ,
+ fromLine: ,
+ logType: ""
+ }
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|applicationName|Engine Label||String|false|String|
+|emInstance|Instance name||String|false|String|
+|fromLine|From Line||String|false|String|
+|instance|Engine instance name||String|false|String|
+|logType|Log type, default stdout type, belonging to parameters||String|false|String|
+|pageSize|Page Size||String|false|String|
+|parameters|Pagination information||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**:
+````javascript
+{
+ "method": "/api/linkisManager/openEngineLog",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "result": {
+ "logPath": "",
+ "logs": [""],
+ "endLine": ,
+ "rows":
+ },
+ "isError": false,
+ "errorMsg": ""
+ }
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/engine-management-api.md b/docs/api/http/engine-management-api.md
new file mode 100644
index 000000000..b61ae73a0
--- /dev/null
+++ b/docs/api/http/engine-management-api.md
@@ -0,0 +1,579 @@
+---
+title: Engine Management
+sidebar_position: 11
+---
+** 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**:<p>Create engine connection</p>
+
+
+
+**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**:
+````javascript
+{
+ "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**:<p>Execute engine connection operation</p>
+
+
+
+**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**:
+````javascript
+{
+ "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**:<p>Get engine connection</p>
+
+
+
+**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**:
+````javascript
+{
+ "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**:<p>kill engine connection</p>
+
+
+
+**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**:
+````javascript
+{
+ "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**:<p>All node status</p>
+
+
+
+**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**:
+````javascript
+{
+ "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**:<p>List Engine</p>
+
+**Request example**:
+````javascript
+{
+ em: {
+ serviceInstance: {
+ applicationName: "linkis-cg-engineconnmanager",
+ instance: "bdpdws110003: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**:
+````javascript
+{
+ "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**:<p>Engine user set</p>
+
+
+
+**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**:
+````javascript
+{
+ "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**:<p>Edit engine instance content</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | 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**:
+````javascript
+{
+ "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**:<p>Close the engine, one or more can be closed</p>
+
+
+**Request example**:
+````javascript
+ [
+ {
+ engineInstance: "",
+ applicationName:""
+ }
+ ]
+
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | 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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/engine-plugin-api.md b/docs/api/http/engine-plugin-api.md
new file mode 100644
index 000000000..4e0921482
--- /dev/null
+++ b/docs/api/http/engine-plugin-api.md
@@ -0,0 +1,124 @@
+---
+title: Engine Plugin Api
+sidebar_position: 5
+---
+
+** EnginePluginRestful class **
+
+## refresh
+
+
+**Interface address**:`/api/rest_j/v1/engineplugin/refresh`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Refresh a single resource</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|ecType|type|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## refresh all
+
+
+**Interface address**:`/api/rest_j/v1/engineplugin/refreshAll`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Refresh all ec resources</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/file-system-api.md b/docs/api/http/file-system-api.md
new file mode 100644
index 000000000..afd41b1a0
--- /dev/null
+++ b/docs/api/http/file-system-api.md
@@ -0,0 +1,1036 @@
+---
+title: Filesystem
+sidebar_position: 27
+---
+** FsRestfulApi class **
+
+
+
+
+
+## create new Dir
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/createNewDir`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Create a new Dir</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|path||true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## create new file
+
+
+**Interface address**: `/api/rest_j/v1/filesystem/createNewFile`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Create a new file</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|path||true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## delete dir file or file
+
+
+**Interface address**: `/api/rest_j/v1/filesystem/deleteDirOrFile`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete dir file or file</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|address||true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+ }
+````
+
+
+## download
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/download`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Download</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|charset|Charset||true|String|String|
+|path|address||true|String|String|
+|json|json|body|true|||
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## file info
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/fileInfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface Description**:<p>File Information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|address|query|true|string||
+|pageSize|page size|query|false|ref||
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## format
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/formate`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>resultsets converted to Excel</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|encoding|encoding|query|true|string||
+|escapeQuotes|escapeQuotes|query|true|string||
+|fieldDelimiter|Field Delimiter|query|true|string||
+|hasHeader|Hash value|query|true|boolean||
+|quote|quote|query|true|string||
+|path|address|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## function list
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/getDirFileTrees`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get a list of udf functions</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|request path|query|true|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**:
+````javascript
+{
+ "method": "/api/filesystem/getDirFileTrees",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "dirFileTrees": {
+ "name": "",
+ "path": "",
+ "properties": null,
+ "children": [{
+ "name": "",
+ "path": "",
+ "properties": {
+ "size": "",
+ "modifytime": ""
+ },
+ "children": ,
+ "isLeaf": ,
+ "parentPath": ""
+ }],
+ "isLeaf": ,
+ "parentPath":
+ }
+ }
+}
+````
+
+
+## root path
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/getUserRootPath`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get root path</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|pathType|FileType|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## does it exist
+
+
+**Interface address**: `/api/rest_j/v1/filesystem/isExist`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**: <p>Whether it exists</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|address|query|true|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## open a file
+
+
+**Interface address**: `/api/rest_j/v1/filesystem/openFile`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Open file</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|address|query|true|string||
+|charset|Charset|query|false|string||
+|page|page number|query|false|ref||
+|pageSize|page size|query|false|ref||
+
+
+**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**:
+````javascript
+{
+ "method": "/api/filesystem/openFile",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "metadata": [{
+ "columnName": "_c0",
+ "comment": "NULL",
+ "dataType": ""
+ }],
+ "totalPage": ,
+ "totalLine": ,
+ "page": ,
+ "type": "",
+ "fileContent": [
+ [""]
+ ]
+ }
+}
+````
+
+
+## Turn on logging
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/openLog`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Open logging</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|address|query|false|string||
+|proxyUser|Proxy User|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**:
+````javascript
+{
+ "method": "/api/filesystem/openLog",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "log": ["", ""]
+ }
+}
+````
+## Rename
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/rename`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Rename the file</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|newDest|new name||false|String|String|
+|oldDest|old name||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Convert the result set to Excel
+
+
+**Interface address**: `/api/rest_j/v1/filesystem/resultsetToExcel`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Convert the result set to Excel</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|autoFormat|Auto |query|false|boolean||
+|charset|result set|query|false|string||
+|csvSeerator|csv Separator|query|false|string||
+|limit|limit|query|false|ref||
+|nullValue|null value|query|false|string||
+|outputFileName|Output file name|query|false|string||
+|outputFileType|Output file type|query|false|string||
+|path|address|query|false|string||
+|quoteRetouchEnable| Whether to quote modification|query|false|boolean||
+|sheetName|sheet name|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Convert resultsets to Excel
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/resultsetsToExcel`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>resultsets converted to Excel</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|autoFormat|Auto |query|true|boolean||
+|limit|limit|query|true|ref||
+|nullValue|null value|query|true|string||
+|outputFileName|Output file name|query|true|string||
+|path|address|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## save the script
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/saveScript`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Save script</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|path|address||true|String|String|
+|SaveScript|json|body|true|SaveScript|SaveScript|
+|charset|Charset||false|String|String|
+|params|Page Size||false|Object|Object|
+|scriptContent|page number||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## upload
+
+
+**Interface address**:`/api/rest_j/v1/filesystem/upload`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Upload files, multiple files can be uploaded</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|file|file|formData|false|ref||
+|path|address|query|false|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/global-variable-api.md b/docs/api/http/global-variable-api.md
new file mode 100644
index 000000000..1683c5fc3
--- /dev/null
+++ b/docs/api/http/global-variable-api.md
@@ -0,0 +1,78 @@
+---
+title: Add Global Variable
+sidebar_position: 23
+---
+** VariableRestfulApi class **
+
+
+## add global variables
+
+
+**Interface address**:`/api/rest_j/v1/variable/saveGlobalVariable`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Add global variables</p>
+
+**Request example**:
+````javascript
+{
+ globalVariables: [{
+ keyID: ,
+ key: "",
+ valueID: ,
+ value: ""
+ }]
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|globalVariables|Added parameter data one-to-many key:globalVariables,value:List||Map|true|Map|
+|key|Parameter name, belonging to globalVariables||String|true|String|
+|value| variable value, and key belong to the key-value pair that is contained by globalVariables ||List|true|List|
+
+
+**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**:
+````javascript
+{
+ "method": "/api/variable/saveGlobalVariable",
+ "status": 0,
+ "message": "OK",
+ "data": {}
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/homepage-function-interface-api.md b/docs/api/http/homepage-function-interface-api.md
new file mode 100644
index 000000000..0ba64b534
--- /dev/null
+++ b/docs/api/http/homepage-function-interface-api.md
@@ -0,0 +1,328 @@
+---
+title: Admin Console Home Page Interface
+sidebar_position: 28
+---
+** QueryRestfulApi class **
+
+
+## admin authentication
+
+
+**Interface address**:`/api/rest_j/v1/jobhistory/governanceStationAdmin`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Used to verify whether it is an administrator, if it is, it will return true if it is not false</p>
+
+
+
+**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**:
+````javascript
+{
+ data: {
+ solution: null,
+ admin: true
+ }
+ message: "OK"
+ method: "/api/jobhistory/governanceStationAdmin"
+ status: 0
+}
+````
+
+
+## global history
+
+
+**Interface address**:`/api/rest_j/v1/jobhistory/list`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Acquire global historical data list according to conditions and get all by default</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|Creator|query|false|string||
+|endDate|End time|query|false|integer(int64)||
+|executeApplicationName|operator|query|false|string||
+|isAdminView|Whether it is in administrator mode or normal mode|query|false|boolean||
+|pageSize|Number of pages|query|false|ref||
+|proxyUser|Proxy User|query|false|string||
+|startDate|Start time|query|false|integer(int64)||
+|status|end time|query|false|string||
+|taskID|ID|query|false|integer(int64)||
+|tpageNow|page number|query|false|ref||
+|pageNow|pageNow|query|false|integer(int32)||
+
+
+**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**:
+````javascript
+{
+ {
+ "method": "/api/jobhistory/list",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "solution": null,
+ "totalPage": 90,
+ "tasks": [{
+ "taskID": ,
+ "instance": ",
+ "execId": "",
+ "umUser": "",
+ "engineInstance": null,
+ "executionCode": "",
+ "progress": "",
+ "logPath": "",
+ "resultLocation": "",
+ "status": "",
+ "createdTime": ,
+ "updatedTime": ,
+ "engineType": "",
+ "errCode": 0,
+ "errDesc": "",
+ "executeApplicationName": "",
+ "requestApplicationName": "",
+ "runType": "datachecker",
+ "paramsJson": "",
+ "costTime": 1000,
+ "strongerExecId": "",
+ "sourceJson": "",
+ "sourceTailor": "",
+ "engineStartTime": null,
+ "labels": [],
+ "canRetry": ,
+ "subJobs":
+ }]
+ }
+ }
+}
+````
+## list undo
+
+
+**Interface address**:`/api/rest_j/v1/jobhistory/listundone`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Undo list</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|creator|query|false|string||
+|endDate|End time|query|false|integer(int64)||
+|engineType|engineType|query|false|string||
+|pageNow|pageNow|query|false|ref||
+|pageSize|pageSize|query|false|ref||
+|startDate|Start time|query|false|ref||
+|startTaskID|startTaskID|query|false|integer(int64)||
+|status|status|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## History details
+
+
+**Interface address**:`/api/rest_j/v1/jobhistory/{id}/get`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get the detailed information of a history through the history ID</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|HistoryId|query|false|integer(int64)||
+
+
+**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**:
+```javascript
+{
+ "method": "/api/jobhistory/1928730/get",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "task": {
+ "taskID": ,
+ "instance": "",
+ "execId": "",
+ "umUser": "",
+ "engineInstance": "",
+ "executionCode": "",
+ "progress": "",
+ "logPath": "",
+ "resultLocation": "",
+ "status": "",
+ "createdTime":,
+ "updatedTime": ,
+ "engineType": "",
+ "errCode": ,
+ "errDesc": "",
+ "executeApplicationName": "",
+ "requestApplicationName": "",
+ "runType": "hql",
+ "paramsJson": "",
+ "costTime": ,
+ "strongerExecId": "",
+ "sourceJson": "",
+ "sourceTailor": "",
+ "engineStartTime": null,
+ "labels": [""],
+ "canRetry": false,
+ "subJobs": null
+ }
+ }
+}
+```
+
+
+
diff --git a/docs/api/http/instance-management-api.md b/docs/api/http/instance-management-api.md
new file mode 100644
index 000000000..6cf88bac7
--- /dev/null
+++ b/docs/api/http/instance-management-api.md
@@ -0,0 +1,289 @@
+---
+title: Instance Management
+sidebar_position: 26
+---
+** InstanceRestful class **
+
+
+
+
+## Microservice instance list
+
+
+**Interface address**: `/api/rest_j/v1/microservice/allInstance`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get the list of microservice management module instances to get single or multiple default all</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": null,
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "instances": [{
+ "id": ,
+ "updateTime": ,
+ "createTime": ,
+ "applicationName": ",
+ "instance": "",
+ "labels": [{
+ "stringValue": "",
+ "labelKey": "",
+ "feature": "",
+ "id": 5,
+ "labelValueSize": 0,
+ "modifiable": true,
+ "updateTime": ,
+ "createTime": ,
+ "featureKey": "",
+ "empty":
+ }]
+ }]
+ }
+}
+````
+
+
+## Get eurekaURL
+
+
+**Interface address**: `/api/rest_j/v1/microservice/eurekaURL`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>return eurekaURL</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": null,
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "url": ""
+ }
+}
+````
+
+
+## Edit the microservice instance
+
+
+**Interface address**: `/api/rest_j/v1/microservice/instanceLabel`
+
+
+**Request method**: `PUT`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Edit or modify the instance in microservice management</p>
+
+**Request example**:
+````javascript
+{
+ applicationName: "linkis-ps-cs"
+ instance: "bdpdws110004:9108"
+ labels: [{
+ labelKey: "route",
+ stringValue: "cs_2_dev"
+ }]
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|applicationName|Engine Label||String|false|String|
+|instance|Engine instance name||String|String|String|
+|labelKey|The label in the added content belongs to the key in the map in the labels collection||String|String|String|
+|labels|The engine instance updates the parameter content, and the collection stores the map type ||List|String|List|
+|stringValue|The value of the label in the added content belongs to the value in the map in the labels collection||String|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**:
+````javascript
+{
+ "method": null,
+ "status": 0,
+ "message": "success",
+ "data": {
+ "labels": [{
+ "stringValue": "",
+ "labelKey": "",
+ "feature": null,
+ "modifiable": ,
+ "featureKey": "",
+ "empty":
+ }]
+ }
+}
+````
+
+
+## Modifiable label types
+
+
+**Interface address**:`/api/rest_j/v1/microservice/modifiableLabelKey`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get a list of label types that can be modified, such as 'userCreator, route'</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": null,
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "keyList": []
+ }
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/link-error-code.md b/docs/api/http/link-error-code.md
new file mode 100644
index 000000000..b3a0b607d
--- /dev/null
+++ b/docs/api/http/link-error-code.md
@@ -0,0 +1,64 @@
+---
+title: Linkis Error Codes
+sidebar_position: 20
+---
+** LinkisErrorCodeRestful class **
+
+
+
+## Get Linkis error code
+
+
+**Interface address**:`/api/rest_j/v1/errorcode/getAllErrorCodes`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get Linkis error code list</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/mdq-table-interface-api.md b/docs/api/http/mdq-table-interface-api.md
new file mode 100644
index 000000000..2eb50ea4b
--- /dev/null
+++ b/docs/api/http/mdq-table-interface-api.md
@@ -0,0 +1,438 @@
+---
+title: Mdq Table Interface
+sidebar_position: 21
+---
+
+** MdqTableRestfulApi class **
+
+
+
+
+## Activate table operations
+
+
+**Interface address**:`/api/rest_j/v1/datasource/active`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Activate table operation</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|tableId|Table ID|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Generate the DDL statement for the new library table
+
+
+**Interface address**:`/api/rest_j/v1/datasource/displaysql`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Generate DDL statement for new library table</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|table|Table||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get partition statistics
+
+
+**Interface address**:`/api/rest_j/v1/datasource/getPartitionStatisticInfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get partition statistics</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|database|Datasource|query|false|string||
+|partitionSort|Partition Sort||false|String|String|
+|tableName|table name|query|false|string||
+|partitionPath|partitionPath|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+## Get table information
+
+
+**Interface address**:`/api/rest_j/v1/datasource/getTableBaseInfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get table information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|database|Datasource|query|false|string||
+|tableName|table name|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get table field information
+
+
+**Interface address**:`/api/rest_j/v1/datasource/getTableFieldsInfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get table field information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|database|Datasource|query|false|string||
+|tableName|table name|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Get table statistics
+
+
+**Interface address**:`/api/rest_j/v1/datasource/getTableStatisticInfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get table statistics</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|database|Datasource|query|false|string||
+|pageNow|page number|query|false|string||
+|pageSize|page size|query|false|string||
+|partitionSort|Partition Sort|query|false|string||
+|tableName|table name|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Active ID
+
+
+**Interface address**:`/api/rest_j/v1/datasource/persistTable`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Activated logo</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|table|Table||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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/parameter-configuration-api.md b/docs/api/http/parameter-configuration-api.md
new file mode 100644
index 000000000..b87870973
--- /dev/null
+++ b/docs/api/http/parameter-configuration-api.md
@@ -0,0 +1,887 @@
+---
+title: Parameter Configuration
+sidebar_position: 24
+---
+** ConfigurationRestfulApi class **
+
+
+
+
+## Add KeyForEngine
+
+
+**Interface address**:`/api/rest_j/v1/configuration/addKeyForEngine`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Add KeyForEngine</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|engineType|engineType|query|false|string||
+|keyJson|keyJson|query|false|string||
+|token|token|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Add application type
+
+
+**Interface address**:`/api/rest_j/v1/configuration/createFirstCategory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Add application type tag</p>
+
+**Request example**:
+````javascript
+{
+ "categoryName": "",
+ "description": ""
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|categoryName|Reference type label name||false|String|String|
+|description|Description||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**:
+````javascript
+{
+ "method": "/api/configuration/createFirstCategory",
+ "status": 0,
+ "message": "OK",
+ "data": {}
+}
+````
+
+
+## Add parameter configuration
+
+
+**Interface address**:`/api/rest_j/v1/configuration/createSecondCategory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Add parameter configuration</p>
+
+**Request example**:
+````javascript
+{
+ categoryId: ,
+ description: "",
+ engineType: "",
+ version: ""
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|categoryId|Parameter ConfigurationId||true|String|String|
+|description|Description||true|String|String|
+|engineType|Engine Type||true|String|String|
+|version|version number||true|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**:
+````javascript
+{
+ "method": "/api/configuration/createSecondCategory",
+ "status": 0,
+ "message": "OK",
+ "data": {}
+}
+````
+
+
+## delete configuration
+
+
+**Interface address**: `/api/rest_j/v1/configuration/deleteCategory`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete parameter configuration</p>
+
+**Request example**:
+````javascript
+{
+ categoryId:
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|categoryId|Parameter ConfigurationId||String|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**:
+````javascript
+{
+ "method": "/api/configuration/deleteCategory",
+ "status": 0,
+ "message": "OK",
+ "data": {}
+}
+````
+
+
+## Engine type list
+
+
+**Interface address**:`/api/rest_j/v1/configuration/engineType`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get a list of engine types</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": "/api/configuration/engineType",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "engineType": []
+ }
+}
+````
+## App types
+
+
+**Interface address**: `/api/rest_j/v1/configuration/getCategory`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Apply type tag in parameter configuration</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": "/api/configuration/getCategory",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "Category": [{
+ "categoryId": ,
+ "labelId": ,
+ "categoryName": "",
+ "childCategory": [],
+ "description": null,
+ "tag": null,
+ "createTime": ,
+ "updateTime": ,
+ "level": ,
+ "fatherCategoryName": ""
+ }],
+ "description": null,
+ "tag": null,
+ "createTime": ,
+ "updateTime": ,
+ "level": ,
+ "fatherCategoryName":
+ }]
+}
+}
+````
+
+
+## queue resources
+
+
+**Interface address**:`/api/rest_j/v1/configuration/getFullTreesByAppName`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>The queue resource module in the parameter configuration returns the column and value of the queue resource</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|label name|query|false|string||
+|engineType|engineType|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "method": "/api/configuration/getFullTreesByAppName",
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "fullTree": [{
+ "name": "Queue Resource",
+ "description": null,
+ "settings": [{
+ "id": ,
+ "key": "",
+ "description": "",
+ "name": "",
+ "defaultValue": "",
+ "validateType": "",
+ "validateRange": "[]",
+ "level": 1,
+ "engineType": ,
+ "treeName": "",
+ "valueId": ,
+ "configValue": "",
+ "configLabelId": ,
+ "unit": null,
+ "isUserDefined": ,
+ "hidden": ,
+ "advanced":
+ }]
+ }]
+ }
+}
+````
+
+
+## Get key value
+
+
+**Interface address**:`/api/rest_j/v1/configuration/keyvalue`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get key value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|configKey|configKey|query|true|string||
+|creator|creator|query|false|string||
+|engineType|engineType|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## save key value
+
+
+**Interface address**:`/api/rest_j/v1/configuration/keyvalue`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Save key value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|configKey|configKey||true|String|String|
+|configValue|configValue||true|String|String|
+|creator|creator||true|String|String|
+|engineType|engineType||true|String|String|
+|version|version||true|String|String|
+|SaveKeyValue|json|body|true|SaveKeyValue|SaveKeyValue|
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## delete key value
+
+
+**Interface address**:`/api/rest_j/v1/configuration/keyvalue`
+
+
+**Request method**: `DELETE`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Delete key value</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|configKey|configKey||true|String|String|
+|creator|creator||true|String|String|
+|engineType|engineType||true|String|String|
+|version|version||true|String|String|
+|DeleteKeyValue|json|body|true|DeleteKeyValue|DeleteKeyValue|
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## rpc test
+
+
+**Interface address**: `/api/rest_j/v1/configuration/rpcTest`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>rpc test</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|creator|query|false|string||
+|engineType|engineType|query|false|string||
+|username|username|query|false|string||
+|version|version|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Save queue resources
+
+
+**Interface address**:`/api/rest_j/v1/configuration/saveFullTree`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Save queue resources</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|App Type Name||String|true|String|
+|description|Description, belonging to the content in fullTree||String|true|String|
+|engineType|Engine Type||String|true|String|
+|fullTree|Details under Application Type||List|true|List|
+|name|Queue resource name, which belongs to the content in fullTree||String|true|String|
+|settings|Detailed content in the queue resource, belonging to the content in fullTree||List|true|List|
+
+
+**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**:
+````javascript
+{
+ "method": "/api/configuration/saveFullTree",
+ "status": 0,
+ "message": "OK",
+ "data": {}
+}
+````
+
+
+## Update category information
+
+
+**Interface address**: `/api/rest_j/v1/configuration/updateCategoryInfo`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Update category information</p>
+
+
+**Sample Response**:
+````javascript
+{
+ description: "",
+ categoryId:
+}
+````
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|categoryId|categoryId||String|true|String|
+|description|description||String|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**:
+````javascript
+{
+ "method": "/api/configuration/updateCategoryInfo",
+ "status": 0,
+ "message": "OK",
+ "data": {}
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/resource-management-api.md b/docs/api/http/resource-management-api.md
new file mode 100644
index 000000000..5b08842b1
--- /dev/null
+++ b/docs/api/http/resource-management-api.md
@@ -0,0 +1,606 @@
+---
+title: Resource Management
+sidebar_position: 12
+---
+** 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**:<p>All user resources</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": null,
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "total": 34,
+ "resources": [{
+ "id": ,
+ "username": "",
+ "creator": "",
+ "engineTypeWithVersion": "",
+ "resourceType": "",
+ "maxResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "minResource": {
+ "memory": ,
+ "cores": "instance": 0
+ },
+ "usedResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "lockedResource": {
+ "memory": 0,
+ "cores": 0,
+ "instance": 0
+ },
+ "expectedResource": null,
+ "leftResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "createTime": ,
+ "updateTime": ,
+ "loadResourceStatus": "",
+ "queueResourceStatus":
+ }]
+ }
+}
+````
+
+
+## Application List
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/rm/applicationlist`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get the list of application engines in resource management</p>
+
+**Request example**:
+````javascript
+{
+ userCreator: ""
+}
+````
+
+**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**:
+````javascript
+{
+ "method": ,
+ "status": ,
+ "message": "",
+ "data": {
+ "applications": [{
+ "creator": "",
+ "applicationList": {
+ "usedResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "maxResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "lockedResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "minResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "engineInstances": [{
+ "resource": {
+ "resourceType": "",
+ "maxResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "minResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "usedResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "lockedResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ },
+ "expectedResource": null,
+ "leftResource": {
+ "memory": ,
+ "cores": ,
+ "instance":
+ }
+ },
+ "engineType": "",
+ "owner": "",
+ "instance": "",
+ "creator": "",
+ "startTime": "",
+ "status": "",
+ "label": ""
+ }]
+ }
+ }]
+ }
+}
+````
+
+## 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**:<p>Engine Type</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Engine manager
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/rm/engines`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface Description**:<p>Engine Manager</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## queue manager
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/rm/queueresources`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Queue Manager</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## queue
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/rm/queues`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Queue</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## 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**:<p>Reset resources</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Resource information
+
+
+**Interface address**: `/api/rest_j/v1/linkisManager/rm/userresources`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Query resource list and detailed resource data such as usage percentage</p>
+
+
+
+**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**:
+````javascript
+{
+ "method": null,
+ "status": 0,
+ "message": "OK",
+ "data": {
+ "userResources": [{
+ "userCreator": "",
+ "engineTypes": [{
+ "engineType": "",
+ "percent": ""
+ }],
+ "percent": ""
+ }]
+ }
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/rpc-api.md b/docs/api/http/rpc-api.md
new file mode 100644
index 000000000..abf38435c
--- /dev/null
+++ b/docs/api/http/rpc-api.md
@@ -0,0 +1,183 @@
+---
+title: RPC Interface
+sidebar_position: 13
+---
+** RPCReceiveRestful class **
+
+
+
+## take over
+
+
+**Interface address**:`/api/rest_j/v1/rpc/receive`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>rpc receive</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Receive and reply
+
+
+**Interface address**: `/api/rest_j/v1/rpc/receiveAndReply`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>rpc receive and reply</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Reply
+
+
+**Interface address**: `/api/rest_j/v1/rpc/replyInMills`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>rpc reply</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/task-management-api.md b/docs/api/http/task-management-api.md
new file mode 100644
index 000000000..6db65eb49
--- /dev/null
+++ b/docs/api/http/task-management-api.md
@@ -0,0 +1,128 @@
+---
+title: Task Management
+sidebar_position: 8
+---
+** EntranceMetricRestfulApi class **
+
+
+# Task management
+
+
+## start task
+
+
+**Interface address**:`/api/rest_j/v1/entrance/api/metrics/runningtask`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Start task</p>
+
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## task info
+
+
+**Interface address**:`/api/rest_j/v1/entrance/api/metrics/taskinfo`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Task information</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|creator|Creator|query|false|string||
+|engineTypeLabel|Engine Type Label|query|false|string||
+|user|user|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/api/http/task-operation-api.md b/docs/api/http/task-operation-api.md
new file mode 100644
index 000000000..77b9b3c67
--- /dev/null
+++ b/docs/api/http/task-operation-api.md
@@ -0,0 +1,565 @@
+---
+title: Task Action
+sidebar_position: 7
+---
+** EntranceRestfulApi class **
+
+
+## process task request
+
+
+**Interface address**:`/api/rest_j/v1/entrance/execute`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>The execute function handles the request submitted by the user to execute the task</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|json|json|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Submit the execute function
+
+
+**Interface address**:`/api/rest_j/v1/entrance/submit`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Submit execute function</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|Submit|json|body|true|Submit|Submit|
+
+
+**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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## end task
+
+
+**Interface address**: `/api/rest_j/v1/entrance/{id}/kill`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>kill task</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|ID|path|false|string||
+|taskID|taskID|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## End Jobs
+
+
+**Interface address**: `/api/rest_j/v1/entrance/{id}/killJobs`
+
+
+**Request method**: `POST`
+
+
+**Request data type**: `application/json`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>End Jobs</p>
+
+**Request example**:
+````javascript
+{
+ "taskIDList": [],
+ "idList": []
+}
+````
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|id request path generation |path|true|string||
+|taskIDList|collection of task IDs||false|String|String|
+|idList|ID 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**:
+````javascript
+{
+ "method": "/api/entrance/#id/killJobs",
+ "status": 0,
+ "message": "success",
+ "data": {
+ "messages": [{
+ "method": "",
+ "status": 0,
+ "message": "",
+ "data": {
+ "execID": ""
+ }
+ }]
+ }
+}
+````
+
+
+## task log
+
+
+**Interface address**: `/api/rest_j/v1/entrance/{id}/log`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Get task log</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|Task ID|path|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Pause task
+
+
+**Interface address**:`/api/rest_j/v1/entrance/{id}/pause`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Pause task</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|Task ID|path|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## Mission progress
+
+
+**Interface address**:`/api/rest_j/v1/entrance/{id}/progress`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Task progress</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|Task ID|path|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+## Resource progress
+
+
+**Interface address**:`/api/rest_j/v1/entrance/{id}/progressWithResource`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Resource progress</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|ID|path|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
+
+
+## task status
+
+
+**Interface address**:`/api/rest_j/v1/entrance/{id}/status`
+
+
+**Request method**: `GET`
+
+
+**Request data type**: `application/x-www-form-urlencoded`
+
+
+**Response data type**: `*/*`
+
+
+**Interface description**:<p>Task status</p>
+
+
+
+**Request Parameters**:
+
+
+| Parameter name | Parameter description | Request type | Required | Data type | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|id|ID|path|false|string||
+|taskID|taskID|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**:
+````javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+````
\ No newline at end of file
diff --git a/docs/development/linkis_debug.md b/docs/development/linkis_debug.md
index ca8922013..badade25b 100644
--- a/docs/development/linkis_debug.md
+++ b/docs/development/linkis_debug.md
@@ -91,7 +91,7 @@ Modify the port:
server:
port: 8080 ##Started port
```
-#####The specific configuration is as follows
+##### The specific configuration is as follows
Old version idea configuration
@@ -110,7 +110,7 @@ org.apache.linkis.gateway.springcloud.LinkisGatewayApplication
[VM Opitons]
-DserviceName=linkis-mg-gateway -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-[User classpath of module]
+[Use classpath of module]
linkis-gateway-server-support
```
@@ -127,8 +127,10 @@ org.apache.linkis.filesystem.LinkisPublicServiceApp
[VM Opitons]
-DserviceName=linkis-ps-publicservice -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-[User classpath of module]
-linkis-filesystem
+[Use classpath of module]
+#linkis < 1.1.0 by linkis-jobhistory
+#linkis >= 1.1.0 by linkis-storage-script-dev-server
+linkis-storage-script-dev-server
```
### Linkis-ps-cs startup configuration
@@ -140,7 +142,7 @@ org.apache.linkis.cs.server.LinkisCSApplication
[VM Opitons]
-DserviceName=linkis-ps-cs -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-[User classpath of module]
+[Use classpath of module]
linkis-cs-server
```
@@ -155,7 +157,7 @@ org.apache.linkis.manager.am.LinkisManagerApplication
[VM Opitons]
-DserviceName=linkis-cg-linkismanager -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-[User classpath of module]
+[Use classpath of module]
linkis-application-manager
```
### linkis-cg-entrance start
@@ -166,7 +168,7 @@ org.apache.linkis.entrance.LinkisEntranceApplication
[VM Opitons]
-DserviceName=linkis-cg-entrance -Xbootclasspath/a:D:\yourDir\incubator-linkis\assembly-combined-package\assembly-combined\conf
-[User classpath of module]
+[Use classpath of module]
linkis-entrance
```
@@ -226,3 +228,4 @@ As shown in the figure below, open the window and configure the port, service an
### 4. Start debugging
click the debugging button, and the following information appears, which means you can start debugging
+y
\ No newline at end of file
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/api/http/bm-operation-management-api.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/api/http/bm-operation-management-api.md
new file mode 100644
index 000000000..79c4fc2c5
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/api/http/bm-operation-management-api.md
@@ -0,0 +1,450 @@
+---
+title: BM项目操作管理
+sidebar_position: 19
+---
+** BmlProjectRestful 类 **
+
+
+
+
+## 附件资源项目
+
+
+**接口地址**:`/api/rest_j/v1/bml/attachResourceAndProject`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>附件资源项目</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|projectName|项目名称||false|String|String|
+|resourceId|资源名称||false|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 创建Bml项目
+
+
+**接口地址**:`/api/rest_j/v1/bml/createBmlProject`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>创建Bml项目</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|accessUsers|访问用户||false|String|String|
+|editUsers|编辑用户||false|String|String|
+|projectName|项目名称||false|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 下载共享资源
+
+
+**接口地址**:`/api/rest_j/v1/bml/downloadShareResource`
+
+
+**请求方式**:`GET`
+
+
+**请求数据类型**:`application/x-www-form-urlencoded`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>下载共享资源</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|资源ID|query|false|string||
+|version|版本|query|false|string||
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 项目信息
+
+
+**接口地址**:`/api/rest_j/v1/bml/getProjectInfo`
+
+
+**请求方式**:`GET`
+
+
+**请求数据类型**:`application/x-www-form-urlencoded`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>获取项目信息</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|projectName|项目名称|query|false|string||
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 更新项目用户
+
+
+**接口地址**:`/api/rest_j/v1/bml/updateProjectUsers`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>更新项目用户</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|jsonNode|jsonNode|body|true|JsonNode|JsonNode|
+|accessUsers|访问用户||false|String|String|
+|editUsers|编辑用户||false|String|String|
+|projectName|项目名称||false|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 更新共享资源
+
+
+**接口地址**:`/api/rest_j/v1/bml/updateShareResource`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`multipart/form-data`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>更新共享资源</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|file|文件|formData|false|ref||
+|resourceId|资源ID|query|false|string||
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 上载共享资源
+
+
+**接口地址**:`/api/rest_j/v1/bml/uploadShareResource`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>上载共享资源</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|expireTime|失效时间|query|false|string||
+|expireType|失效类型|query|false|string||
+|file|文件集合|formData|false|ref||
+|isExpire|是否失效|query|false|string||
+|maxVersion|mav版本|query|false|ref||
+|projectName|项目名称|query|false|string||
+|resourceHeader|资源标头|query|false|string||
+|system|系统|query|false|string||
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/api/http/bml-resource-management-api.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/api/http/bml-resource-management-api.md
new file mode 100644
index 000000000..4aec09fed
--- /dev/null
+++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/api/http/bml-resource-management-api.md
@@ -0,0 +1,812 @@
+---
+title: bml资源管理
+sidebar_position: 22
+---
+** BmlRestfulApi 类 **
+
+
+
+## 更新owner
+
+
+**接口地址**:`/api/rest_j/v1/bml/changeOwner`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>更新owner</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|newOwner|旧Owner||false|String|String|
+|oldOwner|新Owner||false|String|String|
+|resourceId|资源Id||false|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 复制资源到其他用户
+
+
+**接口地址**:`/api/rest_j/v1/bml/copyResourceToAnotherUser`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>复制资源到指定用户</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|anotherUser|指定用户||false|String|String|
+|resourceId|资源Id||false|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 删除资源
+
+
+**接口地址**:`/api/rest_j/v1/bml/deleteResource`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>删除版本</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|资源Id||true|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 删除多个资源
+
+
+**接口地址**:`/api/rest_j/v1/bml/deleteResources`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>删除多个资源</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceIds|资源Id集合，删除多个资源||true|List|List|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
+## 删除版本
+
+
+**接口地址**:`/api/rest_j/v1/bml/deleteVersion`
+
+
+**请求方式**:`POST`
+
+
+**请求数据类型**:`application/json`
+
+
+**响应数据类型**:`*/*`
+
+
+**接口描述**:<p>删除版本</p>
+
+
+
+**请求参数**:
+
+
+| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 | schema |
+| -------- | -------- | ----- | -------- | -------- | ------ |
+|resourceId|资源Id||true|String|String|
+|version|版本||true|String|String|
+
+
+**响应状态**:
+
+
+| 状态码 | 说明 | schema |
+| -------- | -------- | ----- |
+|200|OK|Message|
+|201|Created||
+|401|Unauthorized||
+|403|Forbidden||
+|404|Not Found||
+
+
+**响应参数**:
+
+
+| 参数名称 | 参数说明 | 类型 | schema |
+| -------- | -------- | ----- |----- |
+|data|数据集|object||
+|message|描述|string||
+|method|请求url|string||
+|status|状态|integer(int32)|integer(int32)|
+
+
+**响应示例**:
+```javascript
+{
+ "data": {},
+ "message": "",
+ "method": "",
+ "status": 0
+}
+```
+
+
... 8802 lines suppressed ...
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@linkis.apache.org
For additional commands, e-mail: commits-help@linkis.apache.org