diff --git "a/zh_CN/\344\275\277\347\224\250\346\226\207\346\241\243/DSS\346\216\245\345\217\243\346\261\207\346\200\273.md" "b/zh_CN/\344\275\277\347\224\250\346\226\207\346\241\243/DSS\346\216\245\345\217\243\346\261\207\346\200\273.md" new file mode 100644 index 0000000..dae92d8 --- /dev/null +++ "b/zh_CN/\344\275\277\347\224\250\346\226\207\346\241\243/DSS\346\216\245\345\217\243\346\261\207\346\200\273.md" @@ -0,0 +1,4146 @@ +### DSS接口汇总 + +#### FlowEntranceRestfulApi + +> 基本信息 + +##### 接口名称：工作流执行 + +**接口路径：**`POST` /api/rest_j/v1/dss/flow/entrance/execute + +> 请求参数 + +**Body:** + +````json +{ + "isReExecute":"" //必填 新增参数，失败重新执行时需要增加此参数 +} +```` + +> 返回参数 + +```json +{ + "status":"", //状态码 + "message":"", //信息 + "data":{ + "taskID":"", //任务ID + "execID":"" //执行ID + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取工作流状态 + +**接口路径：**`POST` /api/rest_j/v1/flow/entrance/{id}/status + +> 请求参数 + +**Body:** + +````json +{ + "id":"", //必填 + "taskID":"" //任务ID +} +```` + +> 返回参数 + +````json +{ + "status":"", //状态码 + "message":"", //信息 + "data":{ + "taskID":"", //任务ID + "execID":"" //执行ID + } +} +```` + + + +> 基本信息 + +##### 接口名称：结束工作流 + +**接口路径：**`GET` /api/rest_j/v1/dss/flow/entrance/{id}/killWorkflow + +> 请求参数 + +**Body:** + +````json +{ + "taskID":"" //必填 +} +```` + +> 响应参数 + +````json +{ + "massage":"", + "data":{ + "result":"", + "errorInfo":"" + } +} +```` + +--- + +#### FremeworkReleaseRestful + +> 基本信息 + +##### 接口名称：获取任务进度 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/release/getReleaseStatus + +> 请求参数 + +**Body:** + +````json +{ + "dssLabel":"", //必填 dssLabel + "releaseTaskId":"" //必填 查询的发布id +} +```` + +> 响应参数 + +````json +{ + "massage":"", + "data":{ + "status":"", + "errorMsg":"" + } +} +```` + + + +> 基本信息 + +##### 接口名称：提交发布任务 + +**接口路径：**`POST` /api/rest_j/v1/dss/framework/release/releaseOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "orchestratorId":"", //必填 编排模式id + "orchestratorVersionId":"", //必填 编排模式版本id + "comment":"", //必填 发布注释 + "dssLabel":"" //必填 dssLabel +} +``` + +> 响应参数 + +````json +{ + "massage":"", + "data":"" +} +```` + +---- + +#### ApiServiceCoreRestfulApi + +> 基本信息 + +##### 接口名称：提交API + +**接口路径：**`POST`/api/rest_j/v1/dss/apiservice/api + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "status":"", + "message":"", + "data":{ + "insert_id":"", + "approval_no":{ + "id":"", + "apiId":"", + "apiVersionId":"", //api版本id + "approvalName":"", + "applyUser":"", + "executeUser":"", //执行用户 + "creator":"", + "status":"", + "createTime":"", + "updateTime":"", + "approvalNo":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：创建api + +**接口路径：**`POST`/api/rest_j/v1/dss/apiservice/create + +> 请求参数 + +**Body:** + +```json +{ + "aliasName":"", //服务中文名称 + "scriptPath":"", //脚本路径 + "content":"", //脚本内容 + "workspaceId":"", //工作空间ID + "metadata":{ + "configuration":{ + "datasource":{} //数据源 + } + } + "approvalVo":{ + "applayUser":"" //申请用户名字 + } +} +``` + +> 响应参数 + +```json +{ + "status":"", //状态吗 + "message":"", //消息 + "data":{ + "insert_id":"", //插入id + "approval_no":{ + "id":"", + "apiId":"", + "apiVersionId":"", //api版本id + "approvalName":"", + "applyUser":"", //申请用户 + "executeUser":"", + "creator":"", //创建者 + "status":"", //状态 + "createTime":"", //创建时间 + "updateTime":"", //更新时间 + "approvalNo":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：更新服务器api + +**接口路径：**`PUT`/api/rest_j/v1/dss/apiservice/api/{api_service_version_id} + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "status":"", //状态吗 + "message":"", //消息 + "data":{ + "update_id":"" //更新id + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询服务api + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/search + +> 请求参数 + +**Body:** + +```json +{ + "name":"", //服务名称(选填) + "tag":"", //标签（选填） + "status":"", //状态（选填） + "creator":"", //创建人（选填） + "workspaceId":"" //工作空间id（选填） +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "query_list":[{ + "id":"", + "name":"", + "aliasName":"", + "path":"", + "protocol":"", + "method":"", + "tag":"", + "scope":"", + "description":"", + "status":"", + "type":"", + "runType":"", + "createTime":"", + "modifyTime":"", + "creator":"", + "modifier":"", + "scriptPath":"", + "approvalVo":{}, + "latestVersionId":"", + "userToken":"", + "params":[{}], + "metadata":{}, + "content":"", + "versionVos":[], + "workspaceId":"", + "targetServiceId":"", + "comment":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询用户服务api + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/getUserServices + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"" //工作空间Id +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "query_list":[{ + "id":"", + "name":"", + "aliasName":"", + "path":"", + "protocol":"", + "method":"", + "tag":"", + "scope":"", + "description":"", + "status":"", + "type":"", + "runType":"", + "createTime":"", + "modifyTime":"", + "creator":"", + "modifier":"", + "scriptPath":"", + "approvalVo":{}, + "latestVersionId":"", + "userToken":"", + "params":[{}], + "metadata":{}, + "content":"", + "versionVos":[], + "workspaceId":"", + "targetServiceId":"", + "comment":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取tag + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/tags + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"" //工作空间Id +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "tags":[] + } +} +``` + + + +> 基本信息 + +##### 接口名称：根据脚本路径查询API + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/query + +> 请求参数 + +**Body:** + +```json +{ + "scriptPath":"" //必填 脚本路径 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "method":"", + "data":{ + "result":{ + "id":"", + "name":"", + "aliasName":"", + "path":"", + "protocol":"", + "method":"", + "tag":"", + "scope":"", + "description":"", + "status":"", + "type":"", + "runType":"", + "createTime":"", + "modifyTime":"", + "creator":"", + "modifier":"", + "scriptPath":"", + "approvalVo":{}, + "latestVersionId":"", + "userToken":"", + "params":[{}], + "metadata":{}, + "content":"", + "versionVos":[], + "workspaceId":"", + "targetServiceId":"", + "comment":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询服务byId + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/queryById + +> 请求参数 + +**Body:** + +```json +{ + "id":"" +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":{ + "id":"", + "name":"", + "aliasName":"", + "path":"", + "protocol":"", + "method":"", + "tag":"", + "scope":"", + "description":"", + "status":"", + "type":"", + "runType":"", + "createTime":"", + "modifyTime":"", + "creator":"", + "modifier":"", + "scriptPath":"", + "approvalVo":{}, + "latestVersionId":"", + "userToken":"", + "params":[{}], + "metadata":{}, + "content":"", + "versionVos":[], + "workspaceId":"", + "targetServiceId":"", + "comment":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：确认路径 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/queryById + +> 请求参数 + +**Body:** + +```json +{ + "scriptPath":"", //必填 脚本路径 + "path":"" //api路径 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":0 + } +} +``` + + + +> 基本信息 + +##### 接口名称：确认名字 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/checkName + +> 请求参数 + +**Body:** + +```json +{ + "name":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：禁用api + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiDisable + +> 请求参数 + +**Body:** + +```json +{ + "id":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：启用api + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiEnable + +> 请求参数 + +**Body:** + +```json +{ + "id":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：删除api + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiDelete + +> 请求参数 + +**Body:** + +```json +{ + "id":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：更新评论 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiCommentUpdate + +> 请求参数 + +**Body:** + +```json +{ + "id":"", //必填 + "comment":"" +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询api信息 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiParamQuery + +> 请求参数 + +**Body:** + +```json +{ + "scriptPath":"", //必填 + "versionId":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":[{ + "typeStr":"", + "requireStr":"", + "testValue":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询api版本 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiVersionQuery + +> 请求参数 + +**Body:** + +```json +{ + "serviceId":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":[{ + "id":"", + "apiId":"", + "version":"", + "bmlResourceId", + "bmlVersion":"", + "source":"", + "creator":"", + "createTime":"", + "metadataInfo":"", + "authId":"", + "status":"", + "paramVos":[] + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询api版本内容 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/apiContentQuery + +> 请求参数 + +**Body:** + +```json +{ + "versionId":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "status":"", + "method":"", + "data":{ + "result":{ + "id":"", + "name":"", + "aliasName":"", + "path":"", + "protocol":"", + "method":"", + "tag":"", + "scope":"", + "description":"", + "status":"", + "type":"", + "runType":"", + "createTime":"", + "modifyTime":"", + "creator":"", + "modifier":"", + "scriptPath":"", + "approvalVo":{}, + "latestVersionId":"", + "userToken":"", + "params":[{}], + "metadata":{}, + "content":"", + "versionVos":[], + "workspaceId":"", + "targetServiceId":"", + "comment":"" + } + } +} +``` + +---- + +#### WebankDSSFrameworkProjectRestfulApi + +> 基本信息 + +##### 接口名称：复制工程 + +**接口路径：**`POST` /api/rest_j/v1/dss/framework/project/copyProject + +> 请求参数 + +**Body:** + +```json +{ + "projectId":"", + "copyProjectName":"", + "workspaceId":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "projectId":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取复制工程信息 + +**接口路径：**`POST` /api/rest_j/v1/dss/framework/project/getCopyProjectInfo + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"", + "copyProjectId":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "surplusCount":"", + "sumCount":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：通过OPS将工程交接给新用户 + +**接口路径：**`POST` /api/rest_j/v1/dss/framework/project/handoverWorkflowsByOps + +> 请求参数 + +**Body:** + +```json +{ + "recipient":"", //必填 权限接收者 + "type":"", //必填 交接类型 + "workspaceName":"", + "projectName":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "result":"", + "errorInfo":"" + } +} +``` + +--- + +#### ApiServiceTokenResfulApi + +> 基本信息 + +##### 接口名称：token查询 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/tokenQuery + +> 请求参数 + +**Body:** + +```json +{ + "apiId":"", + "user":"", + "status":"", + "startDate":"", + "endDate":"", + "currentPage":1, + "pageSize":10 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "queryList":[ + "id":"", + "apiId":"", + "apiVersionId":"", + "publisher":"", + "user":"", + "applyTime":"", + "duration":"", + "reason":"", + "ipWhitelist":"", + "status":"", + "caller":"", + "accessLimit":"", + "token":"", + "applySource":"" + ] + } +} +``` + + + +> 基本信息 + +##### 接口名称：刷新申请单 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/approvalRefresh + +> 请求参数 + +**Body:** + +```json +{ + "approvalNo":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "approvalStatus":"" + } +} +``` + +--- + +#### ApiServiceExecuteRestfulApi + +> 基本信息 + +##### 接口名称：执行DELETE方法 + +**接口路径：**`DELETE` /api/rest_j/v1/dss/apiservice/execute/{path:.*} + +> 请求参数 + +**Body:** + +```json +{ + "moduleName":"", //必填 + "params":{ + "ApiServiceToken":"" //必填 + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "taskId":"", + "execId":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：执行post方法 + +**接口路径：**`POST` /api/rest_j/v1/dss/apiservice/execute/{path:.*} + +> 请求参数 + +**Body:** + +```json +{ + "moduleName":"", //必填 + "params":{ + "ApiServiceToken":"" //必填 + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "taskId":"", + "execId":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：执行get方法 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/execute/{path:.*} + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "taskId":"", + "execId":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：执行PUT方法 + +**接口路径：**`PUT` /api/rest_j/v1/dss/apiservice/execute/{path:.*} + +> 请求参数 + +**Body:** + +```json +{ + "moduleName":"", //必填 + "params":{ + "ApiServiceToken":"" //必填 + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "taskId":"", + "execId":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：执行任务查询 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/{id}/get + +> 请求参数 + +**Body:** + +```json +{ + "id":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "task":"" + } +} +``` + + + + + +> 基本信息 + +##### 接口名称：打开文件 + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/openFile + +> 请求参数 + +**Body:** + +```json +{ + "path":"", //必填 + "taskId":"", //必填 + "page":1, + "pageSize":10, + "charset":"utf-8" +} +``` + +> 响应参数 + +```json +{[ + "path":"", + "user":"", + "pageSize":"" +]} +``` + + + +> 基本信息 + +##### 接口名称：结果导出excel + +**接口路径：**`GET` /api/rest_j/v1/dss/apiservice/resultsetToExcel + +> 请求参数 + +**Body:** + +```json +{ + "path":"", //必填 + "taskId":"", //必填 + "charset":"utf-8", + "outputFileType":"csv", + "csvSeperator":"", + "outputFileName":"downloadResultset", + "sheetName":"result", + "nullValue":"NULL" +} +``` + +> 响应参数 + +```json +{} +``` + +--- + +#### DssDemandsRestful + +> 基本信息 + +##### 接口名称：需求列表查询 + +**接口路径：**`GET` /api/rest_j/v1/mide/projects/{projectId}/demands/list + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "method":"", + "status":"", + "message":"", + "data":{ + "demands":[ + { + "name":"", + "content":"", + "business":null, + "usage":"", + "developer":"", + "id":1 + } + ] + } +} +``` + + + +> 基本信息 + +##### 接口名称：需求查询 + +**接口路径：**`GET` /api/rest_j/v1/mide/projects/{projectId}/demands/{id} + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "method":"", + "status":"", + "message":"", + "data":{ + "demands":{ + "name":"", + "content":"", + "business":null, + "usage":"", + "developer":"", + "id":1 + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：需求删除 + +**接口路径：**`DELETE` /api/rest_j/v1/mide/projects/{projectId}/demands/{id} + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "method":"", + "status":"", + "message":"" +} +``` + + + +> 基本信息 + +##### 接口名称：需求新增 + +**接口路径：**`PUT` /api/rest_j/v1/mide/projects/{projectId}/demands/{id} + +> 请求参数 + +**Body:** + +```json +{ + "id":"", + "name":"", + "content":"", + "business":"", + "usage":"", + "developer":"", + "projectId":"", + "creator":"", + "modifier":"" +} +``` + +> 响应参数 + +```json +{ + "method":"", + "status":"", + "message":"", + "data":{ + "id":"", + "projectId":"" + } +} +``` + +--- + +#### SchemaInfoRestful + +> 基本信息 + +##### 接口名称：获取数据库信息 + +**接口路径：**`GET` /api/rest_j/v1/dss/datapipe/datasource/getSchemaBaseInfo + +> 请求参数 + +**Body:** + +```json +{ + "dbName":"" //必填 数据库名 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "schemaInfo":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取数据库元数据信息 + +**接口路径：**`GET` /api/rest_j/v1/dss/datapipe/datasource/getTableMetaDataInfo + +> 请求参数 + +**Body:** + +```json +{ + "dbName":"", //必填 数据库名 + "tableName":"", + "orderBy":"", + "pageSize":"", + "currentPage":"", + "isTableOwner":"" //0表示默认值我有权限的表，1表示我创建的表 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "currentPage":"", + "pageSize":"", + "total":"", + "tableList":[{ + "id":"", + "tableName":"", + "tableAlias":"", + "createTime":"", + "tableSize":"", + "tableOwner":"", + "partitioned":"", + "compressedFormat":"", + "viewTime":"", + "modifyTime":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取数据库表名 + +**接口路径：**`GET` /api/rest_j/v1/dss/datapipe/datasource/getTablesName + +> 请求参数 + +**Body:** + +```json +{ + "dbName":"", //必填 数据库名 + "tableName":"", + "orderBy":"", + "isTableOwner":"" //0表示默认值我有权限的表，1表示我创建的表 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "tablesName":[] + } +} +``` + +--- + +#### WebankOrchestratorRestful + +> 基本信息 + +##### 接口名称：获取执行历史 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getExecutionHistory + +> 请求参数 + +**Body:** + +```json +{ + "appId":"", //必填 工作流id + "orchestratorId":"", + "projectId":"", + "workspaceId":"", + "labels":{}, + "currentPage":"", + "pageSize":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "executionHistory":"", + "totalPage":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取发布历史 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getReleaseHistory + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"", + "projectId":"", + "orchestratorId":"", //必填 编排ID + "releaseUser":"", + "startTime":"", + "endTime":"", + "comment":"", + "labels":{}, + "currentPage":"", + "pageSize":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "releaseDetails":"", + "totalPage":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取发布人 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getReleaseUserList + +> 请求参数 + +**Body:** + +```json +{ + "orchestratorId":"", //必填 编排ID + "labels":{} +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "releaseUserList":[] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取编排版本 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getOrchestratorVersionList + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"", + "projectId":"", + "orchestratorId":"", //必填 编排ID + "labels":{}, + "currentPage":1, + "pageSize":10, + "releaseUser":"", + "startTime":"", + "endTime":"", + "comment":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "releaseDetails":"", + "totalPage":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取编排版本创建人 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getOrchestratorVersionUserList + +> 请求参数 + +**Body:** + +```json +{ + "orchestratorId":"", //必填 编排ID + "labels":{} +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "releaseUserList":[] + } +} +``` + + + +> 基本信息 + +##### 接口名称：比较两个工作流 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/compareOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "firstVersionId":"", //必填 第一个版本ID + "labels":{}, + "secondVersionId":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "list":[] + } +} +``` + +--- + +#### ContextServiceRestful + +> 基本信息 + +##### 接口名称：表查询 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/tables + +> 请求参数 + +**Body:** + +```json +{ + "contextID":"", //ID + "nodeName":"", //节点名 + "labels":{ + "route":"" + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "tables":[] + } +} +``` + + + +> 基本信息 + +##### 接口名称：列查询 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/columns + +> 请求参数 + +**Body:** + +```json +{ + "contextID":"", + "nodeName":"", + "contextKey":"", + "labels":{ + "route":"" + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "columns":[] + } +} +``` + +--- + +#### DSSDictionaryRestful + +> 基本信息 + +##### 接口名称：数据字典 - 根据key获取 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/getDicList + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"", //必填 空间id + "dicKey":"", + "parentKey":"" //父key +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "list":[{ + "id":0, + "workspaceId":0, //空间id + "parentKey":"", //父key + "dicName":"", //名称 + "dicNameEn":"", //英文名称 + "dicKey":"", //key 相当于编码，空间是w_开头，工程是p_ + "dicValue":"", //key对应的值 + "dicValueEn":"", //key对应的值(英文) + "title":"", //标题 + "titleEn":"", //标题(英文) + "url":"", + "urlType":1, //url类型: 0-内部系统，1-外部系统；默认是内部 + "icon":"", //图标 + "orderNum":1, //序号 + "remark":"", //备注 + "createUser":"", //创建人 + "createTime":"", //创建时间 + "updateUser":"", //更新人 + "updateTime":"" //更新时间 + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取数据字典 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/getDicSecondList + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"", //必填 空间id + "dicKey":"", //key 相当于编码，空间是w_开头，工程是p_ + "parentKey":"" //父key +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "list":[], + "mapList":{} + } +} +``` + +--- + +#### DSSFrameworkOrchestratorRestful + +> 基本信息 + +##### 接口名称：创建编排模式 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/createOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "orchestratorName":"", //必填 编排名称 + "orchestratorMode":"", //编排模式，如工作流，组合编排等 + "orchestratorWays":[], //必填 编排方式 + "orchestratorLevel":"", //编排重要性级别 + "dssLabels":[], + "uses":"", //编排用途 + "description":"", //必填 描述 + "projectName":"", //工程名称 + "workspaceName":"" //工作空间名称 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "orchestratorId":1 + } +} +``` + + + +> 基本信息 + +##### 接口名称：查询所有的编排模式 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getAllOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"", //必填 + "projectId":"", //必填 + "orchestratorMode":"", //编排类型，如工作流，组合编排等 + "orchestratorLevel":"", //编排重要性级别 + "dssLabels":{"route":""} //dssLabels是通过前端进行传入的，主要是用来进行当前的环境信息 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "page":[{ + "id":1, //主键ID + "workspaceId":"", //空间id + "projectId":"", //工程id + "orchestratorId":1, //编排模式id（工作流,调用orchestrator服务返回的orchestratorId） + "orchestratorVersionId":1, //编排模式版本id（工作流,调用orchestrator服务返回的orchestratorVersionId） + "orchestratorName":"", //编排名称 + "orchestratorMode":"", //编排模式，取得的值是dss_dictionary中的dic_key(parent_key=p_orchestratorment_mode) + "uses":"", //用途 + "description":"", //描述 + "createUser":"", //创建人 + "createTime":"", //创建时间 + "updateUser":"", //更新人 + "updateTime":"", //更新时间 + "orchestratorWays":[], //编排方式 + "orchestratorLevel":"", //编排重要性级别 + "flowEditLockExist":false //工作流编辑锁是否退出 + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：修改编排模式 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/modifyOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "id":"", //必填 + "orchestratorName":"", //必填 编排名称 + "orchestratorMode":"", //编排类型，如工作流，组合编排等 + "orchestratorLevel":"", //编排重要性级别 + "uses":"", //编排用途 + "description":"", //必填 描述 + "orchestratorWays":[], //必填 编排方式 + "dssLabels":"" //当前的环境信息 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "orchestratorId":1 + } +} +``` + +> 基本信息 + +##### 接口名称：删除编排模式 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/deleteOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "id":"" //必填 +} +``` + +> 响应参数 + +```json +{ + "massage":"" +} +``` + + + +> 基本信息 + +##### 接口名称：获取编排重要级别列表 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/orchestrator/orchestratorLevels + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "orchestratorLevels":["HIGH","MEDIUM","LOW"], + } +} +``` + +--- + +#### DSSMigrateRestful + +> 基本信息 + +##### 接口名称：导入旧的DSS工程 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/release/importOldDSSProject + +> 请求参数 + +**Body:** + +```json +{ + "file":"" //必填 MultipartFile +} +``` + +> 响应参数 + +```json +{ + "massage":"" +} +``` + + + +> 基本信息 + +##### 接口名称：导入从dss1.0接口导出的工作流 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/release/importworkflow + +> 请求参数 + +**Body:** + +```json +{ + "workspaceName":"", //必填 工作空间 + "projectName":"", //项目名没有就创建 + "projectUser":"", // 项目用户，接口会保证本用户加入到权限列表 + "flowName":"", + "file":"" //导入文件，MultipartFile类型 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "flowId":"", + "bmlVersion":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：导出SQL文件 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/release/exportOrcSqlFile + +> 请求参数 + +**Body:** + +```json +{ + "outputFileName":"", //默认exportOrc + "charset":"utf-8", //编码 默认utf-8 + "outputFileType":"zip", // 输出文件类型 默认zip + "projectName":"", //工程名称 + "orchestratorId":"", //编排id + "orcVersionId":"", //编排版本号ID + "addOrcVersion":false, //是否增加版本号 + "labels":"" //标签 +} +``` + +> 响应参数 + +```json +{} +``` + + + +> 基本信息 + +##### 接口名称：批量导出工程下所有工作流到指定本地目录 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/release/exportallflow + +> 请求参数 + +**Body:** + +```json +{ + "workspaceName":"", //工作空间名 + "projectName":"", //工程名 + "pathRoot":"" //路径 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "count":0, + "location":"", + "serviceInstance":"" + } +} +``` + +--- + +#### DSSSideInfoRestful + +> 基本信息 + +##### 接口名称：获取侧边栏 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/getSideInfos + +> 请求参数 + +**Body:** + +```json +{ + "workspaceID":"" //工作空间id +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "presentations":[{ + "name":"", + "title":"", + "type":"", + "contents":[{ + "name":"", + "title":"", + "url":0, //url类型: 0-内部系统，1-外部系统；默认是内部 + "icon":"" //icon是表示Content的图标，如果为空就是没有 + }] + }] + } +} +``` + +--- + +#### DSSWorkspacePrivRestful + +> 基本信息 + +##### 接口名称：获取工作空间菜单 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/exportOrcSqlFile + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"" //工作空间id +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "workspaceMenuPrivs":{ + "workspaceId":1, + "menuPrivVOS":[{ + "id":"", + "name":"", + "menuPrivs":[{}] + }], + "DSSWorkspaceComponentPrivVO":[{ + "id":"", + "name":"", + "componentPrivs":[{}] + }], + "DSSWorkspaceRoleVO":[{ + "roleId":"", + "roleName":"", + "roleFrontName":"" + }] + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取工作空间设置 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaceHomepageSettings + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"" //工作空间id +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "homepageSettings":{ + "roleName":"", + "homepageName":"", + "homepageUrl":"", + "roleId":1, + "roleFrontName":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：更新角色菜单权限 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/updateRoleMenuPriv + +> 请求参数 + +**Body:** + +```json +{ + "menuId":"", //菜单id + "workspaceId":"", //工作空间id + "menuPrivs":"" //菜单 +} +``` + +> 响应参数 + +```json +{ + "message":"" +} +``` + + + +> 基本信息 + +##### 接口名称：更新组件权限 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/updateRoleComponentPriv + +> 请求参数 + +**Body:** + +```json +{ + "componentId":"", //组件id + "workspaceId":"", //工作空间id + "componentPrivs":"" //组件权限 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "updateRoleComponentPriv":"" + } +} +``` + +--- + +#### DSSWorkspaceRestful + +> 基本信息 + +##### 接口名称：建立工作空间 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/createWorkspace + +> 请求参数 + +**Body:** + +```json +{ + "workspaceName":"", //工作空间名称 + "department":"", //部门 + "description":"", //描述 + "tags":"", //描述 + "productName":"" //产品名称 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "workspaceId":1, + "workspaceName":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取部门列表 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/listDepartments + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "departments":[{ + "id":1, + "name":"", + "frontName":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取工作空间列表 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaces + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "workspaces":[{ + "id":1, + "name":"", + "tags":"", + "department":"", + "description":"", + "product":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取用户工作空间 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaceHomePage + +> 请求参数 + +**Body:** + +```json +{ + "micro_module":"" //模块名 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "workspaceHomePage":{ + "workspaceId":1, + "roleName":"", + "homePageUrl":"" + ] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取工作空间概述 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getOverview + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1 //工作空间ID +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "overview":{ + "title":1, //标题 + "description":"", //描述 + "dssDescription":"", //DSS描述 + "videos":[{ + "id":"", + "title":"", + "url":"" + }], + "demos":[{}] + ] + } +} +``` + + + +> 基本信息 + +##### 接口名称：刷新工作空间缓存 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/refreshCache + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"" +} +``` + +--- + +#### DSSWorkspaceRoleRestful + +> 基本信息 + +##### 接口名称：获取工作空间中所有的角色 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaceRoles + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":"" +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "workspaceRoles":[{ + "roleId":1, + "roleName":"", + "roleFrontName":"" + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：创建工作空间角色 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/addWorkspaceRole + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1, //工作空间id + "roleName":"", //角色名 + "menuIds":[], //菜单id + "componentIds":[] //组件id +} +``` + +> 响应参数 + +```json +{ + "message":"" +} +``` + +--- + +#### DSSWorkspaceUserRestful + + + +> 基本信息 + +##### 接口名称：创建工作空间用户 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaceUsers + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1, //工作空间id + "pageNow":1, //当前页 默认1 + "pageSize":20, //每页数量 默认显示20条 + "department":"", //部门 + "userName":"", //用户名 + "roleName":"" //角色名 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "roles":"", + "workspaceUsers":[{ + "id":"", + "name":"", + "roles":[], + "department":"", + "office":"", + "creator":"", + "joinTime":"" + }], + "total":100 + } +} +``` + + + +> 基本信息 + +##### 接口名称：创建工作空间所有用户 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaceUsers + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "users":{ + "editUsers":[], + "accessUsers":[], + "releaseUsers":[] + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：用户是否退出工作空间 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/existUserInWorkspace + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1, + "queryUserName":"" //查询用户名 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "existFlag":true + } +} +``` + + + +> 基本信息 + +##### 接口名称：添加工作空间用户 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/existUserInWorkspace + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1, + "userName":"", //用户名 + "roles":[], + "userId":"" +} +``` + +> 响应参数 + +```json +{ + "message":"" +} +``` + + + +> 基本信息 + +##### 接口名称：更新工作空间用户 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/updateWorkspaceUser + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1, + "userName":"", //用户名 + "roles":[], + "userId":"" +} +``` + +> 响应参数 + +```json +{ + "message":"" +} +``` + + + +> 基本信息 + +##### 接口名称：删除工作空间用户 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/workspace/updateWorkspaceUser + +> 请求参数 + +**Body:** + +```json +{ + "workspaceId":1, + "userName":"", //用户名 + "roles":[], + "userId":"" +} +``` + +> 响应参数 + +```json +{ + "message":"" +} +``` + + + +> 基本信息 + +##### 接口名称：获取所有用户 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/listAllUsers + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "users":{ + "id":"", + "username":"", + "department":"", + "office":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：根据用户名获取工作空间id + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/workspace/getWorkspaceIdByUserName + +> 请求参数 + +**Body:** + +```json +{ + "userName":"" +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "userWorkspaceIds":"" + } +} +``` + +--- + +#### GuideQueryRestful + +> 基本信息 + +##### 接口名称：获取知识库分组详情 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/query/groupdetail + +> 请求参数 + +**Body:** + +```json +{ + "path":"" //路径 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "result":{ + "id":1, + "path":"", //链接路径 + "title":"", //标题 + "description":"", //描述 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"", //修改时间 + "isDelete":"", //删除表示 + "children":[{ //子类 + "id":1, //id + "groupId":1, //分组id（与上面id一致） + "path":"", //链接路径 + "type":1, //文件类型 + "title":"", //标题 + "titleAlias":"",//别名 + "seq":"", //序列 + "content":"", //内容 + "contentHtml":"", //html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"", //修改时间 + "isDelete":0 //删除标识 + }] + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取知识库分组目录 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/query/guidecatalog/top + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "result":[{ + "id":1, + "parentId":-1, //-1表示最顶层目录 + "title":"", //标题 + "description":"", //描述 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"" //更新时间 + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取学习引导详情 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/query/guidecatalog/{id}/detail + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "result":{ + "id":1, + "childrenCatalog":[{ + "id":1, + "parentId":-1; //-1表示最顶层目录 + "title":"", //标题 + "description":"",//描述 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"",//创建时间 + "updateTime":"" //更新时间 + }], + "childrenChapter":[{ + "id":1, + "catalogId":1, //知识库id + "title":"", //标题 + "titleAlias":"", //别名 + "content":"", //内容 + "contentHtml":"", //html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"" //更新时间 + }] + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：知识库分页查询 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/query/guidechapter + +> 请求参数 + +**Body:** + +```json +{ + "keyword":"", //关键字 + "pageNow":1, //当前页 + "pageSize":20 //显示条数 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "total":20, + "result":[{ + "id":1, + "catalogId":1, //知识库id + "title":"", //标题 + "titleAlias":"", //别名 + "content":"", //内容 + "contentHtml":"", //html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"" //修改时间 + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：知识库详情查询 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/query/guidechapter/{id} + +> 请求参数 + +**Body:** + +```json +{ + "keyword":"", //关键字 + "pageNow":1, //当前页 + "pageSize":20 //显示条数 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "result":{ + "id":1, + "catalogId":1, //知识库id + "title":"", //标题 + "titleAlias":"", //别名 + "content":"", //内容 + "contentHtml":"", //html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"" //修改时间 + } + } +} +``` + +--- + +#### KnowledgGuideAdminRestful + +> 基本信息 + +##### 接口名称：知识库目录保存 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidecatalog + +> 请求参数 + +**Body:** + +```json +{ + "parentId":1; //父级id + "title":"", //标题 + "description":"" //描述 +} +``` + +> 响应参数 + +```json +{ + "message":"" //成功或失败 +} +``` + + + +> 基本信息 + +##### 接口名称：知识库删除 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidecatalog/{id}/delete + +> 请求参数 + +**Body:** + +```json +{ + "id":"" //主键id +} +``` + +> 响应参数 + +```json +{ + "message":"" //成功或失败 +} +``` + + + +> 基本信息 + +##### 接口名称：知识库文档修改 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidechapter + +> 请求参数 + +**Body:** + +```json +{ + "id":1, + "catalogId":1, //知识库id + "title":"", //标题 + "titleAlias":"", //别名 + "content":"", //内容 + "contentHtml":"" //html内容 +} +``` + +> 响应参数 + +```json +{ + "message":"" //成功或失败 +} +``` + + + +> 基本信息 + +##### 接口名称：知识库文档删除 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidechapter/{id}/delete + +> 请求参数 + +**Path:** + +```json +id //主键id +``` + +> 响应参数 + +```json +{ + "message":"" //成功或失败 +} +``` + + + +> 基本信息 + +##### 接口名称：知识库文档查询 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidechapter/{id} + +> 请求参数 + +**Path:** + +``` +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "result":{ + "id":1, + "catalogId":1, //知识库id + "title":"", //标题 + "titleAlias":"", //别名 + "content":"", //内容 + "contentHtml":"", //html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"" //更新时间 + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：知识库多图片上传 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidechapter/uploadImages + +> 请求参数 + +**Body:** + +```json +{ + "files":"" //MultipartFile类型，支持多文件上传 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "result":{ + "result_msg":"" //图片信息 + } + } +} +``` + +--- + +#### OrchestratorIERestful + +> 基本信息 + +##### 接口名称：编排文件上传 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/importOrchestratorFile + +> 请求参数 + +**Body:** + +```json +{ + "projectName":"", //工程名 + "projectID":1, //工程id + "labels":"", //环境信息 + "files":"" //MultipartFile类型，支持多文件 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "importOrcId":1 + } +} +``` + + + +##### 接口名称：编排文件导出 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/orchestrator/exportOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "outputFileName":"exportOrc", //输出文件名 默认exportOrc + "charset":"utf-8", //编码 默认utf-8 + "outputFileType":"zip", //输出文件类型 默认zip + "projectName":"", //工程名 + "orchestratorId":"", //编排id + "orcVersionId":"", //版本号id + "addOrcVersion":"", //新增版本号id + "labels":"" //环境信息 +} +``` + +> 响应参数 + +```json +{} +``` + +--- + +#### OrchestratorRestful + +> 基本信息 + +##### 接口名称：回滚工作流版本 + +**接口路径：**`GET`/api/rest_j/v1/dss/framework/orchestrator/rollbackOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "orchestratorId":1, //编排id + "version":"", //版本号id + "projectId":1, //项目id + "projectName":"", //工程名 + "labels":"" //环境信息 +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "newVersion":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：打开编排模式 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/openOrchestrator + +> 请求参数 + +**Body:** + +```json +{ + "workspaceName":1, //工作空间名称 + "orchestratorId":"", //编排id + "labels":{ + "route":"" + }, +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "OrchestratorOpenUrl":"", + "OrchestratorVo":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取编排模式下的所有版本号 + +**接口路径：**`POST`/api/rest_j/v1/dss/framework/orchestrator/getVersionByOrchestratorId + +> 请求参数 + +**Body:** + +```json +{ + "orchestratorId":"" //必填 编排id +} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "list":[] + } +} +``` + +--- + +#### PagGuideAdminRestful + +> 基本信息 + +##### 接口名称：学习引导保存 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidegroup + +> 请求参数 + +**Body:** + +```json +{ + "id":1, + "path":"", //访问url路径 + "title":"", //标题 + "description":"",//描述 + "isDelete":1, //删除标识 + "children":[] +} +``` + +> 响应参数 + +```json +{ + "message":"" //成功或失败 +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导分组查询 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/admin/guidegroup + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"", + "data":{ + "id":1, //主键id + "path":"", //访问路径 + "title":"", //标题 + "description":"",//描述 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"",//创建时间 + "updateTime"："",//更新时间 + "isDelete":1, //删除标识 + "children":[{ //子类文件 + "id":1, //主键id + "groupId":1, //父类id（与上面的id一致） + "type":"", //文件类型 + "title":"", //标题 + "titleAlias":"",//标题别名 + "seq":"", //序列 + "content":"", //内容 + "contentHtml":"",//html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"", //更新时间 + "isDelete":1 //删除标识 + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导组删除 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidegroup/{id}/delete + +> 请求参数 + +**Body:** + +```json +{} +``` + +> 响应参数 + +```json +{ + "message":"" //成功或失败 +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导内容保存 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidegroup/{id}/delete + +> 请求参数 + +**Path:** + +```` +id //主键id +```` + +**Body:** + +```json +{ + "id":1, //主键id + "groupId":1, //分组id + "type":"", //类型 + "title":"", //标题 + "titleAlias":"",//标题别名 + "seq":"", //序列 + "content":"", //内容 + "contentHtml":"",//html内容 + "createBy":"",//创建人 + "updateBy":"",//更新人 + "createTime":"",//创建时间 + "updateTime":"",//更新时间 + "isDelete":1//删除标识 +} +``` + +> 响应参数 + +```json +{ + "message":"" //success / error +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导内容查询 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/admin/guidecontent + +> 请求参数 + +**Body:** + +```json +{ + "path":"" //访问路径 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "result":[{ + "id":1, //主键id + "groupId":1,//分组id + "type":"", //类型 + "title":"", //标题 + "titleAlias":"",//标题别名 + "seq":"", //序列 + "content":"",//内容 + "contentHtml":"",//html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"",//创建时间 + "updateTime":"",//更新时间 + "isDelete":1//删除标识 + }] + } +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导内容通过id查询 + +**接口路径：**`GET`/api/rest_j/v1/dss/guide/admin/guidecontent/{id} + +> 请求参数 + +**Path:** + +```json +id //主键id +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "result":{ + "id":1, //主键id + "groupId":1,//分组id + "type":"", //类型 + "title":"", //标题 + "titleAlias":"",//标题别名 + "seq":"", //序列 + "content":"",//内容 + "contentHtml":"",//html内容 + "createBy":"", //创建人 + "updateBy":"", //更新人 + "createTime":"", //创建时间 + "updateTime":"", //更新时间 + "isDelete":1 //删除标识 + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导更新 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidecontent/{id}/content + +> 请求参数 + +**Path:** + +```json +id //主键id +``` + +> 响应参数 + +```json +{ + "massage":"" //success / faild +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导删除 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidecontent/{id}/delete + +> 请求参数 + +**Path:** + +```json +id 　//主键id　 +``` + +> 响应参数 + +```json +{ + "massage":"" //success /faild +} +``` + + + +> 基本信息 + +##### 接口名称：学习引导图片上传 + +**接口路径：**`POST`/api/rest_j/v1/dss/guide/admin/guidecontent/uploadImages + +> 请求参数 + +**Body:** + +```json +{ + "files":"" //MultipartFile类型，支持多文件上传 +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "result":{ + "result_msg":"" //图片信息 + } + } +} +``` + +--- + +#### FlowRestfulApi + +> 基本信息 + +##### 接口名称：添加subflow节点 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/addFlow + +> 请求参数 + +**Body:** + +```json +{ + "name":"", + "workspaceName":"", //工作空间名称 + "projectName":"", //工程名 + "version":"", //版本号 + "description":"", //描述 + "parentFlowID":"", //工作流父节点id + "uses":"", //用途 + "labels":{ + "route":"" + }, + "userName":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "flow":{ + "id":1, + "name":"", + "state":true, //代表发布过和未发布过 + "source":"", + "description":"", + "createTime":"", + "creator":"", + "isRootFlow":true, + "rank":1, + "projectID":1, + "linkedAppConnNames":"", + "dssLabels":"", + "flowEditLock":"", //工作流编辑锁 + "hasSaved":true, //ture表示工作流从来没存过，发布的时候忽略 + "uses":"", + "children":[], + "flowType":"", + "resourceId":"", + "bmlVersion":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：发布工作流 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/publishWorkflow + +> 请求参数 + +**Body:** + +```json +{ + "workflowId":"", //工作流id + "comment":"", //备注 + "labels":{ + "route":"" + }, + "dssLabel":"", + "orchestratorId":1, //编排id + "orchestratorVersionId":1 //编排版本id +} +``` + +> 响应参数 + +```json +{ + "massage":"" +} +``` + + + +> 基本信息 + +##### 接口名称：获取发布任务状态 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/getReleaseStatus + +> 请求参数 + +**Body:** + +```json +{ + "releaseTaskId":1 //必填 发布id +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "status":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：更新工作流的基本信息，不包括更新Json,BML版本等 + +**接口路径：**`GET`/api/rest_j/v1/dss/workflow/get + +> 请求参数 + +**Body:** + +```json +{ + "flowID":1, //必填 工作流id + "isNotHaveLock":true +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "flow":{ + "id":1, + "name":"", + "state":true, //代表发布过和未发布过 + "source":"", + "description":"", + "createTime":"", + "creator":"", + "isRootFlow":true, + "rank":1, + "projectID":1, + "linkedAppConnNames":"", + "dssLabels":"", + "flowEditLock":"", //工作流编辑锁 + "hasSaved":true, //ture表示工作流从来没存过，发布的时候忽略 + "uses":"", + "children":[], + "flowType":"", + "resourceId":"", + "bmlVersion":"" + } + } +} +``` + + + +> 基本信息 + +##### 接口名称：删除工作流 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/deleteFlow + +> 请求参数 + +**Body:** + +```json +{ + "id":1, //必填 工作流id + "sure":true, + "labels":{ + "route":"" + } +} +``` + +> 响应参数 + +```json +{ + "massage":"" +} +``` + + + +> 基本信息 + +##### 接口名称：工作流保存接口，如工作流Json内容有变化，会更新工作流的Json内容 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/saveFlow + +> 请求参数 + +**Body:** + +```json +{ + "id":1, //必填 工作流id + "json":"", + "workspaceName":"", + "projectName":"", + "flowEditLock":"", + "isNotHaveLock":true, + "labels":{ + "route":"" + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "flowVersion":"", + "flowEditLock":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：工作流编辑锁更新接口 + +**接口路径：**`GET`/api/rest_j/v1/dss/workflow/updateFlowEditLock + +> 请求参数 + +**Body:** + +```json +{ + "flowEditLock":"" +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "flowEditLock":"" + } +} +``` + + + +> 基本信息 + +##### 接口名称：获取额外工具栏 + +**接口路径：**`POST`/api/rest_j/v1/dss/workflow/getExtraToolBars + +> 请求参数 + +**Body:** + +```json +{ + "projectId":1, + "workflowId":"", + "labels":{ + "route":"" + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "extraBars":[{ + "name":"", + "url":"", + "icon":"" + }] + } +} +``` + +--- + +#### NodeRestfulApi + +> 基本信息 + +##### 接口名称：HU + +**接口路径：**`GET`/api/rest_j/v1/dss/workflow/listNodeType + +> 请求参数 + +**Body:** + +```json +{ + "projectId":1, + "workflowId":"", + "labels":{ + "route":"" + } +} +``` + +> 响应参数 + +```json +{ + "massage":"", + "data":{ + "extraBars":[{ + "name":"", + "url":"", + "icon":"" + }] + } +} +``` + + + + + + + + + + + + + + + + + + + diff --git "a/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/DSS\345\215\225\346\234\272\351\203\250\347\275\262\346\226\207\346\241\243.md" "b/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/DSS\345\215\225\346\234\272\351\203\250\347\275\262\346\226\207\346\241\243.md" index 4d771fb..c42d875 100644 --- "a/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/DSS\345\215\225\346\234\272\351\203\250\347\275\262\346\226\207\346\241\243.md" +++ "b/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/DSS\345\215\225\346\234\272\351\203\250\347\275\262\346\226\207\346\241\243.md" @@ -30,60 +30,62 @@ Linkix需要的命令工具（在正式安装前，脚本会自动检测这些 下面的服务必须可从本机访问： -- Hadoop(**2.7.2，Hadoop其他版本需自行编译Linkis**) ，安装的机器必须支持执行 ``` hdfs dfs -ls / ``` 命令 +- Hadoop(**2.7.2，Hadoop 其他版本需自行编译 Linkis**) ，安装的机器必须支持执行 ``` hdfs dfs -ls / ``` 命令 -- Hive(**2.3.3，Hive其他版本需自行编译Linkis**)，安装的机器必须支持执行``` hive -e "show databases" ```命令 +- Hive(**2.3.3，Hive 其他版本需自行编译 Linkis**)，安装的机器必须支持执行``` hive -e "show databases" ```命令 - Spark(**支持2.0以上所有版本**) ，安装的机器必须支持执行```spark-sql -e "show databases" ```命令 Tips: -如您是第一次安装Hadoop，单机部署Hadoop可参考：[Hadoop单机部署](https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/SingleCluster.html) ；分布式部署Hadoop可参考：[Hadoop分布式部署](https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/ClusterSetup.html)。 +如您是第一次安装 Hadoop，单机部署 Hadoop 可参考：[Hadoop单机部署](https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/SingleCluster.html) ；分布式部署Hadoop可参考：[Hadoop分布式部署](https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/ClusterSetup.html)。 -如您是第一次安装Hive，可参考：[Hive快速安装部署](https://cwiki.apache.org/confluence/display/Hive/GettingStarted)。 +如您是第一次安装 Hive，可参考：[Hive快速安装部署](https://cwiki.apache.org/confluence/display/Hive/GettingStarted)。 -如您是第一次安装Spark，On Yarn模式可参考：[Spark on Yarn部署](http://spark.apache.org/docs/2.4.3/running-on-yarn.html)。 +如您是第一次安装 Spark，On Yarn 模式可参考：[Spark on Yarn部署](http://spark.apache.org/docs/2.4.3/running-on-yarn.html)。 ### b. 创建用户 -        例如: **部署用户是hadoop账号**（可以不是hadoop用户，但是推荐使用Hadoop的超级用户进行部署，这里只是一个示例） +        例如: **部署用户是 hadoop 账号**（可以不是 hadoop 用户，但是推荐使用Hadoop的超级用户进行部署，这里只是一个示例） 2. 在所有需要部署的机器上创建部署用户，用于安装 -```bash -sudo useradd hadoop +```shell script + sudo useradd hadoop ``` -3. 因为Linkis的服务是以 sudo -u ${linux-user} 方式来切换引擎，从而执行作业，所以部署用户需要有 sudo 权限，而且是免密的。 +3. 因为 Linkis 的服务是以 `sudo -u ${linux-user}` 方式来切换引擎，从而执行作业，所以部署用户需要有 sudo 权限，而且是免密的。 -```bash -vi /etc/sudoers +```shell script + vi /etc/sudoers ``` ```properties hadoop ALL=(ALL) NOPASSWD: NOPASSWD: ALL ``` -4. 确保部署 DSS 和 Linkis 的服务器可正常执行 hdfs 、hive -e 和 spark-sql -e 等命令。在一键安装脚本中，会对组件进行检查。 +4. 确保部署 DSS 和 Linkis 的服务器可正常执行 `hdfs dfs -ls` 、`hive -e` 和 `spark-sql -e` 等命令。在一键安装脚本中，会对组件进行检查。 -5. **如果您的Pyspark想拥有画图功能，则还需在所有安装节点，安装画图模块**。命令如下： +5. **如果您的 Pyspark 想拥有画图功能，则还需在所有安装节点，安装画图模块**。命令如下： -```bash +```shell script python -m pip install matplotlib ``` ### c.安装准备 -自行编译或者去组件release页面下载安装包： +自行编译或者去 release 页面下载安装包： [DSS Release-1.0.1](https://github.com/WeBankFinTech/DataSphereStudio/releases/tag/1.0.1) -2. 下载安装包 +**请注意：为了能正常使用 Visualis1.0.0-RC1 和 Exchangis1.0.0-RC1，请去 releases 页面下载最新的一键安装部署包。** -- [wedatasphere-linkis-x.x.x-dist.tar.gz](https://github.com/WeBankFinTech/Linkis/releases) -- [wedatasphere-dss-x.x.x-dist.tar.gz](https://github.com/WeBankFinTech/DataSphereStudio/releases) -- [wedatasphere-dss-web-x.x.x-dist.zip](https://github.com/WeBankFinTech/DataSphereStudio/releases) +**请注意：为了能正常使用 Visualis1.0.0-RC1 和 Exchangis1.0.0-RC1，请去 releases 页面下载最新的一键安装部署包。** -3. 下载 DSS & LINKIS 一键安装部署包，并解压。以下是一键安装部署包的层级目录结构： +**如果您选择自行编译 Linkis，请确保编译的是 Linkis1.1.1。** + +**如果您选择自行编译 DSS，请确保已 pull 了 DSS `master` 分支的最新代码。** + +DSS & LINKIS 一键安装部署包的层级目录结构如下： ```text ├── dss_linkis # 一键部署主目录 @@ -94,15 +96,14 @@ python -m pip install matplotlib ├── wedatasphere-linkis-x.x.x-dist.tar.gz # Linkis安装包 ``` -4.停止机器上所有DSS及Linkis服务。若从未安装过DSS及Linkis服务，忽略此步骤。 - +如果您选择自行编译 Linkis 或 DSS，直接将上面的 Linkis 安装包或 DSS 安装包替换成编译后相关安装包即可。 ### d. 修改配置 -        打开conf/config.sh，按需修改相关配置参数： +        打开 `conf/config.sh`，按需修改相关配置参数： -```bash -vi conf/config.sh +```shell script + vi conf/config.sh ``` 参数说明如下： @@ -114,14 +115,14 @@ vi conf/config.sh # deployUser=hadoop # 非必须不建议修改 -# LINKIS_VERSION=1.0.2 +LINKIS_VERSION=1.1.1 ### DSS Web，本机安装一般无需修改，但需确认此端口是否占用，若被占用，修改一个可用端口即可。 #DSS_NGINX_IP=127.0.0.1 #DSS_WEB_PORT=8088 # 非必须不建议修改 -#DSS_VERSION=1.0.0 +DSS_VERSION=1.0.1 ## Java应用的堆栈大小。如果部署机器的内存少于8G，推荐128M；达到16G时，推荐至少256M；如果想拥有非常良好的用户使用体验，推荐部署机器的内存至少达到32G。 export SERVER_HEAP_SIZE="128M" @@ -250,8 +251,8 @@ EMAIL_PROTOCOL=smtp 请确保配置的数据库，安装机器可以正常访问，否则将会出现DDL和DML导入失败的错误。 -```bash -vi conf/db.sh +```shell script + vi conf/db.sh ``` ```properties @@ -274,8 +275,8 @@ HIVE_PASSWORD=xxx ### 1. 执行安装脚本： -```bash -sh bin/install.sh +```shell script + sh bin/install.sh ``` ### 2. 安装步骤 @@ -297,6 +298,8 @@ sh bin/install.sh ### 4. 启动服务 +如果您本机已有 DSS 和 Linkis 的服务正在运行中，请先停掉所有相关服务。 + #### (1) 启动服务：      在安装目录执行以下命令，启动所有服务： @@ -316,12 +319,12 @@ sh bin/start-all.sh 请使用**谷歌浏览器**访问以下前端地址： -`http://DSS_NGINX_IP:DSS_WEB_PORT` **启动日志会打印此访问地址**。登陆时管理员的用户名和密码均为部署用户名，如部署用户为hadoop，则管理员的用户名/密码为：hadoop/hadoop。 +`http://DSS_NGINX_IP:DSS_WEB_PORT` **启动日志会打印此访问地址**。登陆时管理员的用户名和密码均为部署用户名，如部署用户为hadoop，则管理员的用户名为：hadoop（密码：dss<1.0.1版本和部署用户一致；dss>=1.0.1 版本,密码是在执行部署是随机生成一个密码串，存储于{LinkisInstallPath}/conf/linkis-mg-gateway.properties) #### (4) 停止服务：      在安装目录执行以下命令，停止所有服务： -```bash -sh bin/stop-all.sh +```shell script + sh bin/stop-all.sh ``` diff --git "a/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/ExchangisAppConn\346\217\222\344\273\266\345\256\211\350\243\205\346\226\207\346\241\243.md" "b/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/ExchangisAppConn\346\217\222\344\273\266\345\256\211\350\243\205\346\226\207\346\241\243.md" index 0e0bfbe..ce64518 100644 --- "a/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/ExchangisAppConn\346\217\222\344\273\266\345\256\211\350\243\205\346\226\207\346\241\243.md" +++ "b/zh_CN/\345\256\211\350\243\205\351\203\250\347\275\262/ExchangisAppConn\346\217\222\344\273\266\345\256\211\350\243\205\346\226\207\346\241\243.md" @@ -29,7 +29,7 @@ SET @EXCHANGIS_INSTALL_IP_PORT='127.0.0.1:9003'; SET @URL = replace('http://EXCHANGIS_IP_PORT', 'EXCHANGIS_IP_PORT', @EXCHANGIS_INSTALL_IP_PORT); SET @HOMEPAGE_URL = replace('http://EXCHANGIS_IP_PORT', 'EXCHANGIS_IP_PORT', @EXCHANGIS_INSTALL_IP_PORT); SET @PROJECT_URL = replace('http://EXCHANGIS_IP_PORT', 'EXCHANGIS_IP_PORT', @EXCHANGIS_INSTALL_IP_PORT); -SET @REDIRECT_URL = replace('http://EXCHANGIS_IP_PORT/udes/auth', 'EXCHANGIS_IP_PORT', @EXCHANGIS_INSTALL_IP_PORT); +SET @REDIRECT_URL = replace('http://EXCHANGIS_IP_PORT/#/udes/auth', 'EXCHANGIS_IP_PORT', @EXCHANGIS_INSTALL_IP_PORT); delete from `dss_application` WHERE `name` = 'Exchangis'; INSERT INTO `dss_application`(`name`,`url`,`is_user_need_init`,`level`,`user_init_url`,`exists_project_service`,`project_url`,`enhance_json`,`if_iframe`,`homepage_url`,`redirect_url`) VALUES ('Exchangis', @URL, 0, 1, NULL, 0, @PROJECT_URL, '', 1, @HOMEPAGE_URL, @REDIRECT_URL); diff --git "a/zh_CN/\345\274\200\345\217\221\346\226\207\346\241\243/\345\211\215\347\253\257\347\274\226\350\257\221\346\226\207\346\241\243.md" "b/zh_CN/\345\274\200\345\217\221\346\226\207\346\241\243/\345\211\215\347\253\257\347\274\226\350\257\221\346\226\207\346\241\243.md" index 6a30ebd..bffd592 100644 --- "a/zh_CN/\345\274\200\345\217\221\346\226\207\346\241\243/\345\211\215\347\253\257\347\274\226\350\257\221\346\226\207\346\241\243.md" +++ "b/zh_CN/\345\274\200\345\217\221\346\226\207\346\241\243/\345\211\215\347\253\257\347\274\226\350\257\221\346\226\207\346\241\243.md" @@ -6,7 +6,7 @@ 将 Node.js 下载到电脑本地，安装即可。 -下载地址：[http://nodejs.cn/download/](http://nodejs.cn/download/) （建议使用最新的稳定版本） +下载地址：[http://nodejs.cn/download/](http://nodejs.cn/download/) （最新稳定版本可能存在不兼容问题，可以使用以经过测试的版本v10.16.2、v-14.15.0）后端同学建议在Linux下进行 **该步骤仅第一次使用时需要执行。**