cn.bctools.xxl.job.api

接口 XxlAdminApi

@FeignClient(name="jvs-apply-job-admin",
             path="/xxl-job-admin")
public interface XxlAdminApi

作者:

guojing

方法概要

限定符和类型	方法和说明
cn.bctools.common.utils.R<Boolean>	delete(int id, String token) 删除一个定时任务
cn.bctools.common.utils.R<Integer>	save(XxlJobInfoDto xxlJobInfoDto, String token, String jobName) 生成一个新的定时任务 或直接更新一个新的定时任务，逻辑执行器那边添加或修改时，可直接调用此方法即可完成定时任务的调用，调用的定时任务Handler 名为 RuleTask 参数自定义

方法详细资料

delete

@DeleteMapping(value="/job/api/{id}")
cn.bctools.common.utils.R<Boolean> delete(@PathVariable(value="id")
                                                                                 int id,
                                                                                 @RequestHeader(value="XXL-JOB-ACCESS-TOKEN")
                                                                                 String token)
                                                                          throws Exception

删除一个定时任务

参数:

id - 使用定时任务的ID值

抛出:

Exception - 删除一个定时任务失败

save

@PostMapping(value="/job/api/save")
cn.bctools.common.utils.R<Integer> save(@RequestBody
                                                                             XxlJobInfoDto xxlJobInfoDto,
                                                                             @RequestHeader(value="XXL-JOB-ACCESS-TOKEN")
                                                                             String token,
                                                                             @RequestHeader(value="jobName")
                                                                             String jobName)
                                                                      throws Exception

生成一个新的定时任务 或直接更新一个新的定时任务，逻辑执行器那边添加或修改时，可直接调用此方法即可完成定时任务的调用，调用的定时任务Handler 名为 RuleTask 参数自定义

参数:

xxlJobInfoDto - 定时任务的基础参数

抛出:

Exception - 修改或保存一个定时任务失败