3. 定时任务管理接口

API列表

编号 API名称 路径 版本
3.1 新增 /smartcmty-job-admin/jobinfo/add 1.0
3.2 新增并开始 /smartcmty-job-admin/jobinfo/addAndStart 1.0
3.3 查询 /smartcmty-job-admin/jobinfo/get 1.0
3.4 触发下一次 /smartcmty-job-admin/jobinfo/nextTriggerTime 1.0
3.5 分页查询 /smartcmty-job-admin/jobinfo/pageList 1.0
3.6 删除 /smartcmty-job-admin/jobinfo/remove 1.0
3.7 开始 /smartcmty-job-admin/jobinfo/start 1.0
3.8 停止 /smartcmty-job-admin/jobinfo/stop 1.0
3.9 触发 /smartcmty-job-admin/jobinfo/trigger 1.0
3.10 更新 /smartcmty-job-admin/jobinfo/update 1.0

3.1. 新增

接口地址:/smartcmty-job-admin/jobinfo/add

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
author 负责人 query true string
executorBlockStrategy 阻塞处理策略，默认：SERIAL_EXECUTION query true string
executorHandler 执行器，任务Handler名称，默认：RestTaskJobHandler query true string
executorRouteStrategy 执行器路由策略，默认：FIRST query true string
glueType GLUE类型，默认BEAN query true string
jobCron 任务执行CRON表达式 query true string
jobDesc 任务执行描述 query true string
jobGroup 执行器ID query true integer(int32)
triggerStatus 调度状态：0-停止，1-运行 query true integer(int32)
addTime 创建时间 query false string(date-time)
alarmEmail 报警邮件 query false string
childJobId 子任务ID，多个逗号分隔 query false string
executorFailRetryCount 失败重试次数，默认：0 query false integer(int32)
executorParam 执行器，任务参数，默认json格式 query false string
executorTimeout 任务执行超时时间，单位秒，默认：0 query false integer(int32)
glueRemark GLUE备注 query false string
glueSource GLUE源代码 query false string
glueUpdatetime GLUE更新时间 query false string(date-time)
id 任务ID query false integer(int32)
triggerLastTime 上次调度时间 query false integer(int64)
triggerNextTime 下次调度时间 query false integer(int64)
updateTime 更新时间 query false string(date-time)

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}

3.2. 新增并开始

接口地址:/smartcmty-job-admin/jobinfo/addAndStart

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
author 负责人 query true string
executorBlockStrategy 阻塞处理策略，默认：SERIAL_EXECUTION query true string
executorHandler 执行器，任务Handler名称，默认：RestTaskJobHandler query true string
executorRouteStrategy 执行器路由策略，默认：FIRST query true string
glueType GLUE类型，默认BEAN query true string
jobCron 任务执行CRON表达式 query true string
jobDesc 任务执行描述 query true string
jobGroup 执行器ID query true integer(int32)
triggerStatus 调度状态：0-停止，1-运行 query true integer(int32)
addTime 创建时间 query false string(date-time)
alarmEmail 报警邮件 query false string
childJobId 子任务ID，多个逗号分隔 query false string
executorFailRetryCount 失败重试次数，默认：0 query false integer(int32)
executorParam 执行器，任务参数，默认json格式 query false string
executorTimeout 任务执行超时时间，单位秒，默认：0 query false integer(int32)
glueRemark GLUE备注 query false string
glueSource GLUE源代码 query false string
glueUpdatetime GLUE更新时间 query false string(date-time)
id 任务ID query false integer(int32)
triggerLastTime 上次调度时间 query false integer(int64)
triggerNextTime 下次调度时间 query false integer(int64)
updateTime 更新时间 query false string(date-time)

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}

3.3. 查询

接口地址:/smartcmty-job-admin/jobinfo/get

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
任务ID id body false integer

响应状态:

状态码 说明 schema
200 OK ReturnT«XxlJobInfo对象»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content XxlJobInfo对象 XxlJobInfo对象
addTime 创建时间 string(date-time)
alarmEmail 报警邮件 string
author 负责人 string
childJobId 子任务ID，多个逗号分隔 string
executorBlockStrategy 阻塞处理策略，默认：SERIAL_EXECUTION string
executorFailRetryCount 失败重试次数，默认：0 integer(int32)
executorHandler 执行器，任务Handler名称，默认：RestTaskJobHandler string
executorParam 执行器，任务参数，默认json格式 string
executorRouteStrategy 执行器路由策略，默认：FIRST string
executorTimeout 任务执行超时时间，单位秒，默认：0 integer(int32)
glueRemark GLUE备注 string
glueSource GLUE源代码 string
glueType GLUE类型，默认BEAN string
glueUpdatetime GLUE更新时间 string(date-time)
id 任务ID integer(int32)
jobCron 任务执行CRON表达式 string
jobDesc 任务执行描述 string
jobGroup 执行器ID integer(int32)
triggerLastTime 上次调度时间 integer(int64)
triggerNextTime 下次调度时间 integer(int64)
triggerStatus 调度状态：0-停止，1-运行 integer(int32)
updateTime 更新时间 string(date-time)
msg string

