html.apiJob.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quartz-webui Show documentation
Quartz Simple WebUI
The newest version!


     
    
        7.获取Job信息
    
    
        
            
                
                    
                        描述:
                    
                    
                        获取(Job)作业的信息

                        返回值为Map类型的Json信息,key值为(Scheduler)调度器名称,value为(job)作业信息
                    
                
                
                    
                        url:
                    
                    
                        /api/jobInfo.json
                    
                
                
                    
                        输入参数:
                    
                    
                        
                            无
                        
                    
                
                
                    
                        输出参数:
                    
                    
                        
                            
                                参数名称
                                类型
                                描述
                            
                            
                                content.schedulerName
                                json array
                                key值为(Scheduler)调度器名称,value值为(Job)作业信息
                            
                            
                                jobName
                                string
                                (job)作业名称
                            
                            
                                jobGroup
                                string
                                (job)作业分组
                            
                            
                                jobClass
                                string
                                
                                    (jobClass)作业类有一下几类:
                                    
                                        com.github.webui.job.MethodInvokeJob:执行方法的Job
                                        com.github.webui.job.StatefulMethodInvokeJob:有状态执行方法的Job
                                        implements org.quartz.Job:继承Job的正常类
                                    
                                
                            
                            
                                isConcurrentExectionDisallowed
                                string
                                (job)作业是否允许并发
                            
                            
                                isDurable
                                string
                                (job)作业是否持久化
                            
                            
                                isPersistJobDataAfterExecution
                                string
                                是否执行后保存
                            
                            
                                description
                                string
                                (job)作业描述
                            
                            
                                jobDataMap
                                string
                                
                                    (job)作业执行时的数据
                                
                            

                        
                    
                
                
                    
                        请求示例:
                    
                    
                        url/api/jobInfo.json
                    
                
                
                    
                        返回信息:
                    
                    
                                                     {
                            "resultCode": 1,
                            "content": {
                                "quartzScheduler": [
                                        {
                                            "jobName": "2",
                                            "jobGroup": "2",
                                            "jobClass": "com.github.webui.job.MethodInvokeJob",
                                            "isConcurrentExectionDisallowed": false,
                                            "isDurable": true,
                                            "isPersistJobDataAfterExecution": false,
                                            "jobDataMap": {
                                                "methodInvoker": "com.github.webui.job.MethodInvoker"
                                            },
                                            "description": ""
                                        },
                                        {
                                            "jobName": "55",
                                            "jobGroup": "55555",
                                            "jobClass": "com.github.webui.job.MethodInvokeJob",
                                            "isConcurrentExectionDisallowed": false,
                                            "isDurable": true,
                                            "isPersistJobDataAfterExecution": false,
                                            "jobDataMap": {
                                                "methodInvoker": "com.github.webui.job.MethodInvoker"
                                            },
                                            "description": "15554"
                                        }
                                    ]
                                }
                             }
                        
                    
                

            
        
    





     
    
        8.添加Job
    
    
        
            
                
                    
                        描述:
                    
                    
                        添加(Job)作业的信息,如果job存在便修改,jobClass有三类

                        
                            继承org.quartz.Job类
                            执行类的某个方法
                            有状态-执行类的某个方法
                        
                    
                
                
                    
                        url:
                    
                    
                        /api/jobAdd.json
                    
                
                
                    
                        输入参数:
                    
                    
                        
                            
                                参数名称
                                类型
                                是否必填
                                描述
                            
                            
                                schedulerName
                                String
                                YES
                                (scheduler)调度器名称
                            
                            
                                jobName
                                String
                                YES
                                (job)作业名称
                            
                            
                                jobGroup
                                String
                                YES
                                (job)作业分组
                            
                            
                                jobClass
                                String
                                YES
                                
                                    (job)作业执行类
                                    
                                        继承org.quartz.Job类
                                        自定义类
                                    
                                
                            
                            
                                jobType
                                String
                                YES
                                
                                    (job)作业执行类的类型
                                    
                                        1:继承org.quartz.Job类
                                        2:自定义类
                                    
                                
                            
                            
                                jobClassParamType_{index}
                                String
                                NO
                                
                                    (job)作业类的参数类型

                                    index:序号
                                
                            
                            
                                jobClassParamTypeValue_{index}
                                String
                                NO
                                
                                    (job)作业类的参数

                                    index:序号

                                    类型需要和jobClassParamType_{index}对应,否则将会报错
                                
                            
                            
                                jobClassMethodName
                                String
                                NO
                                
                                    (job)作业当为自定义类是,必填

                                    必须是自定义类中有的方法,否则报错
                                
                            
                            
                                jobClassMethodParamType_{index}
                                String
                                NO
                                
                                    (job)作业方法参数类型

                                    index:序号
                                
                            
                            
                                jobClassMethodParamTypeValue_{index}
                                String
                                NO
                                
                                    (job)作业方法参数类型

                                    index:序号

                                    类型需要和jobClassMethodParamType_{index}对应,否则将会报错
                                
                            
                            
                                methodInvokerType
                                String
                                NO
                                
                                    (job)作业方法执行类型
                                    
                                        1:无状态
                                        2:有状态
                                    
                                
                            
                            
                                jobDataMapKey_{index}
                                String
                                NO
                                (job)作业数据(jobDataMap)key值
                            
                            
                                jobDataMapValue_{index}
                                String
                                NO
                                (job)作业数据(jobDataMap)value值
                            
                            
                                description
                                String
                                NO
                                (job)作业描述
                            
                        
                    
                
                
                    
                        输出参数:
                    
                    
                        "ok"
                    
                
                
                    
                        请求示例:
                    
                    
                        url/api/jobAdd.json?schedulerName=quartzScheduler
                            &jobName=job1&jobGroup=job2&jobType=1
                            &jobClass=com.github.webui.job.TestJob
                            &jobDataMapKey_0=key
                            &jobDataMapValue_0=value
                            &description=测试
                    
                
                
                    
                        返回信息:
                    
                    
                                                     {
                                "resultCode": 1,
                                "content": "ok"
                                }
                        
                    
                
            
        
    





     
    
        9.重启Job
    
    
        
            
                
                    
                        描述:
                    
                    
                        重启(job)作业
                    
                
                
                    
                        url:
                    
                    
                        /api/jobResume.json
                    
                
                
                    
                        输入参数:
                    
                    
                        
                            
                                参数名称
                                类型
                                是否必填
                                描述
                            
                            
                                schedulerName
                                String
                                YES
                                (scheduler)调度器名称
                            
                            
                                jobName
                                String
                                YES
                                (job)作业名称
                            
                            
                                jobGroup
                                String
                                YES
                                (job)作业分组
                            
                        
                    
                
                
                    
                        输出参数:
                    
                    
                        "ok"
                    
                
                
                    
                        请求示例:
                    
                    
                        url/api/jobResume.json?schedulerName=quartzScheduler&jobName=jobName&jobGroup=jobGroup
                    
                
                
                    
                        返回信息:
                    
                    
                                                     {
                                "resultCode": 1,
                                "content": "ok"
                             }
                        
                    
                

            
        
    





     
    
        10.移除Job
    
    
        
            
                
                    
                        描述:
                    
                    
                        移除(job)作业,暂停全部的(job)作业之后删除
                    
                
                
                    
                        url:
                    
                    
                        /api/jobRemove.json
                    
                
                
                    
                        输入参数:
                    
                    
                        
                            
                                参数名称
                                类型
                                是否必填
                                描述
                            
                            
                                schedulerName
                                String
                                YES
                                (scheduler)调度器名称
                            
                            
                                jobName
                                String
                                YES
                                (job)作业名称
                            
                            
                                jobGroup
                                String
                                YES
                                (job)作业分组
                            
                        
                    
                
                
                    
                        输出参数:
                    
                    
                        "ok"
                    
                
                
                    
                        请求示例:
                    
                    
                        url/api/jobRemove.json?schedulerName=quartzScheduler&jobName=jobName&jobGroup=jobGroup
                    
                
                
                    
                        返回信息:
                    
                    
                                                     {
                                "resultCode": 1,
                                "content": "ok"
                             }
                        
                    
                

            
        
    





     
    
        11.暂停Job
    
    
        
            
                
                    
                        描述:
                    
                    
                        暂停(job)作业,暂停全部的(trigger)触发器
                    
                
                
                    
                        url:
                    
                    
                        /api/jobPause.json
                    
                
                
                    
                        输入参数:
                    
                    
                        
                            
                                参数名称
                                类型
                                是否必填
                                描述
                            
                            
                                schedulerName
                                String
                                YES
                                (scheduler)调度器名称
                            
                            
                                jobName
                                String
                                YES
                                (job)作业名称
                            
                            
                                jobGroup
                                String
                                YES
                                (job)作业分组
                            
                        
                    
                
                
                    
                        输出参数:
                    
                    
                        "ok"
                    
                
                
                    
                        请求示例:
                    
                    
                        url/api/jobPause.json?schedulerName=quartzScheduler&jobName=jobName&jobGroup=jobGroup
                    
                
                
                    
                        返回信息:
                    
                    
                                                     {
                                "resultCode": 1,
                                "content": "ok"
                             }
                        
                    
                

            
        
    





     
    
        12.运行Job
    
    
        
            
                
                    
                        描述:
                    
                    
                        运行(job)作业
                    
                
                
                    
                        url:
                    
                    
                        /api/jobRun.json
                    
                
                
                    
                        输入参数:
                    
                    
                        
                            
                                参数名称
                                类型
                                是否必填
                                描述
                            
                            
                                schedulerName
                                String
                                YES
                                (scheduler)调度器名称
                            
                            
                                jobName
                                String
                                YES
                                (job)作业名称
                            
                            
                                jobGroup
                                String
                                YES
                                (job)作业分组
                            
                        
                    
                
                
                    
                        输出参数:
                    
                    
                        "ok"
                    
                
                
                    
                        请求示例:
                    
                    
                        url/api/jobRun.json?schedulerName=quartzScheduler&jobName=jobName&jobGroup=jobGroup
                    
                
                
                    
                        返回信息:
                    
                    
                                                     {
                                "resultCode": 1,
                                "content": "ok"
                             }
