diff --git a/oh-my-scheduler-server/pom.xml b/oh-my-scheduler-server/pom.xml index 04bc87f3..f8be36a2 100644 --- a/oh-my-scheduler-server/pom.xml +++ b/oh-my-scheduler-server/pom.xml @@ -19,6 +19,9 @@ 1.1.1 8.0.19 1.4.200 + + + true diff --git a/oh-my-scheduler-server/src/main/resources/logback-product.xml b/oh-my-scheduler-server/src/main/resources/logback-product.xml index 0958d101..250e78d9 100644 --- a/oh-my-scheduler-server/src/main/resources/logback-product.xml +++ b/oh-my-scheduler-server/src/main/resources/logback-product.xml @@ -7,7 +7,7 @@ 大坑记录:`~/logs`不会在用户目录下创建文件夹,而是在项目目录下创建名为~的文件夹 --> - + diff --git a/oh-my-scheduler-worker-samples/pom.xml b/oh-my-scheduler-worker-samples/pom.xml index e5eaf66c..da3863ad 100644 --- a/oh-my-scheduler-worker-samples/pom.xml +++ b/oh-my-scheduler-worker-samples/pom.xml @@ -16,6 +16,9 @@ 2.2.6.RELEASE 1.1.1 1.2.68 + + + true diff --git a/others/doc/OpenApiGuide.md b/others/doc/OpenApiGuide.md index 75625fdf..f0b3943e 100644 --- a/others/doc/OpenApiGuide.md +++ b/others/doc/OpenApiGuide.md @@ -3,7 +3,7 @@ ## 快速开始 >OpenAPI允许开发者通过接口来完成手工的操作,让系统整体变得更加灵活,启用OpenAPI需要依赖`oh-my-scheduler-client`库。 -最新依赖版本请参考Maven中央仓库:[推荐地址](https://search.maven.org/search?q=com.github.kfcfans)&[备用地址](https://mvnrepository.com/search?q=com.github.kfcfans)。 +最新依赖版本请参考Maven中央仓库:[推荐地址](https://search.maven.org/search?q=oh-my-scheduler-client)&[备用地址](https://mvnrepository.com/search?q=com.github.kfcfans)。 ```xml @@ -25,8 +25,10 @@ ohMyClient.stopInstance(1586855173043L) ## 功能列表 #### 创建/修改任务 接口签名:`ResultDTO saveJob(ClientJobInfo newJobInfo)` -入参:任务信息(详细说明见下表) -返回值:任务ID + +入参:任务信息(详细说明见下表,也可以参考[前端任务创建各参数的正确填法](./ConsoleGuide.md)) + +返回值:ResultDTO,根据success判断操作是否成功。若操作成功,data字段返回任务ID |属性|说明| |----|----| @@ -52,17 +54,58 @@ ohMyClient.stopInstance(1586855173043L) |notifyUserIds|接收报警的用户ID列表| |enable|是否启用该任务,未启用的任务不会被调度| +#### 查找任务 +接口签名:`ResultDTO fetchJob(Long jobId)` + +入参:任务ID + +返回值:根据success判断操作是否成功,若请求成功则返回任务的详细信息 + #### 禁用某个任务 接口签名:`ResultDTO disableJob(Long jobId)` + 入参:任务ID -返回值:无 + +返回值:根据success判断操作是否成功 + +#### 启用某个任务 +接口签名:`ResultDTO enableJob(Long jobId)` + +入参:任务ID + +返回值:根据success判断操作是否成功 #### 删除某个任务 接口签名:`ResultDTO deleteJob(Long jobId)` + 入参:任务ID -返回值:无 + +返回值:根据success判断操作是否成功 #### 立即运行某个任务 接口签名:`ResultDTO runJob(Long jobId, String instanceParams)` + 入参:任务ID + **任务实例参数**(Processor#process方法入参`TaskContext`对象的instanceParams字段) -返回值:对应的任务实例ID(instanceId) \ No newline at end of file + +返回值:根据success判断操作是否成功,操作成功返回对应的任务实例ID(instanceId) + +#### 停止某个任务实例 +接口签名:`ResultDTO stopInstance(Long instanceId)` + +入参:任务实例ID + +返回值:根据success判断操作是否成功 + +#### 查询某个任务实例 +接口签名:`ResultDTO fetchInstanceInfo(Long instanceId)` + +入参:任务实例ID + +返回值:根据success判断操作是否成功,操作成功返回任务实例的详细信息 + +#### 查询某个任务实例的状态 +接口签名:`ResultDTO fetchInstanceStatus(Long instanceId)` + +入参:任务实例ID + +返回值:根据success判断操作是否成功,操作成功返回任务实例的状态码,对应的枚举为:InstanceStatus \ No newline at end of file diff --git a/others/doc/ProcessorDevGuide.md b/others/doc/ProcessorDevGuide.md index 925f0a53..c5b1e253 100644 --- a/others/doc/ProcessorDevGuide.md +++ b/others/doc/ProcessorDevGuide.md @@ -3,7 +3,7 @@ ## 宿主应用接入 #### 添加依赖 -* 最新依赖版本请参考Maven中央仓库:[推荐地址](https://search.maven.org/search?q=com.github.kfcfans)&[备用地址](https://mvnrepository.com/search?q=com.github.kfcfans)。 +* 最新依赖版本请参考Maven中央仓库:[推荐地址](https://search.maven.org/search?q=oh-my-scheduler-worker)&[备用地址](https://mvnrepository.com/search?q=com.github.kfcfans)。 ```xml diff --git a/others/doc/SystemInitGuide.md b/others/doc/SystemInitGuide.md index 92194c5b..6c1ea659 100644 --- a/others/doc/SystemInitGuide.md +++ b/others/doc/SystemInitGuide.md @@ -12,7 +12,8 @@ * 注2:手动建表SQL文件:[oms-sql.sql](../oms-sql.sql) 2. 部署调度服务器(OhMyScheduler-Server),需要先修改配置文件(同样为了支持多环境部署,采用了daily、pre和product3套配置文件),之后自行编译部署运行。 - * 注:OhMyScheduler-Server支持集群部署,具备完全的水平扩展能力。建议部署多个实例以实现高可用&高性能。 + * 注1:OhMyScheduler-Server支持集群部署,具备完全的水平扩展能力。建议部署多个实例以实现高可用&高性能。 + * 注2:通过启动参数`--spring.profiles.active=product`来指定使用某套配置文件(默认为daily) * application-xxx.properties文件配置说明如下表所示: * |配置项|含义|可选| |----|----|----| diff --git a/pom.xml b/pom.xml index 6d2d71d8..0339c874 100644 --- a/pom.xml +++ b/pom.xml @@ -106,8 +106,8 @@ - ${artifactId} - ${version} + ${project.artifactId} + ${project.version} @@ -224,8 +224,8 @@ - ${artifactId} - ${version} + ${project.artifactId} + ${project.version}