DolphinScheduler MCP Server

ds-restfuleapi-v1.json•626 kB

{ "openapi": "3.0.1", "info": { "title": "Apache DolphinScheduler Api Docs", "description": "Apache DolphinScheduler Api Docs", "version": "3.3.0" }, "servers": [ { "url": "http://www.sjjc.dolphinscheduler.dsj.com/dolphinscheduler", "description": "Generated server url" } ], "paths": { "/tenants/{id}": { "put": { "tags": [ "租户相关操作" ], "summary": "updateTenant", "description": "更新租户", "operationId": "updateTenant", "parameters": [ { "name": "id", "in": "path", "description": "租户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } }, { "name": "queueId", "in": "query", "description": "队列ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "description", "in": "query", "description": "租户描述", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } }, "delete": { "tags": [ "租户相关操作" ], "summary": "deleteTenantById", "description": "删除租户", "operationId": "deleteTenantById", "parameters": [ { "name": "id", "in": "path", "description": "租户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/resources": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryResourceListPaging", "description": "分页查询资源列表", "operationId": "queryResourceListPaging", "parameters": [ { "name": "fullName", "in": "query", "description": "RESOURCE_FULLNAME", "required": true, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoStorageEntity" } } } } } }, "put": { "tags": [ "资源中心相关操作" ], "summary": "updateResource", "description": "在线更新资源文件", "operationId": "updateResource", "parameters": [ { "name": "fullName", "in": "query", "description": "RESOURCE_FULLNAME", "required": true, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "name", "in": "query", "description": "资源文件名称", "required": true, "schema": { "type": "string" } }, { "name": "file", "description": "资源文件", "required": true, "schema": { "type": "string", "format": "binary" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "description": "资源文件", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } }, "post": { "tags": [ "资源中心相关操作" ], "summary": "createResource", "description": "创建资源", "operationId": "createResource", "parameters": [ { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "name", "in": "query", "description": "资源文件名称", "required": true, "schema": { "type": "string" } }, { "name": "currentDir", "in": "query", "description": "RESOURCE_CURRENT_DIR", "required": true, "schema": { "type": "string" } }, { "name": "file", "description": "资源文件", "required": true, "schema": { "type": "string", "format": "binary" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "资源文件", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } }, "delete": { "tags": [ "资源中心相关操作" ], "summary": "deleteResource", "description": "通过ID删除资源", "operationId": "deleteResource", "parameters": [ { "name": "fullName", "in": "query", "description": "RESOURCE_FULLNAME", "required": true, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/resources/update-content": { "put": { "tags": [ "资源中心相关操作" ], "summary": "updateResourceContent", "description": "在线更新资源文件", "operationId": "updateResourceContent", "parameters": [ { "name": "fullName", "in": "query", "description": "FULL_NAME", "required": true, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "资源文件内容", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/udf-func/{id}": { "put": { "tags": [ "资源中心相关操作" ], "summary": "updateUdfFunc", "description": "更新udf函数", "operationId": "updateUdfFunc", "parameters": [ { "name": "id", "in": "path", "description": "udf ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "type", "in": "query", "description": "UDF类型", "required": true, "schema": { "type": "string", "enum": [ "HIVE", "SPARK" ] } }, { "name": "funcName", "in": "query", "description": "函数名称", "required": true, "schema": { "type": "string" } }, { "name": "className", "in": "query", "description": "包名类名", "required": true, "schema": { "type": "string" } }, { "name": "argTypes", "in": "query", "description": "参数", "required": false, "schema": { "type": "string" } }, { "name": "database", "in": "query", "description": "数据库名", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "udf描述，使用说明", "required": false, "schema": { "type": "string" } }, { "name": "fullName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "资源中心相关操作" ], "summary": "deleteUdfFunc", "description": "删除UDF函数", "operationId": "deleteUdfFunc", "parameters": [ { "name": "id", "in": "path", "description": "UDF_FUNC_ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/queues/{id}": { "put": { "tags": [ "队列相关操作" ], "summary": "updateQueue", "description": "更新队列", "operationId": "updateQueue", "parameters": [ { "name": "id", "in": "path", "description": "队列ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "queue", "in": "query", "description": "hadoop yarn队列名", "required": true, "schema": { "type": "string" } }, { "name": "queueName", "in": "query", "description": "队列名", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultQueue" } } } } } }, "delete": { "tags": [ "队列相关操作" ], "summary": "deleteQueueById", "description": "DELETE_QUEUE_NOTES", "operationId": "deleteQueueById", "parameters": [ { "name": "id", "in": "path", "description": "队列ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/projects/{projectCode}/task-definition/{code}": { "get": { "tags": [ "任务定义相关操作" ], "summary": "queryTaskDefinitionByCode", "description": "查询任务定义详情", "operationId": "queryTaskDefinitionDetail", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "put": { "tags": [ "任务定义相关操作" ], "summary": "update", "description": "更新任务定义", "operationId": "updateTaskDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskDefinitionJsonObj", "in": "query", "description": "任务定义JSON", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "任务定义相关操作" ], "summary": "deleteTaskDefinition", "description": "通过任务代码删除任务定义", "operationId": "deleteTaskDefinitionByCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-definition/{code}/with-upstream": { "put": { "tags": [ "任务定义相关操作" ], "summary": "updateWithUpstream", "description": "更新任务定义", "operationId": "updateTaskWithUpstream", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskDefinitionJsonObj", "in": "query", "description": "任务定义JSON", "required": true, "schema": { "type": "string" } }, { "name": "upstreamCodes", "in": "query", "description": "上游代码列表", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/schedules/{id}": { "put": { "tags": [ "定时相关操作" ], "summary": "updateSchedule", "description": "更新定时", "operationId": "updateSchedule", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "定时ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "schedule", "in": "query", "description": "定时", "required": true, "schema": { "type": "string" } }, { "name": "warningType", "in": "query", "description": "发送策略", "required": false, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "warningGroupId", "in": "query", "description": "发送组ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "failureStrategy", "in": "query", "description": "失败策略", "required": false, "schema": { "type": "string", "enum": [ "END", "CONTINUE" ] } }, { "name": "workerGroup", "in": "query", "description": "worker群组", "required": false, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": false, "schema": { "type": "string" } }, { "name": "environmentCode", "in": "query", "description": "环境代码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "processInstancePriority", "in": "query", "description": "流程实例优先级", "required": false, "schema": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "定时相关操作" ], "summary": "deleteScheduleById", "description": "根据定时id删除定时数据", "operationId": "deleteScheduleById", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "定时ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/schedules/update/{code}": { "put": { "tags": [ "定时相关操作" ], "summary": "updateScheduleByProcessDefinitionCode", "description": "UPDATE_SCHEDULE_BY_PROCESS_DEFINITION_CODE_NOTES", "operationId": "updateScheduleByProcessDefinitionCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "schedule", "in": "query", "description": "定时", "required": true, "schema": { "type": "string" } }, { "name": "warningType", "in": "query", "description": "发送策略", "required": false, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "warningGroupId", "in": "query", "description": "发送组ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "failureStrategy", "in": "query", "description": "失败策略", "required": false, "schema": { "type": "string", "enum": [ "END", "CONTINUE" ] } }, { "name": "workerGroup", "in": "query", "description": "worker群组", "required": false, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": false, "schema": { "type": "string" } }, { "name": "environmentCode", "in": "query", "description": "环境代码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "processInstancePriority", "in": "query", "description": "流程实例优先级", "required": false, "schema": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] } }, { "name": "processDefinitionCode", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/project-preference": { "get": { "tags": [ "project preference related operation" ], "summary": "queryProjectPreferenceByProjectCode", "description": "query project preference", "operationId": "queryProjectPreferenceByProjectCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "put": { "tags": [ "project preference related operation" ], "summary": "updateProjectPreference", "description": "update project preference", "operationId": "updateProjectPreference", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "projectPreferences", "in": "query", "description": "project preferences", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "project preference related operation" ], "summary": "enableProjectPreference", "description": "update the state of the project preference", "operationId": "enableProjectPreference", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "state", "in": "query", "description": "the state of the project preference", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/project-parameter/{code}": { "get": { "tags": [ "项目参数相关操作" ], "summary": "queryProjectParameterByCode", "description": "查询项目参数", "operationId": "queryProjectParameterByCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "项目参数code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "put": { "tags": [ "项目参数相关操作" ], "summary": "updateProjectParameter", "description": "更新项目参数", "operationId": "updateProjectParameter", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "项目参数code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "projectParameterName", "in": "query", "description": "项目参数名称", "required": true, "schema": { "type": "string" } }, { "name": "projectParameterValue", "in": "query", "description": "项目参数值", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/{id}": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryProcessInstanceById", "description": "通过流程实例ID查询流程实例", "operationId": "queryProcessInstanceById", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "put": { "tags": [ "流程实例相关操作" ], "summary": "updateProcessInstance", "description": "更新流程实例", "operationId": "updateProcessInstance", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskRelationJson", "in": "query", "description": "TASK_RELATION_JSON", "required": true, "schema": { "type": "string" } }, { "name": "taskDefinitionJson", "in": "query", "description": "任务定义JSON", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "scheduleTime", "in": "query", "description": "定时时间,空字符串表示当前天", "required": false, "schema": { "type": "string" } }, { "name": "syncDefine", "in": "query", "description": "更新流程实例的信息是否同步到流程定义", "required": true, "schema": { "type": "boolean" } }, { "name": "globalParams", "in": "query", "description": "PROCESS_GLOBAL_PARAMS", "required": false, "schema": { "type": "string" } }, { "name": "locations", "in": "query", "description": "流程实例节点坐标位置信息(json格式)", "required": false, "schema": { "type": "string" } }, { "name": "timeout", "in": "query", "description": "PROCESS_TIMEOUT", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "流程实例相关操作" ], "summary": "deleteProcessInstanceById", "description": "通过流程实例ID删除流程实例", "operationId": "deleteProcessInstanceById", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultVoid" } } } } } } }, "/projects/{projectCode}/process-definition/{code}": { "get": { "tags": [ "流程定义相关操作" ], "summary": "queryProcessDefinitionByCode", "description": "QUERY_PROCESS_DEFINITION_BY_CODE_NOTES", "operationId": "queryProcessDefinitionByCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "put": { "tags": [ "流程定义相关操作" ], "summary": "update", "description": "更新流程定义", "operationId": "updateProcessDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "name", "in": "query", "description": "流程定义名称", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "description", "in": "query", "description": "流程定义描述信息", "required": false, "schema": { "type": "string" } }, { "name": "globalParams", "in": "query", "required": false, "schema": { "type": "string", "default": "[]" } }, { "name": "locations", "in": "query", "description": "流程定义节点坐标位置信息(json格式)", "required": true, "schema": { "type": "string" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "taskRelationJson", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "taskDefinitionJson", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "executionType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PARALLEL", "SERIAL_WAIT", "SERIAL_DISCARD", "SERIAL_PRIORITY" ], "default": "PARALLEL" } }, { "name": "releaseState", "in": "query", "description": "发布流程定义", "required": false, "schema": { "type": "string", "enum": [ "OFFLINE", "ONLINE" ] } }, { "name": "otherParamsJson", "description": "OTHER_PARAMS_JSON", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "流程定义相关操作" ], "summary": "deleteByCode", "description": "通过流程定义ID删除流程定义", "operationId": "deleteProcessDefinitionByCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{code}": { "get": { "tags": [ "项目相关操作" ], "summary": "queryProjectByCode", "description": "通过项目ID查询项目信息", "operationId": "queryProjectByCode", "parameters": [ { "name": "code", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "put": { "tags": [ "项目相关操作" ], "summary": "update", "description": "更新项目", "operationId": "updateProject", "parameters": [ { "name": "code", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "projectName", "in": "query", "description": "项目名称", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "项目描述", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "项目相关操作" ], "summary": "delete", "description": "通过ID删除项目", "operationId": "deleteProject", "parameters": [ { "name": "code", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/datasources/{id}": { "get": { "tags": [ "数据源相关操作" ], "summary": "queryDataSource", "description": "查询数据源通过ID", "operationId": "queryDataSource", "parameters": [ { "name": "id", "in": "path", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } }, "put": { "tags": [ "数据源相关操作" ], "summary": "updateDataSource", "description": "更新数据源", "operationId": "updateDataSource", "parameters": [ { "name": "id", "in": "path", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dataSourceParam", "description": "数据源参数", "required": true, "schema": { "$ref": "#/components/schemas/BaseDataSourceParamDTO" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultDataSource" } } } } } }, "delete": { "tags": [ "数据源相关操作" ], "summary": "deleteDataSource", "description": "删除数据源", "operationId": "deleteDataSource", "parameters": [ { "name": "id", "in": "path", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/alert-plugin-instances/{id}": { "get": { "tags": [ "告警插件实例相关操作" ], "summary": "getAlertPluginInstance", "description": "查询告警插件实例", "operationId": "getAlertPluginInstance", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAlertPluginInstance" } } } } } }, "put": { "tags": [ "告警插件实例相关操作" ], "summary": "updateAlertPluginInstance", "description": "更新告警插件实例", "operationId": "updateAlertPluginInstanceById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "instanceName", "in": "query", "description": "告警插件实例名称", "required": true, "schema": { "type": "string" } }, { "name": "warningType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "pluginInstanceParams", "in": "query", "description": "告警插件实例参数", "required": true, "schema": { "type": "string" } }, { "name": "alertPluginInstanceId", "description": "告警插件实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAlertPluginInstance" } } } } } }, "delete": { "tags": [ "告警插件实例相关操作" ], "summary": "deleteAlertPluginInstance", "description": "删除告警插件实例", "operationId": "deleteAlertPluginInstance", "parameters": [ { "name": "id", "in": "path", "description": "告警插件ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/alert-groups/{id}": { "put": { "tags": [ "告警组相关操作" ], "summary": "updateAlertGroup", "description": "编辑(更新)告警组", "operationId": "updateAlertGroupById", "parameters": [ { "name": "id", "in": "path", "description": "告警组ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "groupName", "in": "query", "description": "组名称", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "备注(描述)", "required": false, "schema": { "type": "string" } }, { "name": "alertInstanceIds", "in": "query", "description": "告警实例ID列表(字符串格式，多个告警实例ID以\",\"分割)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAlertGroup" } } } } } }, "delete": { "tags": [ "告警组相关操作" ], "summary": "delAlertGroupById", "description": "通过ID删除告警组", "operationId": "deleteAlertGroupById", "parameters": [ { "name": "id", "in": "path", "description": "告警组ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/access-tokens/{id}": { "put": { "tags": [ "访问token相关操作" ], "summary": "updateToken", "description": "更新指定用户的安全令牌", "operationId": "updateToken", "parameters": [ { "name": "id", "in": "path", "description": "安全令牌的ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expireTime", "in": "query", "description": "安全令牌的过期时间", "required": true, "schema": { "type": "string" }, "example": "2021-12-31 00:00:00" }, { "name": "token", "in": "query", "description": "安全令牌字符串，若未显式指定将会自动生成", "required": false, "schema": { "type": "string" }, "example": "xxxx" } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAccessToken" } } } } } }, "delete": { "tags": [ "访问token相关操作" ], "summary": "deleteToken", "description": "DELETE_TOKEN_NOTES", "operationId": "delAccessTokenById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/worker-groups": { "get": { "tags": [ "Worker分组管理" ], "summary": "queryAllWorkerGroupsPaging", "description": "Worker分组管理", "operationId": "queryAllWorkerGroupsPaging", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "Worker分组管理" ], "summary": "saveWorkerGroup", "description": "创建Worker分组", "operationId": "saveWorkerGroup", "parameters": [ { "name": "id", "in": "query", "description": "Worker Server分组ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Worker分组名称", "required": true, "schema": { "type": "string" } }, { "name": "addrList", "in": "query", "description": "worker地址列表", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "WORKER_DESC", "required": false, "schema": { "type": "string" } }, { "name": "otherParamsJson", "in": "query", "description": "WORKER_PARAMS_JSON", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/update": { "post": { "tags": [ "用户相关操作" ], "summary": "updateUser", "description": "更新用户", "operationId": "updateUser", "parameters": [ { "name": "id", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userName", "in": "query", "description": "用户名", "required": true, "schema": { "type": "string" } }, { "name": "userPassword", "in": "query", "description": "用户密码", "required": true, "schema": { "type": "string" } }, { "name": "queue", "in": "query", "description": "使用的队列", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "邮箱", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "query", "description": "租户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "phone", "in": "query", "description": "手机号", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "状态", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "timeZone", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultUser" } } } } } } }, "/users/revoke-project": { "post": { "tags": [ "用户相关操作" ], "summary": "revokeProject", "description": "撤销用户的项目权限", "operationId": "revokeProject", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectCode", "in": "query", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/revoke-project-by-id": { "post": { "tags": [ "用户相关操作" ], "summary": "revokeProjectById", "description": "撤销用户的项目权限", "operationId": "revokeProjectById", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectIds", "in": "query", "description": "项目IDS(字符串格式，多个项目以\",\"分割)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/register": { "post": { "tags": [ "用户相关操作" ], "summary": "registerUser", "description": "用户注册", "operationId": "registerUser", "parameters": [ { "name": "userName", "in": "query", "description": "用户名", "required": true, "schema": { "type": "string" } }, { "name": "userPassword", "in": "query", "description": "用户密码", "required": true, "schema": { "type": "string" } }, { "name": "repeatPassword", "in": "query", "description": "重复密码", "required": true, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "邮箱", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/users/grant-udf-func": { "post": { "tags": [ "用户相关操作" ], "summary": "grantUDFFunc", "description": "授权udf函数", "operationId": "grantUDFFunc", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "udfIds", "in": "query", "description": "udf函数id列表(字符串格式，多个udf函数ID以\",\"分割)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/grant-project": { "post": { "tags": [ "用户相关操作" ], "summary": "grantProject", "description": "授权项目", "operationId": "grantProject", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectIds", "in": "query", "description": "项目IDS(字符串格式，多个项目以\",\"分割)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/grant-project-with-read-perm": { "post": { "tags": [ "用户相关操作" ], "summary": "grantProjectWithReadPerm", "description": "GRANT_PROJECT_WITH_READ_PERM_NOTES", "operationId": "grantProjectWithReadPerm", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectIds", "in": "query", "description": "项目IDS(字符串格式，多个项目以\",\"分割)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/grant-project-by-code": { "post": { "tags": [ "用户相关操作" ], "summary": "grantProjectByCode", "description": "授权项目", "operationId": "grantProjectByCode", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectCode", "in": "query", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/grant-namespace": { "post": { "tags": [ "用户相关操作" ], "summary": "grantNamespace", "description": "GRANT_NAMESPACE_NOTES", "operationId": "grantNamespace", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "namespaceIds", "in": "query", "description": "NAMESPACE_IDS", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/grant-datasource": { "post": { "tags": [ "用户相关操作" ], "summary": "grantDataSource", "description": "授权数据源", "operationId": "grantDataSource", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "datasourceIds", "in": "query", "description": "数据源ID列表(字符串格式，多个数据源ID以\",\"分割)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/delete": { "post": { "tags": [ "用户相关操作" ], "summary": "delUserById", "description": "删除用户通过ID", "operationId": "delUserById", "parameters": [ { "name": "id", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/create": { "post": { "tags": [ "用户相关操作" ], "summary": "createUser", "description": "创建用户", "operationId": "createUser", "parameters": [ { "name": "userName", "in": "query", "description": "用户名", "required": true, "schema": { "type": "string" } }, { "name": "userPassword", "in": "query", "description": "用户密码", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "query", "description": "租户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "queue", "in": "query", "description": "使用的队列", "required": false, "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "邮箱", "required": true, "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "手机号", "required": false, "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "状态", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/batch/activate": { "post": { "tags": [ "用户相关操作" ], "summary": "batchActivateUser", "description": "批量激活用户", "operationId": "batchActivateUser", "parameters": [ { "name": "userNames", "description": "多个用户名", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "description": "多个用户名" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/users/activate": { "post": { "tags": [ "用户相关操作" ], "summary": "activateUser", "description": "激活用户", "operationId": "activateUser", "parameters": [ { "name": "userName", "in": "query", "description": "用户名", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/tenants": { "get": { "tags": [ "租户相关操作" ], "summary": "queryTenantListPaging", "description": "分页查询租户列表", "operationId": "queryTenantListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoTenant" } } } } } }, "post": { "tags": [ "租户相关操作" ], "summary": "createTenant", "description": "创建租户", "operationId": "createTenant", "parameters": [ { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } }, { "name": "queueId", "in": "query", "description": "队列ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "description", "in": "query", "description": "租户描述", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultTenant" } } } } } } }, "/task-group/update": { "post": { "tags": [ "任务组相关操作" ], "summary": "update", "description": "更新任务组", "operationId": "updateTaskGroup", "parameters": [ { "name": "id", "in": "query", "description": "任务组ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "任务组名称", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "任务组描述", "required": true, "schema": { "type": "string" } }, { "name": "groupSize", "in": "query", "description": "任务组大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/start-task-group": { "post": { "tags": [ "任务组相关操作" ], "summary": "startTaskGroup", "description": "启动任务组", "operationId": "startTaskGroup", "parameters": [ { "name": "id", "in": "query", "description": "任务组ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/modifyPriority": { "post": { "tags": [ "任务组相关操作" ], "summary": "modifyPriority", "description": "修改任务组优先级", "operationId": "modifyPriority", "parameters": [ { "name": "queueId", "in": "query", "description": "任务组队列ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "priority", "in": "query", "description": "任务队列优先级", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/forceStart": { "post": { "tags": [ "任务组相关操作" ], "summary": "forceStart", "description": "强制启动任务组", "operationId": "forceStart", "parameters": [ { "name": "queueId", "in": "query", "description": "任务组队列ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/create": { "post": { "tags": [ "任务组相关操作" ], "summary": "create", "description": "创建任务组", "operationId": "createTaskGroup", "parameters": [ { "name": "name", "in": "query", "description": "NAME", "required": true, "schema": { "type": "string" } }, { "name": "projectCode", "in": "query", "description": "项目Code", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "description", "in": "query", "description": "任务组描述", "required": true, "schema": { "type": "string" } }, { "name": "groupSize", "in": "query", "description": "任务组大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/close-task-group": { "post": { "tags": [ "任务组相关操作" ], "summary": "closeTaskGroup", "description": "关闭任务组", "operationId": "closeTaskGroup", "parameters": [ { "name": "id", "in": "query", "description": "ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/signOut": { "post": { "tags": [ "用户登录相关操作" ], "summary": "signOut", "description": "退出登录", "operationId": "signOut", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/udf-func": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryUdfFuncListPaging", "description": "分页查询udf函数列表", "operationId": "queryUdfFuncListPaging", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } }, "post": { "tags": [ "资源中心相关操作" ], "summary": "createUdfFunc", "description": "创建UDF函数", "operationId": "createUdfFunc", "parameters": [ { "name": "type", "in": "query", "description": "UDF类型", "required": true, "schema": { "type": "string", "enum": [ "HIVE", "SPARK" ] } }, { "name": "funcName", "in": "query", "description": "函数名称", "required": true, "schema": { "type": "string" } }, { "name": "className", "in": "query", "description": "包名类名", "required": true, "schema": { "type": "string" } }, { "name": "fullName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "argTypes", "in": "query", "description": "参数", "required": false, "schema": { "type": "string" } }, { "name": "database", "in": "query", "description": "数据库名", "required": false, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "udf描述，使用说明", "required": false, "schema": { "type": "string" } }, { "name": "resourceId", "description": "资源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/online-create": { "post": { "tags": [ "资源中心相关操作" ], "summary": "onlineCreateResource", "description": "在线创建资源", "operationId": "createResourceFile", "parameters": [ { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "fileName", "in": "query", "description": "资源文件名称", "required": true, "schema": { "type": "string" } }, { "name": "suffix", "in": "query", "description": "资源文件后缀", "required": true, "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "资源文件内容", "required": true, "schema": { "type": "string" } }, { "name": "currentDir", "in": "query", "description": "当前资源目录", "required": true, "schema": { "type": "string" } }, { "name": "description", "description": "资源文件描述", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/directory": { "post": { "tags": [ "资源中心相关操作" ], "summary": "createDirectory", "description": "创建资源", "operationId": "createDirectory", "parameters": [ { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "name", "in": "query", "description": "资源文件名称", "required": true, "schema": { "type": "string" } }, { "name": "pid", "in": "query", "description": "资源父目录ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "currentDir", "in": "query", "description": "RESOURCE_CURRENT_DIR", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/queues": { "get": { "tags": [ "队列相关操作" ], "summary": "queryQueueListPaging", "description": "分页查询队列列表", "operationId": "queryQueueListPaging", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoQueue" } } } } } }, "post": { "tags": [ "队列相关操作" ], "summary": "createQueue", "description": "创建队列", "operationId": "createQueue", "parameters": [ { "name": "queue", "in": "query", "description": "hadoop yarn队列名", "required": true, "schema": { "type": "string" } }, { "name": "queueName", "in": "query", "description": "队列名", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultQueue" } } } } } } }, "/queues/verify": { "post": { "tags": [ "队列相关操作" ], "summary": "verifyQueue", "description": "验证队列", "operationId": "verifyQueue", "parameters": [ { "name": "queue", "in": "query", "description": "hadoop yarn队列名", "required": true, "schema": { "type": "string" } }, { "name": "queueName", "in": "query", "description": "队列名", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/projects": { "get": { "tags": [ "项目相关操作" ], "summary": "queryProjectListPaging", "description": "分页查询项目列表", "operationId": "queryProjectListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "项目相关操作" ], "summary": "create", "description": "创建项目", "operationId": "createProject", "parameters": [ { "name": "projectName", "in": "query", "description": "项目名称", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "项目描述", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/worker-group": { "get": { "tags": [ "PROJECT_WORKER_GROUP_TAG" ], "summary": "queryWorkerGroups", "description": "QUERY_WORKER_GROUP_LIST", "operationId": "queryWorkerGroups", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object", "additionalProperties": { "type": "object" } } } } } } }, "post": { "tags": [ "PROJECT_WORKER_GROUP_TAG" ], "summary": "assignWorkerGroups", "description": "ASSIGN_WORKER_GROUPS_NOTES", "operationId": "assignWorkerGroups", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "workerGroups", "description": "Worker工作组列表", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-instances/{id}/stop": { "post": { "tags": [ "任务实例相关操作" ], "summary": "stop", "description": "停止任务实例", "operationId": "stopTask", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/projects/{projectCode}/task-instances/{id}/savepoint": { "post": { "tags": [ "任务实例相关操作" ], "summary": "savepoint", "description": "任务SavePoint", "operationId": "taskSavePoint", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/projects/{projectCode}/task-instances/{id}/force-success": { "post": { "tags": [ "任务实例相关操作" ], "summary": "force-success", "description": "强制TASK成功", "operationId": "forceTaskSuccess", "parameters": [ { "name": "projectCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultVoid" } } } } } } }, "/projects/{projectCode}/task-definition": { "get": { "tags": [ "任务定义相关操作" ], "summary": "queryTaskDefinitionListPaging", "description": "查询任务定义列表页面", "operationId": "queryTaskDefinitionListPaging", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "searchTaskName", "in": "query", "description": "查询任务名称", "required": false, "schema": { "type": "string" } }, { "name": "taskType", "in": "query", "description": "任务类型", "required": false, "schema": { "type": "string" } }, { "name": "taskExecuteType", "in": "query", "description": "任务执行类型", "required": false, "schema": { "type": "string", "enum": [ "BATCH", "STREAM" ] } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchWorkflowName", "description": "查询工作量名称", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "任务定义相关操作" ], "summary": "save", "description": "创建任务定义", "operationId": "createTaskDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskDefinitionJson", "in": "query", "description": "任务定义JSON", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-definition/{code}/release": { "post": { "tags": [ "任务定义相关操作" ], "summary": "releaseTaskDefinition", "description": "上线任务定义", "operationId": "releaseTaskDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "releaseState", "in": "query", "description": "发布流程定义", "required": true, "schema": { "type": "string", "enum": [ "OFFLINE", "ONLINE" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-definition/save-single": { "post": { "tags": [ "任务定义相关操作" ], "summary": "saveSingle", "description": "创建单个任务定义", "operationId": "createTaskBindsWorkFlow", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskDefinitionJsonObj", "in": "query", "description": "任务定义JSON", "required": true, "schema": { "type": "string" } }, { "name": "upstreamCodes", "in": "query", "description": "上游代码列表", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/schedules": { "get": { "tags": [ "定时相关操作" ], "summary": "queryScheduleListPaging", "description": "分页查询定时", "operationId": "queryScheduleListPaging", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64", "default": 0 } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processDefinitionId", "description": "流程定义ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "定时相关操作" ], "summary": "createSchedule", "description": "创建定时", "operationId": "createSchedule", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "schedule", "in": "query", "description": "定时", "required": true, "schema": { "type": "string" } }, { "name": "warningType", "in": "query", "description": "发送策略", "required": false, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "warningGroupId", "in": "query", "description": "发送组ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "failureStrategy", "in": "query", "description": "失败策略", "required": false, "schema": { "type": "string", "enum": [ "END", "CONTINUE" ] } }, { "name": "workerGroup", "in": "query", "description": "worker群组", "required": false, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": false, "schema": { "type": "string" } }, { "name": "environmentCode", "in": "query", "description": "环境代码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "processInstancePriority", "in": "query", "description": "流程实例优先级", "required": false, "schema": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/schedules/{id}/online": { "post": { "tags": [ "定时相关操作" ], "summary": "online", "description": "定时上线", "operationId": "publishScheduleOnline", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "定时ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/projects/{projectCode}/schedules/{id}/offline": { "post": { "tags": [ "定时相关操作" ], "summary": "offline", "description": "定时下线", "operationId": "offlineSchedule", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "定时ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/projects/{projectCode}/schedules/preview": { "post": { "tags": [ "定时相关操作" ], "summary": "previewSchedule", "description": "定时调度预览", "operationId": "previewSchedule", "parameters": [ { "name": "schedule", "in": "query", "description": "定时", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/schedules/list": { "post": { "tags": [ "定时相关操作" ], "summary": "queryScheduleList", "description": "查询定时列表", "operationId": "queryScheduleList", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/project-parameter": { "get": { "tags": [ "项目参数相关操作" ], "summary": "queryProjectParameterListPaging", "description": "分页查询项目参数", "operationId": "queryProjectParameterListPaging", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "项目参数相关操作" ], "summary": "createProjectParameter", "description": "新增项目参数", "operationId": "createProjectParameter", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "projectParameterName", "in": "query", "description": "项目参数名称", "required": true, "schema": { "type": "string" } }, { "name": "projectParameterValue", "in": "query", "description": "项目参数值", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/project-parameter/delete": { "post": { "tags": [ "项目参数相关操作" ], "summary": "deleteProjectParametersByCode", "description": "删除项目参数", "operationId": "deleteProjectParametersByCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "query", "description": "项目参数code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/project-parameter/batch-delete": { "post": { "tags": [ "项目参数相关操作" ], "summary": "batchDeleteProjectParametersByCodes", "description": "删除项目参数", "operationId": "batchDeleteProjectParametersByCodes", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "codes", "in": "query", "description": "项目参数code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-task-relation": { "post": { "tags": [ "工作流关系相关操作" ], "summary": "save", "description": "创建工作流任务关系", "operationId": "createProcessTaskRelation", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "preTaskCode", "in": "query", "description": "PRE_TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "postTaskCode", "in": "query", "description": "POST_TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/batch-delete": { "post": { "tags": [ "流程实例相关操作" ], "summary": "batchDeleteProcessInstanceByIds", "description": "通过流程实例ID集合批量删除流程实例", "operationId": "batchDeleteProcessInstanceByIds", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processInstanceIds", "in": "query", "description": "流程实例ID集合，如果有多个流程实例则用 \",\" 分隔", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition": { "get": { "tags": [ "流程定义相关操作" ], "summary": "queryListPaging", "description": "分页查询流程定义列表", "operationId": "queryProcessDefinitionListPaging", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "otherParamsJson", "in": "query", "description": "OTHER_PARAMS_JSON", "required": false, "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "用户ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoProcessDefinition" } } } } } }, "post": { "tags": [ "流程定义相关操作" ], "summary": "createProcessDefinition", "description": "创建流程定义", "operationId": "createProcessDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "name", "in": "query", "description": "流程定义名称", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "流程定义描述信息", "required": false, "schema": { "type": "string" } }, { "name": "globalParams", "in": "query", "required": false, "schema": { "type": "string", "default": "[]" } }, { "name": "locations", "in": "query", "description": "流程定义节点坐标位置信息(json格式)", "required": true, "schema": { "type": "string" } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "taskRelationJson", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "taskDefinitionJson", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "otherParamsJson", "in": "query", "description": "OTHER_PARAMS_JSON", "required": false, "schema": { "type": "string" } }, { "name": "executionType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "PARALLEL", "SERIAL_WAIT", "SERIAL_DISCARD", "SERIAL_PRIORITY" ], "default": "PARALLEL" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/{code}/release": { "post": { "tags": [ "流程定义相关操作" ], "summary": "release", "description": "发布流程定义", "operationId": "releaseProcessDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "releaseState", "in": "query", "description": "PROCESS_DEFINITION_RELEASE", "required": true, "schema": { "type": "string", "enum": [ "OFFLINE", "ONLINE" ] } }, { "name": "name", "description": "流程定义名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/projects/{projectCode}/process-definition/import": { "post": { "tags": [ "流程定义相关操作" ], "summary": "importProcessDefinition", "description": "导入流程定义", "operationId": "importProcessDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "file", "description": "资源文件", "required": true, "schema": { "type": "string", "format": "binary" } } ], "requestBody": { "content": { "application/json": { "schema": { "required": [ "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "资源文件", "format": "binary" } } } } } }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/batch-move": { "post": { "tags": [ "流程定义相关操作" ], "summary": "batchMoveByCodes", "description": "移动工作流定义", "operationId": "moveProcessDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "codes", "in": "query", "description": "PROCESS_DEFINITION_CODES", "required": true, "schema": { "type": "string" } }, { "name": "targetProjectCode", "in": "query", "description": "TARGET_PROJECT_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/batch-export": { "post": { "tags": [ "流程定义相关操作" ], "summary": "batchExportByCodes", "description": "通过代码列表批量导出工作量定义", "operationId": "batchExportProcessDefinitionByCodes", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "codes", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/projects/{projectCode}/process-definition/batch-delete": { "post": { "tags": [ "流程定义相关操作" ], "summary": "batchDeleteByCodes", "description": "通过流程定义ID集合批量删除流程定义", "operationId": "batchDeleteProcessDefinitionByCodes", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "codes", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/batch-copy": { "post": { "tags": [ "流程定义相关操作" ], "summary": "batchCopyByCodes", "description": "复制工作流定义", "operationId": "copyProcessDefinition", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "codes", "in": "query", "description": "PROCESS_DEFINITION_CODES", "required": true, "schema": { "type": "string" } }, { "name": "targetProjectCode", "in": "query", "description": "TARGET_PROJECT_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/lineages/tasks/verify-delete": { "post": { "tags": [ "工作流血缘相关操作" ], "summary": "verifyTaskCanDelete", "description": "校验是否可以删除任务", "operationId": "verifyTaskCanDelete", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskCode", "in": "query", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/executors/task-instance/{code}/start": { "post": { "tags": [ "流程相关操作" ], "summary": "startTaskInstance", "description": "运行任务实例", "operationId": "startStreamTaskInstance", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "version", "in": "query", "description": "版本号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "warningGroupId", "in": "query", "description": "发送组ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "workerGroup", "in": "query", "description": "worker群组", "required": false, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": false, "schema": { "type": "string" } }, { "name": "environmentCode", "in": "query", "description": "环境代码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "startParams", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "dryRun", "in": "query", "description": "是否空跑", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "failureStrategy", "description": "失败策略", "required": true, "schema": { "type": "string", "enum": [ "END", "CONTINUE" ] } }, { "name": "execType", "description": "指令类型", "schema": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] } }, { "name": "warningType", "description": "发送策略", "required": true, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "timeout", "description": "超时时间", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/projects/{projectCode}/executors/start-process-instance": { "post": { "tags": [ "流程相关操作" ], "summary": "startProcessInstance", "description": "运行流程实例", "operationId": "startProcessInstance", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 100 }, { "name": "scheduleTime", "in": "query", "description": "定时时间,空字符串表示当前天", "required": true, "schema": { "type": "string" }, "example": "2022-04-06 00:00:00,2022-04-06 00:00:00" }, { "name": "failureStrategy", "in": "query", "description": "失败策略", "required": true, "schema": { "type": "string", "enum": [ "END", "CONTINUE" ] } }, { "name": "startNodeList", "in": "query", "description": "开始节点列表(节点name)", "required": false, "schema": { "type": "string" } }, { "name": "taskDependType", "in": "query", "description": "任务依赖类型", "required": false, "schema": { "type": "string", "enum": [ "TASK_ONLY", "TASK_PRE", "TASK_POST" ] } }, { "name": "execType", "in": "query", "description": "指令类型", "required": false, "schema": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] } }, { "name": "warningType", "in": "query", "description": "发送策略", "required": true, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "warningGroupId", "in": "query", "description": "发送组ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "runMode", "in": "query", "description": "运行模式", "required": false, "schema": { "type": "string", "enum": [ "RUN_MODE_SERIAL", "RUN_MODE_PARALLEL" ] } }, { "name": "processInstancePriority", "in": "query", "description": "流程实例优先级", "required": true, "schema": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] } }, { "name": "workerGroup", "in": "query", "description": "worker群组", "required": false, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": false, "schema": { "type": "string" } }, { "name": "environmentCode", "in": "query", "description": "环境代码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "timeout", "in": "query", "description": "超时时间", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "startParams", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "expectedParallelismNumber", "in": "query", "description": "补数任务自定义并行度", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "dryRun", "in": "query", "description": "是否空跑", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "testFlag", "in": "query", "description": "测试标识", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "complementDependentMode", "in": "query", "description": "补数依赖的类型", "required": false, "schema": { "type": "string", "enum": [ "OFF_MODE", "ALL_DEPENDENT" ] } }, { "name": "version", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "allLevelDependent", "in": "query", "description": "ALL_LEVEL_DEPENDENT", "required": false, "schema": { "type": "boolean" } }, { "name": "executionOrder", "in": "query", "description": "EXECUTION_ORDER", "required": false, "schema": { "type": "string", "enum": [ "DESC_ORDER", "ASC_ORDER" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/executors/start-check": { "post": { "tags": [ "流程相关操作" ], "summary": "startCheckProcessDefinition", "description": "检查流程定义", "operationId": "startCheckProcessDefinition", "parameters": [ { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/executors/execute": { "post": { "tags": [ "流程相关操作" ], "summary": "execute", "description": "执行流程实例的各种操作(暂停、停止、重跑、恢复等)", "operationId": "execute", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processInstanceId", "in": "query", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "executeType", "in": "query", "description": "执行类型", "required": true, "schema": { "type": "string", "enum": [ "NONE", "REPEAT_RUNNING", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "STOP", "PAUSE", "EXECUTE_TASK" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/executors/execute-task": { "post": { "tags": [ "流程相关操作" ], "summary": "execute-task", "description": "执行流程实例的各种操作(暂停、停止、重跑、恢复等)", "operationId": "executeTask", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processInstanceId", "in": "query", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startNodeList", "in": "query", "description": "开始节点列表(节点name)", "required": true, "schema": { "type": "string" } }, { "name": "taskDependType", "in": "query", "description": "任务依赖类型", "required": true, "schema": { "type": "string", "enum": [ "TASK_ONLY", "TASK_PRE", "TASK_POST" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/executors/batch-start-process-instance": { "post": { "tags": [ "流程相关操作" ], "summary": "batchStartProcessInstance", "description": "批量运行流程实例(其中有任意一个processDefinitionCode找不到,则返回失败信息并且状态置为失败,成功的任务会正常运行,不会停止)", "operationId": "batchStartProcessInstance", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCodes", "in": "query", "description": "流程定义编码列表", "required": true, "schema": { "type": "string" } }, { "name": "scheduleTime", "in": "query", "description": "定时时间,空字符串表示当前天", "required": true, "schema": { "type": "string" } }, { "name": "failureStrategy", "in": "query", "description": "失败策略", "required": true, "schema": { "type": "string", "enum": [ "END", "CONTINUE" ] } }, { "name": "startNodeList", "in": "query", "description": "开始节点列表(节点name)", "required": false, "schema": { "type": "string" } }, { "name": "taskDependType", "in": "query", "description": "任务依赖类型", "required": false, "schema": { "type": "string", "enum": [ "TASK_ONLY", "TASK_PRE", "TASK_POST" ] } }, { "name": "execType", "in": "query", "description": "指令类型", "required": false, "schema": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] } }, { "name": "warningType", "in": "query", "description": "发送策略", "required": true, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "warningGroupId", "in": "query", "description": "发送组ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "runMode", "in": "query", "description": "运行模式", "required": false, "schema": { "type": "string", "enum": [ "RUN_MODE_SERIAL", "RUN_MODE_PARALLEL" ] } }, { "name": "processInstancePriority", "in": "query", "description": "流程实例优先级", "required": true, "schema": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] } }, { "name": "workerGroup", "in": "query", "description": "worker群组", "required": false, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": false, "schema": { "type": "string" } }, { "name": "environmentCode", "in": "query", "description": "环境代码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "timeout", "in": "query", "description": "超时时间", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "startParams", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "expectedParallelismNumber", "in": "query", "description": "补数任务自定义并行度", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "dryRun", "in": "query", "description": "是否空跑", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "testFlag", "in": "query", "description": "测试标识", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "complementDependentMode", "in": "query", "description": "补数依赖的类型", "required": false, "schema": { "type": "string", "enum": [ "OFF_MODE", "ALL_DEPENDENT" ] } }, { "name": "allLevelDependent", "in": "query", "description": "ALL_LEVEL_DEPENDENT", "required": false, "schema": { "type": "boolean" } }, { "name": "executionOrder", "in": "query", "description": "EXECUTION_ORDER", "required": false, "schema": { "type": "string", "enum": [ "DESC_ORDER", "ASC_ORDER" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/executors/batch-execute": { "post": { "tags": [ "流程相关操作" ], "summary": "batchExecute", "description": "批量修改工作流实例状态(当实例id找不到时会报对应id的错误，当部分实例更改状态不符合预期会说明这部分的具体原因)", "operationId": "batchExecute", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processInstanceIds", "in": "query", "description": "流程实例ID集合，如果有多个流程实例则用 \",\" 分隔", "required": true, "schema": { "type": "string" } }, { "name": "executeType", "in": "query", "description": "执行类型", "required": true, "schema": { "type": "string", "enum": [ "NONE", "REPEAT_RUNNING", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "STOP", "PAUSE", "EXECUTE_TASK" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/login": { "post": { "tags": [ "用户登录相关操作" ], "summary": "login", "description": "用户登录", "operationId": "login", "parameters": [ { "name": "userName", "in": "query", "description": "用户名", "required": true, "schema": { "type": "string" } }, { "name": "userPassword", "in": "query", "description": "用户密码", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/k8s-namespace": { "get": { "tags": [ "K8S命名空间相关操作" ], "summary": "queryNamespaceListPaging", "description": "查询命名空间列表页面", "operationId": "queryNamespaceListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "post": { "tags": [ "K8S命名空间相关操作" ], "summary": "createK8sNamespace", "description": "创建命名空间", "operationId": "createNamespace", "parameters": [ { "name": "namespace", "in": "query", "description": "命名空间", "required": true, "schema": { "type": "string" } }, { "name": "clusterCode", "in": "query", "description": "集群代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/k8s-namespace/verify": { "post": { "tags": [ "K8S命名空间相关操作" ], "summary": "verifyNamespaceK8s", "description": "校验命名空间", "operationId": "verifyNamespace", "parameters": [ { "name": "namespace", "in": "query", "description": "命名空间", "required": true, "schema": { "type": "string" } }, { "name": "clusterCode", "in": "query", "description": "集群代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/k8s-namespace/delete": { "post": { "tags": [ "K8S命名空间相关操作" ], "summary": "delNamespaceById", "description": "通过ID删除命名空间", "operationId": "delNamespaceById", "parameters": [ { "name": "id", "in": "query", "description": "k8s命名空间ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/favourite/{taskType}": { "post": { "tags": [ "偏好相关操作" ], "summary": "addTaskType", "description": "添加任务类型", "operationId": "addFavTask", "parameters": [ { "name": "taskType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "偏好相关操作" ], "summary": "deleteTaskType", "description": "删除任务类型", "operationId": "deleteFavTask", "parameters": [ { "name": "taskType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/environment/verify-environment": { "post": { "tags": [ "环境相关操作" ], "summary": "verifyEnvironment", "description": "校验环境", "operationId": "verifyEnvironment", "parameters": [ { "name": "environmentName", "in": "query", "description": "环境名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/environment/update": { "post": { "tags": [ "环境相关操作" ], "summary": "updateEnvironment", "description": "UPDATE_ENVIRONMENT_NOTES", "operationId": "updateEnvironment", "parameters": [ { "name": "code", "in": "query", "description": "环境代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "name", "in": "query", "description": "环境名称", "required": true, "schema": { "type": "string" } }, { "name": "config", "in": "query", "description": "环境配置", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "环境描述", "required": false, "schema": { "type": "string" } }, { "name": "workerGroups", "in": "query", "description": "Worker工作组列表", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultEnvironment" } } } } } } }, "/environment/delete": { "post": { "tags": [ "环境相关操作" ], "summary": "deleteEnvironmentByCode", "description": "通过环境代码删除环境", "operationId": "deleteEnvironment", "parameters": [ { "name": "environmentCode", "in": "query", "description": "环境代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/environment/create": { "post": { "tags": [ "环境相关操作" ], "summary": "createEnvironment", "description": "创建环境", "operationId": "createEnvironment", "parameters": [ { "name": "name", "in": "query", "description": "环境名称", "required": true, "schema": { "type": "string" } }, { "name": "config", "in": "query", "description": "环境配置", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "环境描述", "required": false, "schema": { "type": "string" } }, { "name": "workerGroups", "in": "query", "description": "Worker工作组列表", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultLong" } } } } } } }, "/datasources": { "get": { "tags": [ "数据源相关操作" ], "summary": "queryDataSourceListPaging", "description": "分页查询数据源列表", "operationId": "queryDataSourceListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } }, "post": { "tags": [ "数据源相关操作" ], "summary": "createDataSource", "description": "创建数据源", "operationId": "createDataSource", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "description": "数据源参数" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultDataSource" } } } } } } }, "/datasources/connect": { "post": { "tags": [ "数据源相关操作" ], "summary": "connectDataSource", "description": "连接数据源", "operationId": "connectDataSource", "requestBody": { "description": "dataSourceParam", "content": { "application/json": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/cluster/verify-cluster": { "post": { "tags": [ "集群相关操作" ], "summary": "verifyCluster", "description": "校验集群", "operationId": "verifyCluster", "parameters": [ { "name": "clusterName", "in": "query", "description": "集群名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/cluster/update": { "post": { "tags": [ "集群相关操作" ], "summary": "updateCluster", "description": "更新集群", "operationId": "updateCluster", "parameters": [ { "name": "code", "in": "query", "description": "集群代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "name", "in": "query", "description": "集群名称", "required": true, "schema": { "type": "string" } }, { "name": "config", "in": "query", "description": "集群配置", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "集群描述", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultCluster" } } } } } } }, "/cluster/delete": { "post": { "tags": [ "集群相关操作" ], "summary": "deleteClusterByCode", "description": "通过集群代码删除集群", "operationId": "deleteCluster", "parameters": [ { "name": "clusterCode", "in": "query", "description": "集群代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/cluster/create": { "post": { "tags": [ "集群相关操作" ], "summary": "createCluster", "description": "创建集群", "operationId": "createCluster", "parameters": [ { "name": "name", "in": "query", "description": "集群名称", "required": true, "schema": { "type": "string" } }, { "name": "config", "in": "query", "description": "集群配置", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "集群描述", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultLong" } } } } } } }, "/alert-plugin-instances": { "get": { "tags": [ "告警插件实例相关操作" ], "summary": "queryAlertPluginInstanceListPaging", "description": "分页查询告警实例列表", "operationId": "listPaging_1", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoAlertPluginInstanceVO" } } } } } }, "post": { "tags": [ "告警插件实例相关操作" ], "summary": "createAlertPluginInstance", "description": "创建告警插件实例", "operationId": "createAlertPluginInstance", "parameters": [ { "name": "pluginDefineId", "in": "query", "description": "告警插件定义ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "instanceName", "in": "query", "description": "告警插件实例名称", "required": true, "schema": { "type": "string" } }, { "name": "instanceType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "NORMAL", "GLOBAL" ] } }, { "name": "warningType", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] } }, { "name": "pluginInstanceParams", "in": "query", "description": "告警插件实例参数", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAlertPluginInstance" } } } } } } }, "/alert-plugin-instances/test-send": { "post": { "tags": [ "告警插件实例相关操作" ], "summary": "testSendAlertPluginInstance", "description": "TEST_SEND_ALERT_PLUGIN_INSTANCE", "operationId": "testSendAlertPluginInstance", "parameters": [ { "name": "pluginDefineId", "in": "query", "description": "告警插件定义ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pluginInstanceParams", "in": "query", "description": "告警插件实例参数", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/alert-groups": { "get": { "tags": [ "告警组相关操作" ], "summary": "queryAlertGroupListPaging", "description": "分页查询告警组列表", "operationId": "listPaging_2", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoAlertGroup" } } } } } }, "post": { "tags": [ "告警组相关操作" ], "summary": "createAlertGroup", "description": "创建告警组", "operationId": "createAlertGroup", "parameters": [ { "name": "groupName", "in": "query", "description": "组名称", "required": true, "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "备注(描述)", "required": false, "schema": { "type": "string" } }, { "name": "alertInstanceIds", "in": "query", "description": "alertInstanceIds", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAlertGroup" } } } } } } }, "/alert-groups/query": { "post": { "tags": [ "告警组相关操作" ], "summary": "queryAlertGroupById", "description": "QUERY_ALERT_GROUP_BY_ID_NOTES", "operationId": "queryAlertGroupById", "parameters": [ { "name": "id", "in": "query", "description": "告警组ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAlertGroup" } } } } } } }, "/access-tokens": { "get": { "tags": [ "访问token相关操作" ], "summary": "queryAccessTokenList", "description": "分页查询access token列表", "operationId": "queryAccessTokenList", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 20 } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoAccessToken" } } } } } }, "post": { "tags": [ "访问token相关操作" ], "summary": "createToken", "description": "为指定用户创建安全令牌", "operationId": "createToken", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expireTime", "in": "query", "description": "安全令牌的过期时间", "required": true, "schema": { "type": "string" }, "example": "2021-12-31 00:00:00" }, { "name": "token", "in": "query", "description": "安全令牌字符串，若未显式指定将会自动生成", "required": false, "schema": { "type": "string" }, "example": "xxxx" } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultAccessToken" } } } } } } }, "/access-tokens/generate": { "post": { "tags": [ "访问token相关操作" ], "operationId": "generateToken", "parameters": [ { "name": "userId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "expireTime", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultString" } } } } } } }, "/worker-groups/worker-address-list": { "get": { "tags": [ "Worker分组管理" ], "summary": "queryWorkerAddressList", "description": "查询worker地址列表", "operationId": "queryWorkerAddressList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/worker-groups/all": { "get": { "tags": [ "Worker分组管理" ], "summary": "queryAllWorkerGroups", "description": "查询worker group分组", "operationId": "queryAllWorkerGroups", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/verify-user-name": { "get": { "tags": [ "用户相关操作" ], "summary": "verifyUserName", "description": "验证用户名", "operationId": "verifyUserName", "parameters": [ { "name": "userName", "in": "query", "description": "用户名", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/unauth-user": { "get": { "tags": [ "用户相关操作" ], "summary": "unauthorizedUser", "description": "取消授权", "operationId": "unauthorizedUser", "parameters": [ { "name": "alertgroupId", "in": "query", "description": "告警组ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/list": { "get": { "tags": [ "用户相关操作" ], "summary": "listUser", "description": "用户列表", "operationId": "listUser", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/list-paging": { "get": { "tags": [ "用户相关操作" ], "summary": "queryUserList", "description": "查询用户列表", "operationId": "queryUserList", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/list-all": { "get": { "tags": [ "用户相关操作" ], "operationId": "listAll", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/get-user-info": { "get": { "tags": [ "用户相关操作" ], "summary": "getUserInfo", "description": "获取用户信息", "operationId": "getUserInfo", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/users/authed-user": { "get": { "tags": [ "用户相关操作" ], "summary": "authorizedUser", "description": "授权用户", "operationId": "authorizedUser", "parameters": [ { "name": "alertgroupId", "in": "query", "description": "告警组ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/ui-plugins/{id}": { "get": { "tags": [ "UI插件相关操作" ], "summary": "queryUiPluginDetailById", "description": "通过ID查询UI插件详情", "operationId": "queryUiPluginDetailById", "parameters": [ { "name": "id", "in": "path", "description": "插件ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/ui-plugins/query-by-type": { "get": { "tags": [ "UI插件相关操作" ], "summary": "queryUiPluginsByType", "description": "通过类型查询UI插件", "operationId": "queryUiPluginsByType", "parameters": [ { "name": "pluginType", "in": "query", "description": "pluginType", "required": true, "schema": { "type": "string", "enum": [ "ALERT", "REGISTER", "TASK" ] } } ], "responses": { "201": { "description": "Created", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/tenants/verify-code": { "get": { "tags": [ "租户相关操作" ], "summary": "verifyTenantCode", "description": "验证租户", "operationId": "verifyTenantCode", "parameters": [ { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/tenants/list": { "get": { "tags": [ "租户相关操作" ], "summary": "queryTenantList", "description": "查询租户列表", "operationId": "queryTenantList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListTenant" } } } } } } }, "/task-group/query-list-by-status": { "get": { "tags": [ "任务组相关操作" ], "summary": "queryTaskGroupByStatus", "description": "通过状态查询任务组", "operationId": "queryTaskGroupByStatus", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "任务组状态", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/query-list-by-projectCode": { "get": { "tags": [ "任务组相关操作" ], "summary": "queryTaskGroupByName", "description": "通过项目ID查询工作组列表", "operationId": "queryTaskGroupByCode", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectCode", "in": "query", "description": "项目Code", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/query-list-by-group-id": { "get": { "tags": [ "任务组相关操作" ], "summary": "queryTaskGroupQueuesByGroupId", "description": "QUERY_TASKS_GROUP_GROUP_QUEUES", "operationId": "queryTaskGroupQueues", "parameters": [ { "name": "groupId", "in": "query", "description": "GROUP_ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskInstanceName", "in": "query", "description": "任务实例名称", "required": false, "schema": { "type": "string" } }, { "name": "processInstanceName", "in": "query", "description": "流程实例名称", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "任务组状态", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/task-group/list-paging": { "get": { "tags": [ "任务组相关操作" ], "summary": "list-paging", "description": "查询所有任务组", "operationId": "queryAllTaskGroup", "parameters": [ { "name": "name", "in": "query", "description": "任务组名称", "required": false, "schema": { "type": "string" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/{id}/udf-func": { "get": { "tags": [ "资源中心相关操作" ], "summary": "viewUIUdfFunction", "description": "查看udf函数", "operationId": "viewUIUdfFunction", "parameters": [ { "name": "id", "in": "path", "description": "资源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/view": { "get": { "tags": [ "资源中心相关操作" ], "summary": "viewResource", "description": "通过ID浏览资源", "operationId": "viewResource", "parameters": [ { "name": "skipLineNum", "in": "query", "description": "忽略行数", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "显示多少条", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fullName", "in": "query", "description": "资源全名", "required": true, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/verify-name": { "get": { "tags": [ "资源中心相关操作" ], "summary": "verifyResourceName", "description": "验证资源名称", "operationId": "verifyResourceName", "parameters": [ { "name": "fullName", "in": "query", "description": "资源全名", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/resources/udf-func/verify-name": { "get": { "tags": [ "资源中心相关操作" ], "summary": "verifyUdfFuncName", "description": "验证udf函数名", "operationId": "verifyUdfFuncName", "parameters": [ { "name": "name", "in": "query", "description": "函数名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/udf-func/list": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryUdfFuncList", "description": "查询UDF函数列表", "operationId": "queryUdfFuncList", "parameters": [ { "name": "type", "in": "query", "description": "UDF类型", "required": true, "schema": { "type": "string", "enum": [ "HIVE", "SPARK" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/resources/query-file-name": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryResourceByFileName", "description": "QUERY_BY_RESOURCE_FILE_NAME", "operationId": "queryResourceByFileName", "parameters": [ { "name": "fileName", "in": "query", "description": "RESOURCE_FILE_NAME", "required": true, "schema": { "type": "string" } }, { "name": "tenantCode", "in": "query", "description": "操作系统租户", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/resources/query-by-type": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryResourceByProgramType", "description": "查询资源列表", "operationId": "queryResourceJarList", "parameters": [ { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "programType", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "JAVA", "SCALA", "PYTHON", "SQL" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/resources/list": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryResourceList", "description": "查询资源列表", "operationId": "queryResourceList", "parameters": [ { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } }, { "name": "fullName", "in": "query", "description": "RESOURCE_FULLNAME", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/resources/download": { "get": { "tags": [ "资源中心相关操作" ], "summary": "downloadResource", "description": "下载资源文件", "operationId": "downloadResource", "parameters": [ { "name": "fullName", "in": "query", "description": "RESOURCE_FULLNAME", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/resources/base-dir": { "get": { "tags": [ "资源中心相关操作" ], "summary": "queryResourceBaseDir", "description": "QUERY_RESOURCE_BASE_DIR", "operationId": "queryResourceBaseDir", "parameters": [ { "name": "type", "in": "query", "description": "资源文件类型", "required": true, "schema": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/redirect/login/oauth2": { "get": { "tags": [ "用户登录相关操作" ], "summary": "redirectToOauth2", "description": "REDIRECT_TO_OAUTH2_LOGIN", "operationId": "loginByAuth2", "parameters": [ { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "provider", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/queues/list": { "get": { "tags": [ "队列相关操作" ], "summary": "queryList", "description": "查询队列列表", "operationId": "queryList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListQueue" } } } } } } }, "/projects/{projectCode}/task-instances": { "get": { "tags": [ "任务实例相关操作" ], "summary": "queryTaskListPaging", "description": "分页查询任务实例列表", "operationId": "queryTaskListPaging", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processInstanceId", "in": "query", "description": "流程实例ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "processInstanceName", "in": "query", "description": "流程实例名称", "required": false, "schema": { "type": "string" } }, { "name": "processDefinitionName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "taskName", "in": "query", "description": "任务实例名", "required": false, "schema": { "type": "string" } }, { "name": "taskCode", "in": "query", "description": "TASK_CODE", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "executorName", "in": "query", "description": "流程名称", "required": false, "schema": { "type": "string" } }, { "name": "stateType", "in": "query", "description": "工作流和任务节点的运行状态", "required": false, "schema": { "type": "string", "enum": [ "TaskExecutionStatus{code=0, desc='submit success'}", "TaskExecutionStatus{code=1, desc='running'}", "TaskExecutionStatus{code=3, desc='pause'}", "TaskExecutionStatus{code=5, desc='stop'}", "TaskExecutionStatus{code=6, desc='failure'}", "TaskExecutionStatus{code=7, desc='success'}", "TaskExecutionStatus{code=8, desc='need fault tolerance'}", "TaskExecutionStatus{code=9, desc='kill'}", "TaskExecutionStatus{code=12, desc='delay execution'}", "TaskExecutionStatus{code=13, desc='forced success'}", "TaskExecutionStatus{code=17, desc='dispatch'}" ] } }, { "name": "host", "in": "query", "description": "运行任务的主机IP地址", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "taskExecuteType", "in": "query", "description": "任务执行类型", "required": false, "schema": { "type": "string", "enum": [ "BATCH", "STREAM" ] } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-definition/{code}/versions": { "get": { "tags": [ "任务定义相关操作" ], "summary": "queryVersions", "description": "查询任务定义版本列表", "operationId": "queryTaskDefinitionVersions", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-definition/{code}/versions/{version}": { "get": { "tags": [ "任务定义相关操作" ], "summary": "switchVersion", "description": "切换任务定义版本", "operationId": "switchTaskDefinitionVersion", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "version", "in": "path", "description": "版本号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "任务定义相关操作" ], "summary": "deleteVersion", "description": "删除任务定义版本", "operationId": "deleteTaskDefinitionVersion", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "任务定义代码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "version", "in": "path", "description": "版本号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/task-definition/gen-task-codes": { "get": { "tags": [ "任务定义相关操作" ], "summary": "genTaskCodeList", "description": "查询任务代码列表", "operationId": "genTaskCodeList", "parameters": [ { "name": "genNum", "in": "query", "description": "总数", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-task-relation/{taskCode}/upstream": { "get": { "tags": [ "工作流关系相关操作" ], "summary": "queryUpstreamRelation", "description": "查询上游工作流任务关系", "operationId": "queryUpstreamRelation", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskCode", "in": "path", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "工作流关系相关操作" ], "summary": "deleteUpstreamRelation", "description": "删除上游工作流任务关系", "operationId": "deleteUpstreamRelation", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "preTaskCodes", "in": "query", "description": "PRE_TASK_CODES", "required": true, "schema": { "type": "string" } }, { "name": "taskCode", "in": "path", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-task-relation/{taskCode}/downstream": { "get": { "tags": [ "工作流关系相关操作" ], "summary": "queryDownstreamRelation", "description": "查询下游工作流任务关系", "operationId": "queryDownstreamRelation", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskCode", "in": "path", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "工作流关系相关操作" ], "summary": "deleteDownstreamRelation", "description": "删除下游工作流任务关系", "operationId": "deleteDownstreamRelation", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "postTaskCodes", "in": "query", "description": "POST_TASK_CODES", "required": true, "schema": { "type": "string" } }, { "name": "taskCode", "in": "path", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryProcessInstanceListPaging", "description": "查询流程实例列表", "operationId": "queryProcessInstanceList", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefineCode", "in": "query", "description": "流程定义编码", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "executorName", "in": "query", "description": "流程名称", "required": false, "schema": { "type": "string" } }, { "name": "stateType", "in": "query", "description": "工作流和任务节点的运行状态", "required": false, "schema": { "type": "string", "enum": [ "WorkflowExecutionStatus{code=0, desc='submit success'}", "WorkflowExecutionStatus{code=1, desc='running'}", "WorkflowExecutionStatus{code=2, desc='ready pause'}", "WorkflowExecutionStatus{code=3, desc='pause'}", "WorkflowExecutionStatus{code=4, desc='ready stop'}", "WorkflowExecutionStatus{code=5, desc='stop'}", "WorkflowExecutionStatus{code=6, desc='failure'}", "WorkflowExecutionStatus{code=7, desc='success'}", "WorkflowExecutionStatus{code=12, desc='delay execution'}", "WorkflowExecutionStatus{code=14, desc='serial wait'}", "WorkflowExecutionStatus{code=15, desc='ready block'}", "WorkflowExecutionStatus{code=16, desc='block'}", "WorkflowExecutionStatus{code=17, desc='wait to run'}" ] } }, { "name": "host", "in": "query", "description": "运行任务的主机IP地址", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "otherParamsJson", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/{id}/view-variables": { "get": { "tags": [ "流程实例相关操作" ], "summary": "viewVariables", "description": "查询流程实例全局变量和局部变量", "operationId": "viewVariables", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/{id}/view-gantt": { "get": { "tags": [ "流程实例相关操作" ], "summary": "vieGanttTree", "description": "浏览Gantt图", "operationId": "viewTree", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/{id}/tasks": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryTaskListByProcessId", "description": "通过流程实例ID查询任务列表", "operationId": "queryTaskListByProcessId", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/trigger": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryProcessInstanceListByTrigger", "description": "QUERY_PROCESS_INSTANCE_BY_TRIGGER_NOTES", "operationId": "queryProcessInstancesByTriggerCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "triggerCode", "in": "query", "description": "TRIGGER_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/top-n": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryTopNLongestRunningProcessInstance", "description": "查询topN最长运行流程实例", "operationId": "queryTopNLongestRunningProcessInstance", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "size", "in": "query", "description": "流程实例个数", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "startTime", "in": "query", "description": "流程实例启动时间", "required": true, "schema": { "type": "string" } }, { "name": "endTime", "in": "query", "description": "流程实例结束时间", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultProcessInstance" } } } } } } }, "/projects/{projectCode}/process-instances/query-sub-by-parent": { "get": { "tags": [ "流程实例相关操作" ], "summary": "querySubProcessInstanceByTaskCode", "description": "QUERY_SUBPROCESS_INSTANCE_BY_TASK_CODE_NOTES", "operationId": "querySubProcessInstanceByTaskId", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskId", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "taskCode", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/query-parent-by-sub": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryParentInstanceBySubId", "description": "通过子流程实例ID查询父流程实例信息", "operationId": "queryParentInstanceBySubId", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "subId", "in": "query", "description": "子流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-instances/query-dynamic-sub-workflows": { "get": { "tags": [ "流程实例相关操作" ], "summary": "queryDynamicSubWorkflowInstances", "description": "QUERY_DYNAMIC_SUBPROCESS_INSTANCE_BY_TASK_CODE_NOTES", "operationId": "queryDynamicSubWorkflowInstances", "parameters": [ { "name": "taskId", "in": "query", "description": "taskInstanceId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListDynamicSubWorkflowDto" } } } } } } }, "/projects/{projectCode}/process-definition/{code}/view-variables": { "get": { "tags": [ "流程定义相关操作" ], "summary": "viewVariables", "description": "QUERY_PROCESS_DEFINITION_GLOBAL_VARIABLES_AND_LOCAL_VARIABLES_NOTES", "operationId": "viewVariables_1", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/{code}/view-tree": { "get": { "tags": [ "流程定义相关操作" ], "summary": "viewTree", "description": "树状图", "operationId": "viewTree_1", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "显示多少条", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/{code}/versions": { "get": { "tags": [ "流程定义相关操作" ], "summary": "queryVersions", "description": "查询流程历史版本信息", "operationId": "queryProcessDefinitionVersions", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/{code}/versions/{version}": { "get": { "tags": [ "流程定义相关操作" ], "summary": "switchVersion", "description": "切换流程版本", "operationId": "switchProcessDefinitionVersion", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "version", "in": "path", "description": "版本号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } }, "delete": { "tags": [ "流程定义相关操作" ], "summary": "deleteVersion", "description": "删除流程历史版本", "operationId": "deleteProcessDefinitionVersion", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "version", "in": "path", "description": "版本号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultVoid" } } } } } } }, "/projects/{projectCode}/process-definition/{code}/tasks": { "get": { "tags": [ "流程定义相关操作" ], "summary": "getTasksByDefinitionCode", "description": "GET_TASK_LIST_BY_DEFINITION_CODE_NOTES", "operationId": "getNodeListByDefinitionCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "code", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/verify-name": { "get": { "tags": [ "流程定义相关操作" ], "summary": "verify-name", "description": "验证流程定义名字", "operationId": "verifyProcessDefinitionName", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "name", "in": "query", "description": "流程定义名称", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "流程定义编码", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/simple-list": { "get": { "tags": [ "流程定义相关操作" ], "summary": "querySimpleList", "description": "QUERY_PROCESS_DEFINITION_SIMPLE_LIST_NOTES", "operationId": "queryProcessDefinitionSimpleList", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/query-task-definition-list": { "get": { "tags": [ "流程定义相关操作" ], "summary": "getTaskListByProcessDefinitionCode", "description": "通过工作流定义代码查询任务定义", "operationId": "getTaskListByProcessDefinitionCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/query-process-definition-list": { "get": { "tags": [ "流程定义相关操作" ], "summary": "getProcessListByProjectCode", "description": "通过项目代码查询工作流定义", "operationId": "getProcessListByProjectCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/query-by-name": { "get": { "tags": [ "流程定义相关操作" ], "summary": "queryProcessDefinitionByName", "description": "通过名称查询流程定义", "operationId": "queryProcessDefinitionByName", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "name", "in": "query", "description": "流程定义名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultProcessDefinition" } } } } } } }, "/projects/{projectCode}/process-definition/list": { "get": { "tags": [ "流程定义相关操作" ], "summary": "queryList", "description": "查询流程定义列表", "operationId": "queryProcessDefinitionList", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/batch-query-tasks": { "get": { "tags": [ "流程定义相关操作" ], "summary": "getTaskListByDefinitionCodes", "description": "GET_TASK_LIST_BY_DEFINITION_CODE_NOTES", "operationId": "getNodeListMapByDefinitionCodes", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "codes", "in": "query", "description": "PROCESS_DEFINITION_CODES", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-definition/all": { "get": { "tags": [ "流程定义相关操作" ], "summary": "queryAllByProjectCode", "description": "通过项目代码查询所有工作量定义", "operationId": "queryAllProcessDefinitionByProjectCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/lineages/{workFlowCode}": { "get": { "tags": [ "工作流血缘相关操作" ], "summary": "queryLineageByWorkFlowCode", "description": "通过血缘代码查询工作流血缘关系", "operationId": "queryWorkFlowLineageByCode", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "workFlowCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultMapStringObject" } } } } } } }, "/projects/{projectCode}/lineages/query-dependent-tasks": { "get": { "tags": [ "工作流血缘相关操作" ], "summary": "queryDownstreamDependentTaskList", "description": "QUERY_DOWNSTREAM_DEPENDENT_TASK_NOTES", "operationId": "queryDownstreamDependentTaskList", "parameters": [ { "name": "workFlowCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskCode", "in": "query", "description": "任务定义代码", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultMapStringObject" } } } } } } }, "/projects/{projectCode}/lineages/query-by-name": { "get": { "tags": [ "工作流血缘相关操作" ], "summary": "queryLineageByWorkFlowName", "description": "通过名称查询工作流血缘列表", "operationId": "queryWorkFlowLineageByName", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "workFlowName", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListWorkFlowLineage" } } } } } } }, "/projects/{projectCode}/lineages/list": { "get": { "tags": [ "工作流血缘相关操作" ], "summary": "queryWorkFlowList", "description": "查询工作量血缘关系", "operationId": "queryWorkFlowLineage", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultMapStringObject" } } } } } } }, "/projects/{projectCode}/executors/query-executing-workflow": { "get": { "tags": [ "流程相关操作" ], "summary": "queryExecutingWorkflow", "description": "查询工作流执行数据", "operationId": "queryExecutingWorkflow", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "processInstanceId", "description": "流程实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/unauth-project": { "get": { "tags": [ "项目相关操作" ], "summary": "queryUnauthorizedProject", "description": "查询未授权的项目", "operationId": "queryUnauthorizedProject", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/project-with-authorized-level": { "get": { "tags": [ "项目相关操作" ], "summary": "queryProjectWithAuthorizedLevel", "description": "QUERY_PROJECT_AUTHORIZED_LEVEL", "operationId": "queryProjectWithAuthorizedLevel", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/project-with-authorized-level-list-paging": { "get": { "tags": [ "项目相关操作" ], "summary": "queryProjectWithAuthorizedLevelListPaging", "description": "QUERY_PROJECT_WITH_AUTH_LEVEL_LIST_PAGING_NOTES", "operationId": "queryProjectWithAuthorizedLevelListPaging", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/list": { "get": { "tags": [ "项目相关操作" ], "summary": "queryAllProjectList", "description": "查询所有项目", "operationId": "queryAllProjectList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/list-dependent": { "get": { "tags": [ "项目相关操作" ], "summary": "queryAllProjectListForDependent", "description": "查询Dependent节点所有项目", "operationId": "queryAllProjectListForDependent", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/created-and-authed": { "get": { "tags": [ "项目相关操作" ], "summary": "queryProjectCreatedAndAuthorizedByUser", "description": "查询授权和用户创建的项目", "operationId": "queryProjectCreatedAndAuthorizedByUser", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/authed-user": { "get": { "tags": [ "项目相关操作" ], "summary": "queryAuthorizedUser", "description": "查询拥有项目授权的用户", "operationId": "queryAuthorizedUser", "parameters": [ { "name": "projectCode", "in": "query", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/authed-project": { "get": { "tags": [ "项目相关操作" ], "summary": "queryAuthorizedProject", "description": "查询授权项目", "operationId": "queryAuthorizedProject", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/audit/audit-log-operation-type": { "get": { "tags": [ "审计日志执行相关操作" ], "summary": "queryAuditOperationTypeList", "description": "QUERY_AUDIT_OPERATION_TYPE_LIST", "operationId": "queryAuditOperationTypeList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListAuditOperationTypeDto" } } } } } } }, "/projects/audit/audit-log-model-type": { "get": { "tags": [ "审计日志执行相关操作" ], "summary": "queryAuditModelTypeList", "description": "QUERY_AUDIT_MODEL_TYPE_LIST", "operationId": "queryAuditModelTypeList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListAuditModelTypeDto" } } } } } } }, "/projects/audit/audit-log-list": { "get": { "tags": [ "审计日志执行相关操作" ], "summary": "queryAuditLogListPaging", "description": "查询审计日志", "operationId": "queryAuditLogListPaging", "parameters": [ { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "modelTypes", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "operationTypes", "in": "query", "description": "OPERATION_TYPES", "required": false, "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "userName", "in": "query", "description": "用户名", "required": false, "schema": { "type": "string" } }, { "name": "modelName", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "objectTypes", "description": "MODEL_TYPES", "schema": { "type": "string" } }, { "name": "objectName", "description": "MODEL_NAME", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoAuditDto" } } } } } } }, "/projects/analysis/task-state-count": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "countTaskState", "description": "任务状态统计", "operationId": "getTaskInstanceStateCount", "parameters": [ { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "projectCode", "in": "query", "description": "项目Code", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultTaskInstanceCountVO" } } } } } } }, "/projects/analysis/queue-count": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "countQueueState", "description": "统计队列里任务状态", "operationId": "countQueueState", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultMapStringInteger" } } } } } } }, "/projects/analysis/process-state-count": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "countProcessInstanceState", "description": "统计流程实例状态", "operationId": "getWorkflowInstanceStateCount", "parameters": [ { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "projectCode", "in": "query", "description": "项目Code", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultWorkflowInstanceCountVO" } } } } } } }, "/projects/analysis/listErrorCommand": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "listErrorCommand", "description": "LIST_ERROR_COMMAND_LIST_PAGING_NOTES", "operationId": "listErrorCommand", "parameters": [ { "name": "projectCode", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "description": "搜索值", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoErrorCommand" } } } } } } }, "/projects/analysis/listCommand": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "listPendingCommands", "description": "LIST_PENDING_COMMANDS", "operationId": "listPaging", "parameters": [ { "name": "projectCode", "in": "query", "required": false, "schema": { "type": "integer", "format": "int64" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "searchVal", "description": "搜索值", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoCommand" } } } } } } }, "/projects/analysis/define-user-count": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "countDefinitionByUser", "description": "统计用户创建的流程定义", "operationId": "countDefinitionByUser", "parameters": [ { "name": "projectCode", "in": "query", "description": "项目Code", "required": false, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultWorkflowDefinitionCountVO" } } } } } } }, "/projects/analysis/command-state-count": { "get": { "tags": [ "任务状态分析相关操作" ], "summary": "countCommandState", "description": "统计命令状态", "operationId": "countCommandState", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListCommandStateCount" } } } } } } }, "/oauth2-provider": { "get": { "tags": [ "用户登录相关操作" ], "summary": "getOauth2Provider", "description": "GET_OAUTH2_PROVIDER", "operationId": "oauth2Provider", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListOAuth2ClientProperties" } } } } } } }, "/monitor/{nodeType}": { "get": { "tags": [ "监控相关操作" ], "summary": "listServer", "description": "SERVER_LIST_NOTES", "operationId": "listServer", "parameters": [ { "name": "nodeType", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ALL_SERVERS", "MASTER", "MASTER_NODE_LOCK", "MASTER_FAILOVER_LOCK", "MASTER_TASK_GROUP_COORDINATOR_LOCK", "WORKER", "ALERT_SERVER", "ALERT_LOCK" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListServer" } } } } } } }, "/monitor/databases": { "get": { "tags": [ "监控相关操作" ], "summary": "queryDatabaseState", "description": "查询数据库状态", "operationId": "queryDatabaseState", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListDatabaseMetrics" } } } } } } }, "/login/sso": { "get": { "tags": [ "用户登录相关操作" ], "summary": "sso login", "description": "user sso login", "operationId": "ssoLogin", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/log/{projectCode}/download-log": { "get": { "tags": [ "日志相关操作" ], "summary": "downloadTaskLogInSpecifiedProject", "description": "下载指定项目的任务实例日志", "operationId": "downloadTaskLog", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskInstanceId", "in": "query", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/log/{projectCode}/detail": { "get": { "tags": [ "日志相关操作" ], "summary": "queryLogInSpecifiedProject", "description": "查询指定项目的任务实例日志", "operationId": "queryLog", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskInstanceId", "in": "query", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skipLineNum", "in": "query", "description": "忽略行数", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "显示多少条", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultString" } } } } } } }, "/log/download-log": { "get": { "tags": [ "日志相关操作" ], "summary": "downloadTaskLog", "description": "下载任务实例日志", "operationId": "downloadTaskLog_1", "parameters": [ { "name": "taskInstanceId", "in": "query", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "/log/detail": { "get": { "tags": [ "日志相关操作" ], "summary": "queryLog", "description": "查询任务实例日志", "operationId": "queryLog_1", "parameters": [ { "name": "taskInstanceId", "in": "query", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "skipLineNum", "in": "query", "description": "忽略行数", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "显示多少条", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultResponseTaskLog" } } } } } } }, "/k8s-namespace/unauth-namespace": { "get": { "tags": [ "K8S命名空间相关操作" ], "summary": "queryUnauthorizedNamespace", "description": "查询未授权命名空间", "operationId": "queryUnauthorizedNamespace", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/k8s-namespace/available-list": { "get": { "tags": [ "K8S命名空间相关操作" ], "summary": "queryAvailableNamespaceList", "description": "查询可用命名空间列表", "operationId": "queryAvailableNamespaceList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/k8s-namespace/authed-namespace": { "get": { "tags": [ "K8S命名空间相关操作" ], "summary": "queryAuthorizedNamespace", "description": "查询授权命名空间", "operationId": "queryAuthorizedNamespace", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/favourite/taskTypes": { "get": { "tags": [ "偏好相关操作" ], "summary": "listTaskType", "description": "查询任务类型列表", "operationId": "listTaskType", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/environment/query-environment-list": { "get": { "tags": [ "环境相关操作" ], "summary": "queryAllEnvironmentList", "description": "查询所有环境列表", "operationId": "queryAllEnvironmentList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/environment/query-by-code": { "get": { "tags": [ "环境相关操作" ], "summary": "queryEnvironmentByCode", "description": "通过环境代码查询环境", "operationId": "queryEnvironmentByCode", "parameters": [ { "name": "environmentCode", "in": "query", "description": "环境代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/environment/list-paging": { "get": { "tags": [ "环境相关操作" ], "summary": "queryEnvironmentListPaging", "description": "查询环境列表页面", "operationId": "queryEnvironmentListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/dynamic/{taskCategory}/taskTypes": { "get": { "tags": [ "DYNAMIC_TASK_TYPE" ], "summary": "listDynamicTaskTypes", "description": "LIST_DYNAMIC_TASK_TYPES", "operationId": "listDynamicTaskTypes", "parameters": [ { "name": "taskCategory", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/dynamic/taskCategories": { "get": { "tags": [ "DYNAMIC_TASK_TYPE" ], "summary": "listTaskCategories", "description": "LIST_TASK_TYPE_CATEGORIES", "operationId": "listDynamicTaskCategories", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/datasources/{id}/connect-test": { "get": { "tags": [ "数据源相关操作" ], "summary": "connectionTest", "description": "连接数据源测试", "operationId": "connectionTest", "parameters": [ { "name": "id", "in": "path", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/datasources/verify-name": { "get": { "tags": [ "数据源相关操作" ], "summary": "verifyDataSourceName", "description": "验证数据源", "operationId": "verifyDataSourceName", "parameters": [ { "name": "name", "in": "query", "description": "数据源名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultBoolean" } } } } } } }, "/datasources/unauth-datasource": { "get": { "tags": [ "数据源相关操作" ], "summary": "unauthorizedDatasource", "description": "未授权的数据源", "operationId": "unAuthDatasource", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/datasources/tables": { "get": { "tags": [ "数据源相关操作" ], "summary": "tables", "description": "获取数据源表列表", "operationId": "getTables", "parameters": [ { "name": "datasourceId", "in": "query", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "database", "in": "query", "description": "DATABASE", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/datasources/tableColumns": { "get": { "tags": [ "数据源相关操作" ], "summary": "tableColumns", "description": "获取数据源表列名", "operationId": "getTableColumns", "parameters": [ { "name": "datasourceId", "in": "query", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tableName", "in": "query", "description": "表名", "required": true, "schema": { "type": "string" } }, { "name": "database", "in": "query", "description": "DATABASE", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/datasources/list": { "get": { "tags": [ "数据源相关操作" ], "summary": "queryDataSourceList", "description": "通过数据源类型查询数据源列表", "operationId": "queryDataSourceList", "parameters": [ { "name": "type", "in": "query", "description": "数据源类型", "required": true, "schema": { "type": "string", "enum": [ "MYSQL", "POSTGRESQL", "HIVE", "SPARK", "CLICKHOUSE", "ORACLE", "SQLSERVER", "DB2", "PRESTO", "H2", "REDSHIFT", "ATHENA", "TRINO", "STARROCKS", "AZURESQL", "DAMENG", "OCEANBASE", "SSH", "KYUUBI", "DATABEND", "SNOWFLAKE", "VERTICA", "HANA", "DORIS", "ZEPPELIN", "SAGEMAKER" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/datasources/kerberos-startup-state": { "get": { "tags": [ "数据源相关操作" ], "summary": "getKerberosStartupState", "description": "获取用户信息", "operationId": "getKerberosStartupState", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/datasources/databases": { "get": { "tags": [ "数据源相关操作" ], "summary": "databases", "description": "GET_DATASOURCE_DATABASE_NOTES", "operationId": "getDatabases", "parameters": [ { "name": "datasourceId", "in": "query", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/datasources/authed-datasource": { "get": { "tags": [ "数据源相关操作" ], "summary": "authedDatasource", "description": "授权的数据源", "operationId": "authedDatasource", "parameters": [ { "name": "userId", "in": "query", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultObject" } } } } } } }, "/data-quality/ruleList": { "get": { "tags": [ "数据质量相关操作" ], "summary": "queryRuleList", "description": "查询规则列表", "operationId": "queryRuleList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListDqRule" } } } } } } }, "/data-quality/rule/page": { "get": { "tags": [ "数据质量相关操作" ], "summary": "queryRuleListPaging", "description": "查询规则分页列表", "operationId": "queryRuleListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "ruleType", "in": "query", "description": "规则类型", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoDqRule" } } } } } } }, "/data-quality/result/page": { "get": { "tags": [ "数据质量相关操作" ], "summary": "queryExecuteResultListPaging", "description": "查询数据质量任务结果分页列表", "operationId": "queryExecuteResultListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "ruleType", "in": "query", "description": "规则类型", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "state", "in": "query", "description": "状态", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "startDate", "in": "query", "description": "开始时间", "required": false, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "结束时间", "required": false, "schema": { "type": "string" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoDqExecuteResult" } } } } } } }, "/data-quality/getRuleFormCreateJson": { "get": { "tags": [ "数据质量相关操作" ], "summary": "getRuleFormCreateJson", "description": "获取规则form-create json", "operationId": "getRuleFormCreateJsonById", "parameters": [ { "name": "ruleId", "in": "query", "description": "规则ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultString" } } } } } } }, "/data-quality/getDatasourceOptionsById": { "get": { "tags": [ "数据质量相关操作" ], "summary": "getDatasourceOptionsById", "description": "获取数据源OPTIONS", "operationId": "getDatasourceOptionsById", "parameters": [ { "name": "datasourceId", "in": "query", "description": "数据源ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListParamsOptions" } } } } } } }, "/cluster/query-cluster-list": { "get": { "tags": [ "集群相关操作" ], "summary": "queryAllClusterList", "description": "查询所有集群列表", "operationId": "queryAllClusterList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListClusterDto" } } } } } } }, "/cluster/query-by-code": { "get": { "tags": [ "集群相关操作" ], "summary": "queryClusterByCode", "description": "通过集群ID查询集群", "operationId": "queryClusterByCode", "parameters": [ { "name": "clusterCode", "in": "query", "description": "集群代码", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultClusterDto" } } } } } } }, "/cluster/list-paging": { "get": { "tags": [ "集群相关操作" ], "summary": "queryClusterListPaging", "description": "查询集群分页列表", "operationId": "queryClusterListPaging", "parameters": [ { "name": "searchVal", "in": "query", "description": "搜索值", "required": false, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "description": "页大小", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNo", "in": "query", "description": "页码号", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultPageInfoClusterDto" } } } } } } }, "/cloud/azure/datafactory/resourceGroups": { "get": { "tags": [ "CLOUD_TAG" ], "summary": "listResourceGroup", "description": "LIST_RESOURCE_GROUP", "operationId": "listResourceGroup", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/cloud/azure/datafactory/pipelines": { "get": { "tags": [ "CLOUD_TAG" ], "summary": "listPipeline", "description": "LIST_PIPELINE", "operationId": "listPipeline", "parameters": [ { "name": "factoryName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "resourceGroupName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/cloud/azure/datafactory/factories": { "get": { "tags": [ "CLOUD_TAG" ], "summary": "listDataFactory", "description": "LIST_DATA_FACTORY", "operationId": "listDataFactory", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/alert-plugin-instances/verify-name": { "get": { "tags": [ "告警插件实例相关操作" ], "summary": "verifyAlertInstanceName", "description": "验证告警插件名称", "operationId": "verifyGroupName", "parameters": [ { "name": "alertInstanceName", "in": "query", "description": "告警插件名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/alert-plugin-instances/list": { "get": { "tags": [ "告警插件实例相关操作" ], "summary": "queryAlertPluginInstanceList", "description": "查询所有告警实例列表", "operationId": "getAlertPluginInstance_1", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListAlertPluginInstanceVO" } } } } } } }, "/alert-groups/verify-name": { "get": { "tags": [ "告警组相关操作" ], "summary": "verifyGroupName", "description": "检查告警组是否存在", "operationId": "verifyGroupName_1", "parameters": [ { "name": "groupName", "in": "query", "description": "组名称", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/alert-groups/normal-list": { "get": { "tags": [ "告警组相关操作" ], "summary": "listNormalAlertGroupById", "description": "告警组列表", "operationId": "normalAlertGroupList", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListAlertGroup" } } } } } } }, "/alert-groups/list": { "get": { "tags": [ "告警组相关操作" ], "summary": "listAlertGroupById", "description": "告警组列表", "operationId": "list", "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListAlertGroup" } } } } } } }, "/access-tokens/user/{userId}": { "get": { "tags": [ "访问token相关操作" ], "summary": "queryAccessTokenByUser", "description": "查询指定用户的access token", "operationId": "queryAccessTokenByUser", "parameters": [ { "name": "userId", "in": "path", "description": "用户ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ResultListAccessToken" } } } } } } }, "/worker-groups/{id}": { "delete": { "tags": [ "Worker分组管理" ], "summary": "deleteWorkerGroupById", "description": "通过ID删除worker group", "operationId": "deleteWorkerGroupById", "parameters": [ { "name": "id", "in": "path", "description": "Worker Server分组ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/resources/data-transfer": { "delete": { "tags": [ "资源中心相关操作" ], "summary": "deleteDataTransferData", "description": "Delete the N days ago data of DATA_TRANSFER ", "operationId": "deleteDataTransferData", "parameters": [ { "name": "days", "in": "query", "description": "N days ago", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/DeleteDataTransferResponse" } } } } } } }, "/projects/{projectCode}/task-instances/{id}/remove-cache": { "delete": { "tags": [ "任务实例相关操作" ], "summary": "remove-task-instance-cache", "description": "REMOVE_TASK_INSTANCE_CACHE", "operationId": "removeTaskInstanceCache", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "任务实例ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/TaskInstanceRemoveCacheResponse" } } } } } } }, "/projects/{projectCode}/process-task-relation/{taskCode}": { "delete": { "tags": [ "工作流关系相关操作" ], "summary": "deleteRelation", "description": "删除工作流任务关系", "operationId": "deleteTaskProcessRelation", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "query", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "taskCode", "in": "path", "description": "TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/projects/{projectCode}/process-task-relation/{processDefinitionCode}/{preTaskCode}/{postTaskCode}": { "delete": { "tags": [ "工作流关系相关操作" ], "summary": "deleteEdge", "description": "删除工作流任务连接线", "operationId": "deleteEdge", "parameters": [ { "name": "projectCode", "in": "path", "description": "项目Code", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "processDefinitionCode", "in": "path", "description": "流程定义编码", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "preTaskCode", "in": "path", "description": "PRE_TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "postTaskCode", "in": "path", "description": "POST_TASK_CODE", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Result" } } } } } } }, "/cookies": { "delete": { "tags": [ "用户登录相关操作" ], "operationId": "clearCookieSessionId", "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "ResultBoolean": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "boolean" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultObject": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Result": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Queue": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "queueName": { "type": "string" }, "queue": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultQueue": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Queue" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "BaseDataSourceParamDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "note": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "database": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "other": { "type": "object", "additionalProperties": { "type": "string" } }, "hostAndPortByAddress": { "type": "string", "writeOnly": true }, "type": { "type": "string", "enum": [ "MYSQL", "POSTGRESQL", "HIVE", "SPARK", "CLICKHOUSE", "ORACLE", "SQLSERVER", "DB2", "PRESTO", "H2", "REDSHIFT", "ATHENA", "TRINO", "STARROCKS", "AZURESQL", "DAMENG", "OCEANBASE", "SSH", "KYUUBI", "DATABEND", "SNOWFLAKE", "VERTICA", "HANA", "DORIS", "ZEPPELIN", "SAGEMAKER" ] } } }, "DataSource": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "name": { "type": "string" }, "note": { "type": "string" }, "type": { "type": "string", "enum": [ "MYSQL", "POSTGRESQL", "HIVE", "SPARK", "CLICKHOUSE", "ORACLE", "SQLSERVER", "DB2", "PRESTO", "H2", "REDSHIFT", "ATHENA", "TRINO", "STARROCKS", "AZURESQL", "DAMENG", "OCEANBASE", "SSH", "KYUUBI", "DATABEND", "SNOWFLAKE", "VERTICA", "HANA", "DORIS", "ZEPPELIN", "SAGEMAKER" ] }, "connectionParams": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultDataSource": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/DataSource" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "AlertPluginInstance": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "pluginDefineId": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "pluginInstanceParams": { "type": "string" }, "instanceType": { "type": "string", "enum": [ "NORMAL", "GLOBAL" ] }, "warningType": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultAlertPluginInstance": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AlertPluginInstance" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "AlertGroup": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "groupName": { "type": "string" }, "alertInstanceIds": { "type": "string" }, "description": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "createUserId": { "type": "integer", "format": "int32" } } }, "ResultAlertGroup": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AlertGroup" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "AccessToken": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "token": { "type": "string" }, "expireTime": { "type": "string", "format": "date-time" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "userName": { "type": "string" } } }, "ResultAccessToken": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AccessToken" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultUser": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "User": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "userPassword": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "userType": { "type": "string", "enum": [ "ADMIN_USER", "GENERAL_USER" ] }, "tenantId": { "type": "integer", "format": "int32" }, "state": { "type": "integer", "format": "int32" }, "tenantCode": { "type": "string" }, "queueName": { "type": "string" }, "alertGroup": { "type": "string" }, "queue": { "type": "string" }, "timeZone": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultTenant": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Tenant" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Tenant": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tenantCode": { "type": "string" }, "description": { "type": "string" }, "queueId": { "type": "integer", "format": "int32" }, "queueName": { "type": "string" }, "queue": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultVoid": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Environment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "config": { "type": "string" }, "description": { "type": "string" }, "operator": { "type": "integer", "format": "int32" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultEnvironment": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Environment" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultLong": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "integer", "format": "int64" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Cluster": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "config": { "type": "string" }, "description": { "type": "string" }, "operator": { "type": "integer", "format": "int32" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultCluster": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Cluster" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultString": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "string" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoTenant": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoTenant": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoTenant" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListTenant": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoStorageEntity": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/StorageEntity" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoStorageEntity": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoStorageEntity" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "StorageEntity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "fullName": { "type": "string" }, "fileName": { "type": "string" }, "alias": { "type": "string" }, "pfullName": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "type": { "type": "string", "enum": [ "FILE", "UDF", "ALL" ] }, "size": { "type": "integer", "format": "int64" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "directory": { "type": "boolean" } } }, "PageInfoQueue": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoQueue": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoQueue" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListQueue": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Queue" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "DagData": { "type": "object", "properties": { "processDefinition": { "$ref": "#/components/schemas/ProcessDefinition" }, "processTaskRelationList": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessTaskRelation" } }, "taskDefinitionList": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDefinition" } } } }, "ProcessDefinition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "releaseState": { "type": "string", "enum": [ "OFFLINE", "ONLINE" ] }, "projectCode": { "type": "integer", "format": "int64" }, "description": { "type": "string" }, "globalParams": { "type": "string" }, "globalParamList": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "globalParamMap": { "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "flag": { "type": "string", "enum": [ "NO", "YES" ] }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "projectName": { "type": "string" }, "locations": { "type": "string" }, "scheduleReleaseState": { "type": "string", "enum": [ "OFFLINE", "ONLINE" ] }, "schedule": { "$ref": "#/components/schemas/Schedule" }, "timeout": { "type": "integer", "format": "int32" }, "modifyBy": { "type": "string" }, "warningGroupId": { "type": "integer", "format": "int32" }, "executionType": { "type": "string", "enum": [ "PARALLEL", "SERIAL_WAIT", "SERIAL_DISCARD", "SERIAL_PRIORITY" ] } } }, "ProcessInstance": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "processDefinitionCode": { "type": "integer", "format": "int64" }, "processDefinitionVersion": { "type": "integer", "format": "int32" }, "projectCode": { "type": "integer", "format": "int64" }, "state": { "type": "string", "enum": [ "WorkflowExecutionStatus{code=0, desc='submit success'}", "WorkflowExecutionStatus{code=1, desc='running'}", "WorkflowExecutionStatus{code=2, desc='ready pause'}", "WorkflowExecutionStatus{code=3, desc='pause'}", "WorkflowExecutionStatus{code=4, desc='ready stop'}", "WorkflowExecutionStatus{code=5, desc='stop'}", "WorkflowExecutionStatus{code=6, desc='failure'}", "WorkflowExecutionStatus{code=7, desc='success'}", "WorkflowExecutionStatus{code=12, desc='delay execution'}", "WorkflowExecutionStatus{code=14, desc='serial wait'}", "WorkflowExecutionStatus{code=15, desc='ready block'}", "WorkflowExecutionStatus{code=16, desc='block'}", "WorkflowExecutionStatus{code=17, desc='wait to run'}" ] }, "stateHistory": { "type": "string" }, "stateDescList": { "type": "array", "items": { "$ref": "#/components/schemas/StateDesc" } }, "recovery": { "type": "string", "enum": [ "NO", "YES" ] }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "runTimes": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "host": { "type": "string" }, "processDefinition": { "$ref": "#/components/schemas/ProcessDefinition" }, "commandType": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] }, "commandParam": { "type": "string" }, "taskDependType": { "type": "string", "enum": [ "TASK_ONLY", "TASK_PRE", "TASK_POST" ] }, "maxTryTimes": { "type": "integer", "format": "int32" }, "failureStrategy": { "type": "string", "enum": [ "END", "CONTINUE" ] }, "warningType": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] }, "warningGroupId": { "type": "integer", "format": "int32" }, "scheduleTime": { "type": "string", "format": "date-time" }, "commandStartTime": { "type": "string", "format": "date-time" }, "globalParams": { "type": "string" }, "dagData": { "$ref": "#/components/schemas/DagData" }, "executorId": { "type": "integer", "format": "int32" }, "executorName": { "type": "string" }, "tenantCode": { "type": "string" }, "queue": { "type": "string" }, "isSubProcess": { "type": "string", "enum": [ "NO", "YES" ] }, "locations": { "type": "string" }, "historyCmd": { "type": "string" }, "dependenceScheduleTimes": { "type": "string" }, "duration": { "type": "string" }, "processInstancePriority": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] }, "workerGroup": { "type": "string" }, "environmentCode": { "type": "integer", "format": "int64" }, "timeout": { "type": "integer", "format": "int32" }, "varPool": { "type": "string" }, "nextProcessInstanceId": { "type": "integer", "format": "int32" }, "dryRun": { "type": "integer", "format": "int32" }, "restartTime": { "type": "string", "format": "date-time" }, "testFlag": { "type": "integer", "format": "int32" }, "complementData": { "type": "boolean" }, "cmdTypeIfComplement": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] }, "blocked": { "type": "boolean" } } }, "ProcessTaskRelation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "processDefinitionVersion": { "type": "integer", "format": "int32" }, "projectCode": { "type": "integer", "format": "int64" }, "processDefinitionCode": { "type": "integer", "format": "int64" }, "preTaskCode": { "type": "integer", "format": "int64" }, "preTaskVersion": { "type": "integer", "format": "int32" }, "postTaskCode": { "type": "integer", "format": "int64" }, "postTaskVersion": { "type": "integer", "format": "int32" }, "conditionType": { "type": "string", "enum": [ "NONE", "JUDGE", "DELAY" ] }, "conditionParams": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "Property": { "type": "object", "properties": { "prop": { "type": "string" }, "direct": { "type": "string", "enum": [ "IN", "OUT" ] }, "type": { "type": "string", "enum": [ "VARCHAR", "INTEGER", "LONG", "FLOAT", "DOUBLE", "DATE", "TIME", "TIMESTAMP", "BOOLEAN", "LIST", "FILE" ] }, "value": { "type": "string" } } }, "ResultProcessInstance": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProcessInstance" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Schedule": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "processDefinitionCode": { "type": "integer", "format": "int64" }, "processDefinitionName": { "type": "string" }, "projectName": { "type": "string" }, "definitionDescription": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "timezoneId": { "type": "string" }, "crontab": { "type": "string" }, "failureStrategy": { "type": "string", "enum": [ "END", "CONTINUE" ] }, "warningType": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "releaseState": { "type": "string", "enum": [ "OFFLINE", "ONLINE" ] }, "warningGroupId": { "type": "integer", "format": "int32" }, "processInstancePriority": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] }, "workerGroup": { "type": "string" }, "tenantCode": { "type": "string" }, "environmentCode": { "type": "integer", "format": "int64" }, "environmentName": { "type": "string" } } }, "StateDesc": { "type": "object", "properties": { "time": { "type": "string", "format": "date-time" }, "state": { "type": "string", "enum": [ "WorkflowExecutionStatus{code=0, desc='submit success'}", "WorkflowExecutionStatus{code=1, desc='running'}", "WorkflowExecutionStatus{code=2, desc='ready pause'}", "WorkflowExecutionStatus{code=3, desc='pause'}", "WorkflowExecutionStatus{code=4, desc='ready stop'}", "WorkflowExecutionStatus{code=5, desc='stop'}", "WorkflowExecutionStatus{code=6, desc='failure'}", "WorkflowExecutionStatus{code=7, desc='success'}", "WorkflowExecutionStatus{code=12, desc='delay execution'}", "WorkflowExecutionStatus{code=14, desc='serial wait'}", "WorkflowExecutionStatus{code=15, desc='ready block'}", "WorkflowExecutionStatus{code=16, desc='block'}", "WorkflowExecutionStatus{code=17, desc='wait to run'}" ] }, "desc": { "type": "string" } } }, "TaskDefinition": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "projectCode": { "type": "integer", "format": "int64" }, "userId": { "type": "integer", "format": "int32" }, "taskType": { "type": "string" }, "taskParams": { "type": "string" }, "taskParamList": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } }, "taskParamMap": { "type": "object", "additionalProperties": { "type": "string" } }, "flag": { "type": "string", "enum": [ "NO", "YES" ] }, "isCache": { "type": "string", "enum": [ "NO", "YES" ] }, "taskPriority": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] }, "userName": { "type": "string" }, "projectName": { "type": "string" }, "workerGroup": { "type": "string" }, "environmentCode": { "type": "integer", "format": "int64" }, "failRetryTimes": { "type": "integer", "format": "int32" }, "failRetryInterval": { "type": "integer", "format": "int32" }, "timeoutFlag": { "type": "string", "enum": [ "CLOSE", "OPEN" ] }, "timeoutNotifyStrategy": { "type": "string", "enum": [ "WARN", "FAILED", "WARNFAILED" ] }, "timeout": { "type": "integer", "format": "int32" }, "delayTime": { "type": "integer", "format": "int32" }, "resourceIds": { "type": "string", "deprecated": true }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "modifyBy": { "type": "string" }, "taskGroupId": { "type": "integer", "format": "int32" }, "taskGroupPriority": { "type": "integer", "format": "int32" }, "cpuQuota": { "type": "integer", "format": "int32" }, "memoryMax": { "type": "integer", "format": "int32" }, "taskExecuteType": { "type": "string", "enum": [ "BATCH", "STREAM" ] }, "dependence": { "type": "string" } } }, "DynamicSubWorkflowDto": { "type": "object", "properties": { "processInstanceId": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "index": { "type": "integer", "format": "int64" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" } }, "state": { "type": "string", "enum": [ "WorkflowExecutionStatus{code=0, desc='submit success'}", "WorkflowExecutionStatus{code=1, desc='running'}", "WorkflowExecutionStatus{code=2, desc='ready pause'}", "WorkflowExecutionStatus{code=3, desc='pause'}", "WorkflowExecutionStatus{code=4, desc='ready stop'}", "WorkflowExecutionStatus{code=5, desc='stop'}", "WorkflowExecutionStatus{code=6, desc='failure'}", "WorkflowExecutionStatus{code=7, desc='success'}", "WorkflowExecutionStatus{code=12, desc='delay execution'}", "WorkflowExecutionStatus{code=14, desc='serial wait'}", "WorkflowExecutionStatus{code=15, desc='ready block'}", "WorkflowExecutionStatus{code=16, desc='block'}", "WorkflowExecutionStatus{code=17, desc='wait to run'}" ] } } }, "ResultListDynamicSubWorkflowDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicSubWorkflowDto" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoProcessDefinition": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessDefinition" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoProcessDefinition": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoProcessDefinition" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultProcessDefinition": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProcessDefinition" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultMapStringObject": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "object" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListWorkFlowLineage": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkFlowLineage" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "WorkFlowLineage": { "type": "object", "properties": { "workFlowCode": { "type": "integer", "format": "int64" }, "workFlowName": { "type": "string" }, "workFlowPublishStatus": { "type": "string" }, "scheduleStartTime": { "type": "string", "format": "date-time" }, "scheduleEndTime": { "type": "string", "format": "date-time" }, "crontab": { "type": "string" }, "schedulePublishStatus": { "type": "integer", "format": "int32" }, "sourceWorkFlowCode": { "type": "string" } } }, "AuditOperationTypeDto": { "type": "object", "properties": { "name": { "type": "string" } } }, "ResultListAuditOperationTypeDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditOperationTypeDto" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "AuditModelTypeDto": { "type": "object", "properties": { "name": { "type": "string" } } }, "ResultListAuditModelTypeDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AuditModelTypeDto" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "AuditDto": { "type": "object", "properties": { "userName": { "type": "string" }, "modelType": { "type": "string" }, "modelName": { "type": "string" }, "operation": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "detail": { "type": "string" }, "latency": { "type": "string" } } }, "PageInfoAuditDto": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/AuditDto" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoAuditDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoAuditDto" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultTaskInstanceCountVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/TaskInstanceCountVO" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "TaskInstanceCountVO": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "taskInstanceStatusCounts": { "type": "array", "items": { "$ref": "#/components/schemas/TaskInstanceStatusCountDto" } } } }, "TaskInstanceStatusCountDto": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "TaskExecutionStatus{code=0, desc='submit success'}", "TaskExecutionStatus{code=1, desc='running'}", "TaskExecutionStatus{code=3, desc='pause'}", "TaskExecutionStatus{code=5, desc='stop'}", "TaskExecutionStatus{code=6, desc='failure'}", "TaskExecutionStatus{code=7, desc='success'}", "TaskExecutionStatus{code=8, desc='need fault tolerance'}", "TaskExecutionStatus{code=9, desc='kill'}", "TaskExecutionStatus{code=12, desc='delay execution'}", "TaskExecutionStatus{code=13, desc='forced success'}", "TaskExecutionStatus{code=17, desc='dispatch'}" ] }, "count": { "type": "integer", "format": "int32" } } }, "ResultMapStringInteger": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultWorkflowInstanceCountVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/WorkflowInstanceCountVO" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "WorkflowInstanceCountVO": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "workflowInstanceStatusCounts": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowInstanceStatusCountDto" } } } }, "WorkflowInstanceStatusCountDto": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "WorkflowExecutionStatus{code=0, desc='submit success'}", "WorkflowExecutionStatus{code=1, desc='running'}", "WorkflowExecutionStatus{code=2, desc='ready pause'}", "WorkflowExecutionStatus{code=3, desc='pause'}", "WorkflowExecutionStatus{code=4, desc='ready stop'}", "WorkflowExecutionStatus{code=5, desc='stop'}", "WorkflowExecutionStatus{code=6, desc='failure'}", "WorkflowExecutionStatus{code=7, desc='success'}", "WorkflowExecutionStatus{code=12, desc='delay execution'}", "WorkflowExecutionStatus{code=14, desc='serial wait'}", "WorkflowExecutionStatus{code=15, desc='ready block'}", "WorkflowExecutionStatus{code=16, desc='block'}", "WorkflowExecutionStatus{code=17, desc='wait to run'}" ] }, "count": { "type": "integer", "format": "int32" } } }, "ErrorCommand": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "commandType": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] }, "processDefinitionCode": { "type": "integer", "format": "int64" }, "processDefinitionVersion": { "type": "integer", "format": "int32" }, "processInstanceId": { "type": "integer", "format": "int32" }, "executorId": { "type": "integer", "format": "int32" }, "commandParam": { "type": "string" }, "taskDependType": { "type": "string", "enum": [ "TASK_ONLY", "TASK_PRE", "TASK_POST" ] }, "failureStrategy": { "type": "string", "enum": [ "END", "CONTINUE" ] }, "warningType": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] }, "warningGroupId": { "type": "integer", "format": "int32" }, "scheduleTime": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" }, "processInstancePriority": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] }, "updateTime": { "type": "string", "format": "date-time" }, "message": { "type": "string" }, "workerGroup": { "type": "string" }, "tenantCode": { "type": "string" }, "environmentCode": { "type": "integer", "format": "int64" }, "dryRun": { "type": "integer", "format": "int32" }, "testFlag": { "type": "integer", "format": "int32" } } }, "PageInfoErrorCommand": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorCommand" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoErrorCommand": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoErrorCommand" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Command": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "commandType": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] }, "processDefinitionCode": { "type": "integer", "format": "int64" }, "executorId": { "type": "integer", "format": "int32" }, "commandParam": { "type": "string" }, "taskDependType": { "type": "string", "enum": [ "TASK_ONLY", "TASK_PRE", "TASK_POST" ] }, "failureStrategy": { "type": "string", "enum": [ "END", "CONTINUE" ] }, "warningType": { "type": "string", "enum": [ "NONE", "SUCCESS", "FAILURE", "ALL", "GLOBAL" ] }, "warningGroupId": { "type": "integer", "format": "int32" }, "scheduleTime": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" }, "processInstancePriority": { "type": "string", "enum": [ "HIGHEST", "HIGH", "MEDIUM", "LOW", "LOWEST" ] }, "updateTime": { "type": "string", "format": "date-time" }, "workerGroup": { "type": "string" }, "tenantCode": { "type": "string" }, "environmentCode": { "type": "integer", "format": "int64" }, "dryRun": { "type": "integer", "format": "int32" }, "processInstanceId": { "type": "integer", "format": "int32" }, "processDefinitionVersion": { "type": "integer", "format": "int32" }, "testFlag": { "type": "integer", "format": "int32" } } }, "PageInfoCommand": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/Command" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoCommand": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoCommand" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultWorkflowDefinitionCountVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/WorkflowDefinitionCountVO" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "WorkflowDefinitionCountDto": { "type": "object", "properties": { "userName": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } } }, "WorkflowDefinitionCountVO": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "userList": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowDefinitionCountDto" } } } }, "CommandStateCount": { "type": "object", "properties": { "errorCount": { "type": "integer", "format": "int32" }, "normalCount": { "type": "integer", "format": "int32" }, "commandState": { "type": "string", "enum": [ "START_PROCESS", "START_CURRENT_TASK_PROCESS", "RECOVER_TOLERANCE_FAULT_PROCESS", "RECOVER_SUSPENDED_PROCESS", "START_FAILURE_TASK_PROCESS", "COMPLEMENT_DATA", "SCHEDULER", "REPEAT_RUNNING", "PAUSE", "STOP", "RECOVER_WAITING_THREAD", "RECOVER_SERIAL_WAIT", "EXECUTE_TASK", "DYNAMIC_GENERATION" ] } } }, "ResultListCommandStateCount": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommandStateCount" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "OAuth2ClientProperties": { "type": "object", "properties": { "authorizationUri": { "type": "string" }, "clientId": { "type": "string" }, "redirectUri": { "type": "string" }, "clientSecret": { "type": "string" }, "tokenUri": { "type": "string" }, "userInfoUri": { "type": "string" }, "callbackUrl": { "type": "string" }, "iconUri": { "type": "string" }, "provider": { "type": "string" } } }, "ResultListOAuth2ClientProperties": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/OAuth2ClientProperties" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListServer": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Server" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "Server": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "zkDirectory": { "type": "string" }, "resInfo": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "lastHeartbeatTime": { "type": "string", "format": "date-time" } } }, "DatabaseMetrics": { "type": "object", "properties": { "dbType": { "type": "string", "enum": [ "MYSQL", "MARIADB", "ORACLE", "ORACLE_12C", "DB2", "H2", "HSQL", "SQLITE", "POSTGRE_SQL", "SQL_SERVER2005", "SQL_SERVER", "DM", "XU_GU", "KINGBASE_ES", "PHOENIX", "GAUSS", "CLICK_HOUSE", "GBASE", "GBASE_8S", "GBASEDBT", "GBASE_INFORMIX", "OSCAR", "SYBASE", "OCEAN_BASE", "FIREBIRD", "HIGH_GO", "CUBRID", "GOLDILOCKS", "CSIIDB", "SAP_HANA", "IMPALA", "VERTICA", "XCloud", "OTHER" ] }, "state": { "type": "string", "enum": [ "YES", "NO" ] }, "maxConnections": { "type": "integer", "format": "int64" }, "maxUsedConnections": { "type": "integer", "format": "int64" }, "threadsConnections": { "type": "integer", "format": "int64" }, "threadsRunningConnections": { "type": "integer", "format": "int64" }, "date": { "type": "string", "format": "date-time" } } }, "ResultListDatabaseMetrics": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseMetrics" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResponseTaskLog": { "type": "object", "properties": { "lineNum": { "type": "integer", "format": "int32" }, "message": { "type": "string" } } }, "ResultResponseTaskLog": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ResponseTaskLog" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "DqRule": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "type": { "type": "integer", "format": "int32" }, "ruleJson": { "type": "string" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultListDqRule": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/DqRule" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoDqRule": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/DqRule" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoDqRule": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoDqRule" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "DqExecuteResult": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "processDefinitionId": { "type": "integer", "format": "int64" }, "processDefinitionName": { "type": "string" }, "processDefinitionCode": { "type": "integer", "format": "int64" }, "processInstanceId": { "type": "integer", "format": "int64" }, "processInstanceName": { "type": "string" }, "projectCode": { "type": "integer", "format": "int64" }, "taskInstanceId": { "type": "integer", "format": "int64" }, "taskName": { "type": "string" }, "ruleType": { "type": "integer", "format": "int32" }, "ruleName": { "type": "string" }, "statisticsValue": { "type": "number", "format": "double" }, "comparisonValue": { "type": "number", "format": "double" }, "comparisonType": { "type": "integer", "format": "int32" }, "comparisonTypeName": { "type": "string" }, "checkType": { "type": "integer", "format": "int32" }, "threshold": { "type": "number", "format": "double" }, "operator": { "type": "integer", "format": "int32" }, "failureStrategy": { "type": "integer", "format": "int32" }, "userId": { "type": "integer", "format": "int32" }, "userName": { "type": "string" }, "state": { "type": "integer", "format": "int32" }, "errorOutputPath": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "PageInfoDqExecuteResult": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/DqExecuteResult" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoDqExecuteResult": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoDqExecuteResult" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ParamsOptions": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "object" }, "disabled": { "type": "boolean" } } }, "ResultListParamsOptions": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ParamsOptions" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ClusterDto": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "code": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "config": { "type": "string" }, "description": { "type": "string" }, "processDefinitions": { "type": "array", "items": { "type": "string" } }, "operator": { "type": "integer", "format": "int32" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" } } }, "ResultListClusterDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterDto" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultClusterDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ClusterDto" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoClusterDto": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/ClusterDto" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoClusterDto": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoClusterDto" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "AlertPluginInstanceVO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "pluginDefineId": { "type": "integer", "format": "int32" }, "instanceName": { "type": "string" }, "instanceType": { "type": "string" }, "warningType": { "type": "string" }, "pluginInstanceParams": { "type": "string" }, "createTime": { "type": "string", "format": "date-time" }, "updateTime": { "type": "string", "format": "date-time" }, "alertPluginName": { "type": "string" } } }, "PageInfoAlertPluginInstanceVO": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/AlertPluginInstanceVO" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoAlertPluginInstanceVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoAlertPluginInstanceVO" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListAlertPluginInstanceVO": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AlertPluginInstanceVO" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoAlertGroup": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/AlertGroup" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoAlertGroup": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoAlertGroup" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListAlertGroup": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AlertGroup" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "PageInfoAccessToken": { "type": "object", "properties": { "totalList": { "type": "array", "items": { "$ref": "#/components/schemas/AccessToken" } }, "total": { "type": "integer", "format": "int32" }, "totalPage": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "currentPage": { "type": "integer", "format": "int32" }, "pageNo": { "type": "integer", "format": "int32" } } }, "ResultPageInfoAccessToken": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PageInfoAccessToken" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "ResultListAccessToken": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccessToken" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "DeleteDataTransferResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object" }, "successList": { "type": "array", "items": { "type": "string" } }, "failedList": { "type": "array", "items": { "type": "string" } }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } }, "TaskInstanceRemoveCacheResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "msg": { "type": "string" }, "data": { "type": "object" }, "cacheKey": { "type": "string" }, "failed": { "type": "boolean" }, "success": { "type": "boolean" } } } } } }

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ocean-zhc/dolphinscheduler-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server