参数名称	类型	描述
content.schedulerName	json array	key值为(Scheduler)调度器名称,value值为(Job)作业信息
jobName	string	(job)作业名称
jobGroup	string	(job)作业分组
jobClass	string	(jobClass)作业类有一下几类: com.github.webui.job.MethodInvokeJob:执行方法的Job com.github.webui.job.StatefulMethodInvokeJob:有状态执行方法的Job implements org.quartz.Job:继承Job的正常类
isConcurrentExectionDisallowed	string	(job)作业是否允许并发
isDurable	string	(job)作业是否持久化
isPersistJobDataAfterExecution	string	是否执行后保存
description	string	(job)作业描述
jobDataMap	string	(job)作业执行时的数据
参数名称	类型	是否必填	描述
schedulerName	String	YES	(scheduler)调度器名称
jobName	String	YES	(job)作业名称
jobGroup	String	YES	(job)作业分组
jobClass	String	YES	(job)作业执行类继承org.quartz.Job类自定义类
jobType	String	YES	(job)作业执行类的类型 1:继承org.quartz.Job类 2:自定义类
jobClassParamType_{index}	String	NO	(job)作业类的参数类型 index:序号
jobClassParamTypeValue_{index}	String	NO	(job)作业类的参数 index:序号类型需要和jobClassParamType_{index}对应,否则将会报错
jobClassMethodName	String	NO	(job)作业当为自定义类是,必填必须是自定义类中有的方法,否则报错
jobClassMethodParamType_{index}	String	NO	(job)作业方法参数类型 index:序号
jobClassMethodParamTypeValue_{index}	String	NO	(job)作业方法参数类型 index:序号类型需要和jobClassMethodParamType_{index}对应,否则将会报错
methodInvokerType	String	NO	(job)作业方法执行类型 1:无状态 2:有状态
jobDataMapKey_{index}	String	NO	(job)作业数据(jobDataMap)key值
jobDataMapValue_{index}	String	NO	(job)作业数据(jobDataMap)value值
description	String	NO	(job)作业描述