响应示例:

{
    "code": 0,
    "content": {
        "addTime": "",
        "alarmEmail": "",
        "author": "system",
        "childJobId": "",
        "executorBlockStrategy": "SERIAL_EXECUTION",
        "executorFailRetryCount": 0,
        "executorHandler": "RestTaskJobHandler",
        "executorParam": "",
        "executorRouteStrategy": "FIRST",
        "executorTimeout": 0,
        "glueRemark": "",
        "glueSource": "",
        "glueType": "BEAN",
        "glueUpdatetime": "",
        "id": 0,
        "jobCron": "0 0/30 * * * ?",
        "jobDesc": "定时任务01",
        "jobGroup": 2,
        "triggerLastTime": 0,
        "triggerNextTime": 0,
        "triggerStatus": 1,
        "updateTime": ""
    },
    "msg": ""
}

3.4. 触发下一次

接口地址:/smartcmty-job-admin/jobinfo/nextTriggerTime

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
cron cron query false string

响应状态:

状态码 说明 schema
200 OK ReturnT«List«string»»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content array
msg string

响应示例:

{
    "code": 0,
    "content": [],
    "msg": ""
}

3.5. 分页查询

接口地址:/smartcmty-job-admin/jobinfo/pageList

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
author author query false string
executorHandler executorHandler query false string
jobDesc jobDesc query false string
jobGroup jobGroup query false integer(int32)
length length query false integer(int32)
start start query false integer(int32)
triggerStatus triggerStatus query false integer(int32)

响应状态:

状态码 说明 schema
200 OK
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

暂无

响应示例:

3.6. 删除

接口地址:/smartcmty-job-admin/jobinfo/remove

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
任务ID id body false integer

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}

3.7. 开始

接口地址:/smartcmty-job-admin/jobinfo/start

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
任务ID id body false integer

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}

3.8. 停止

接口地址:/smartcmty-job-admin/jobinfo/stop

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
任务ID id body false integer

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}

3.9. 触发

接口地址:/smartcmty-job-admin/jobinfo/trigger

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
任务ID id query true integer(int32)
任务参数 executorParam body false string
远程地址 addressList body false string

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}

3.10. 更新

接口地址:/smartcmty-job-admin/jobinfo/update

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
author 负责人 query true string
executorBlockStrategy 阻塞处理策略，默认：SERIAL_EXECUTION query true string
executorHandler 执行器，任务Handler名称，默认：RestTaskJobHandler query true string
executorRouteStrategy 执行器路由策略，默认：FIRST query true string
glueType GLUE类型，默认BEAN query true string
jobCron 任务执行CRON表达式 query true string
jobDesc 任务执行描述 query true string
jobGroup 执行器ID query true integer(int32)
triggerStatus 调度状态：0-停止，1-运行 query true integer(int32)
addTime 创建时间 query false string(date-time)
alarmEmail 报警邮件 query false string
childJobId 子任务ID，多个逗号分隔 query false string
executorFailRetryCount 失败重试次数，默认：0 query false integer(int32)
executorParam 执行器，任务参数，默认json格式 query false string
executorTimeout 任务执行超时时间，单位秒，默认：0 query false integer(int32)
glueRemark GLUE备注 query false string
glueSource GLUE源代码 query false string
glueUpdatetime GLUE更新时间 query false string(date-time)
id 任务ID query false integer(int32)
triggerLastTime 上次调度时间 query false integer(int64)
triggerNextTime 下次调度时间 query false integer(int64)
updateTime 更新时间 query false string(date-time)

响应状态:

状态码 说明 schema
200 OK ReturnT«string»
201 Created
401 Unauthorized
403 Forbidden
404 Not Found

响应参数:

参数名称 参数说明 类型 schema
code integer(int32) integer(int32)
content string
msg string

响应示例:

{
    "code": 0,
    "content": "",
    "msg": ""
}
Copyright © www.remacsmart.com/ 2021 all right reserved，powered by Gitbook该文件修订时间： 2022-02-12 10:19:17

results matching ""

    No results matching ""