此版本仍在开发中,尚未被视为稳定版本。对于最新的稳定版本,请使用 Spring Boot 3.4.0! |
Quartz (quartz
)
终端节点提供有关由 Quartz Scheduler 管理的作业和触发器的信息。quartz
检索已注册的组
作业和触发器按组进行管理。
要检索已注册作业组和触发器组的列表,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz
$ curl 'http://localhost:8080/actuator/quartz' -i -X GET
生成的响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 120
{
"jobs" : {
"groups" : [ "samples", "tests" ]
},
"triggers" : {
"groups" : [ "samples", "DEFAULT" ]
}
}
检索已注册的作业名称
要检索已注册作业名称的列表,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz/jobs
$ curl 'http://localhost:8080/actuator/quartz/jobs' -i -X GET
生成的响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 137
{
"groups" : {
"samples" : {
"jobs" : [ "jobOne", "jobTwo" ]
},
"tests" : {
"jobs" : [ "jobThree" ]
}
}
}
检索已注册的触发器名称
要检索已注册触发器名称的列表,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz/triggers
$ curl 'http://localhost:8080/actuator/quartz/triggers' -i -X GET
生成的响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 229
{
"groups" : {
"samples" : {
"paused" : false,
"triggers" : [ "3am-weekdays", "every-day", "once-a-week" ]
},
"DEFAULT" : {
"paused" : false,
"triggers" : [ "every-hour-tue-thu" ]
}
}
}
检索任务组概述
要检索特定组中作业的概述,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz/jobs/{groupName}
$ curl 'http://localhost:8080/actuator/quartz/jobs/samples' -i -X GET
前面的示例检索组中作业的摘要。
生成的响应类似于以下内容:samples
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 201
{
"group" : "samples",
"jobs" : {
"jobOne" : {
"className" : "org.springframework.scheduling.quartz.DelegatingJob"
},
"jobTwo" : {
"className" : "org.quartz.Job"
}
}
}
检索触发器组概述
要检索特定组中触发器的概述,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz/triggers/{groupName}
$ curl 'http://localhost:8080/actuator/quartz/triggers/tests' -i -X GET
前面的示例检索组中触发器的摘要。
生成的响应类似于以下内容:tests
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 1268
{
"group" : "tests",
"paused" : false,
"triggers" : {
"cron" : {
"3am-week" : {
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 3,
"expression" : "0 0 3 ? * 1,2,3,4,5",
"timeZone" : "Europe/Paris"
}
},
"simple" : {
"every-day" : {
"nextFireTime" : "2020-12-04T12:00:00.000+00:00",
"priority" : 7,
"interval" : 86400000
}
},
"dailyTimeInterval" : {
"tue-thu" : {
"priority" : 5,
"interval" : 3600000,
"daysOfWeek" : [ 3, 5 ],
"startTimeOfDay" : "09:00:00",
"endTimeOfDay" : "18:00:00"
}
},
"calendarInterval" : {
"once-a-week" : {
"previousFireTime" : "2020-12-02T14:00:00.000+00:00",
"nextFireTime" : "2020-12-08T14:00:00.000+00:00",
"priority" : 5,
"interval" : 604800000,
"timeZone" : "Etc/UTC"
}
},
"custom" : {
"once-a-year-custom" : {
"previousFireTime" : "2020-07-14T16:00:00.000+00:00",
"nextFireTime" : "2021-07-14T16:00:00.000+00:00",
"priority" : 10,
"trigger" : "com.example.CustomTrigger@fdsfsd"
}
}
}
}
响应结构
响应包含特定组中触发器的概述。 提供了触发器实现特定的详细信息。 下表描述了响应的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
组的名称。 |
|
|
组是否暂停。 |
|
|
按名称键控的 Cron 触发器(如果有)。 |
|
|
按名称键控的简单触发器(如果有)。 |
|
|
按名称键控的每日时间间隔触发器(如果有)。 |
|
|
按名称键控的日历间隔触发器(如果有)。 |
|
|
按 name 键控的任何其他触发器(如果有)。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
|
|
Cron 表达式。 |
|
|
将解析表达式的时区(如果有)。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
|
|
两次执行之间的间隔(以毫秒为单位)。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
|
|
间隔(以毫秒为单位),添加到触发时间中,以计算下一次触发器重复的时间。 |
|
|
一周中要触发的天数数组。 |
|
|
以给定的时间间隔(如果有)开始触发的时间。 |
|
|
在给定间隔 (如果有) 完成触发的时间。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
|
|
间隔(以毫秒为单位),添加到触发时间中,以计算下一次触发器重复的时间。 |
|
|
执行时间计算的时区(如果有)。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
|
|
自定义触发器实例的 toString 表示形式。 |
检索作业的详细信息
要检索有关特定作业的详细信息,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz/jobs/{groupName}/{jobName}
$ curl 'http://localhost:8080/actuator/quartz/jobs/samples/jobOne' -i -X GET
前面的示例检索由 group 和 name 标识的任务的详细信息。
生成的响应类似于以下内容:samples
jobOne
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 609
{
"group" : "samples",
"name" : "jobOne",
"description" : "A sample job",
"className" : "org.springframework.scheduling.quartz.DelegatingJob",
"durable" : false,
"requestRecovery" : false,
"data" : {
"password" : "secret",
"user" : "admin"
},
"triggers" : [ {
"group" : "samples",
"name" : "every-day",
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-04T12:00:00.000+00:00",
"priority" : 7
}, {
"group" : "samples",
"name" : "3am-weekdays",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 3
} ]
}
如果数据映射中的键被标识为敏感键,则其值将被清理。
响应结构
响应包含作业的完整详细信息,包括与其关联的触发器的摘要(如果有)。 触发器按下一次触发时间和优先级排序。 下表描述了响应的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
组的名称。 |
|
|
作业的名称。 |
|
|
作业说明(如果有)。 |
|
|
作业实现的完全限定名称。 |
|
|
作业在成为孤立作业后是否应保持存储状态。 |
|
|
如果遇到 “recovery” 或 “fail-over” 情况,是否应重新执行作业。 |
|
|
作业数据映射为键/值对(如果有)。 |
|
|
与作业关联的触发器数组(如果有)。 |
|
|
触发器组的名称。 |
|
|
触发器的名称。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
检索触发器的详细信息
要检索有关特定触发器的详细信息,请向 发出请求,如以下基于 curl 的示例所示:GET
/actuator/quartz/triggers/{groupName}/{triggerName}
$ curl 'http://localhost:8080/actuator/quartz/triggers/samples/example' -i -X GET
前面的示例检索由 group 和 name 标识的 trigger 的详细信息。samples
example
通用响应结构
响应具有通用结构和特定于触发器类型的附加对象。 有五种受支持的类型:
-
cron
为CronTrigger
-
simple
为SimpleTrigger
-
dailyTimeInterval
为DailyTimeIntervalTrigger
-
calendarInterval
为CalendarIntervalTrigger
-
custom
对于任何其他 trigger 实现
下表描述了响应的常见元素的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
组的名称。 |
|
|
触发器的名称。 |
|
|
触发器的描述(如果有)。 |
|
|
触发器的状态 (, , , , , )。 |
|
|
触发器的类型 (、 、 )。确定包含特定于类型的详细信息的对象的键。 |
|
|
与此 Trigger 关联的 Calendar 的名称(如果有)。 |
|
|
Trigger 应生效的时间(如果有)。 |
|
|
Trigger 应停止重复的时间,无论是否有任何剩余的重复(如果有)。 |
|
|
上次触发触发器的时间(如果有)。 |
|
|
下次计划触发 Trigger 的时间(如果有)。 |
|
|
如果两个触发器具有相同的计划触发时间,则使用的优先级。 |
|
|
Trigger 的上次触发时间(如果有)。 |
|
|
按名称键控的作业数据映射(如果有)。 |
|
|
日历时间间隔触发器详细信息(如果有)。当 为 时出现。 |
|
|
自定义触发器详细信息(如果有)。当 为 时出现。 |
|
|
Cron 触发器详细信息(如果有)。当 为 时出现。 |
|
|
每日时间间隔触发器详细信息(如果有)。当 为 时出现。 |
|
|
简单的触发器详细信息(如果有)。当 为 时出现。 |
Cron 触发器响应结构
cron 触发器定义用于确定何时必须触发的 cron 表达式。 此类触发器实现的结果响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 490
{
"group" : "samples",
"name" : "example",
"description" : "Example trigger",
"state" : "NORMAL",
"type" : "cron",
"calendarName" : "bankHolidays",
"startTime" : "2020-11-30T17:00:00.000+00:00",
"endTime" : "2020-12-30T03:00:00.000+00:00",
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 3,
"data" : { },
"cron" : {
"expression" : "0 0 3 ? * 1,2,3,4,5",
"timeZone" : "Europe/Paris"
}
}
大部分响应对于所有触发器类型都是通用的。 响应的常见元素的结构已在前面描述。 下表描述了特定于 cron 触发器的响应部分的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
Cron 触发器特定的详细信息。 |
|
|
Cron 表达式。 |
|
|
将解析表达式的时区(如果有)。 |
简单的触发响应结构
简单触发器用于在给定时刻触发 Job,并可选择按指定的时间间隔重复。 此类触发器实现的结果响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 549
{
"group" : "samples",
"name" : "example",
"description" : "Example trigger",
"state" : "NORMAL",
"type" : "simple",
"calendarName" : "bankHolidays",
"startTime" : "2020-11-30T17:00:00.000+00:00",
"endTime" : "2020-12-30T03:00:00.000+00:00",
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 7,
"finalFireTime" : "2020-12-29T17:00:00.000+00:00",
"data" : { },
"simple" : {
"interval" : 86400000,
"repeatCount" : -1,
"timesTriggered" : 0
}
}
大部分响应对于所有触发器类型都是通用的。 响应的常见元素的结构已在前面描述。 下表描述了特定于简单触发器的响应部分的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
简单的触发器特定细节。 |
|
|
两次执行之间的间隔(以毫秒为单位)。 |
|
|
触发器应重复的次数,或 -1 表示无限期重复。 |
|
|
触发器已触发的次数。 |
每日时间间隔触发器响应结构
每日时间间隔触发器用于根据每日重复的时间间隔触发 Job。 此类触发器实现的结果响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 667
{
"group" : "samples",
"name" : "example",
"description" : "Example trigger",
"state" : "PAUSED",
"type" : "dailyTimeInterval",
"calendarName" : "bankHolidays",
"startTime" : "2020-11-30T17:00:00.000+00:00",
"endTime" : "2020-12-30T03:00:00.000+00:00",
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 5,
"finalFireTime" : "2020-12-30T18:00:00.000+00:00",
"data" : { },
"dailyTimeInterval" : {
"interval" : 3600000,
"daysOfWeek" : [ 3, 5 ],
"startTimeOfDay" : "09:00:00",
"endTimeOfDay" : "18:00:00",
"repeatCount" : -1,
"timesTriggered" : 0
}
}
大部分响应对于所有触发器类型都是通用的。 响应的常见元素的结构已在前面描述。 下表描述了特定于每日时间间隔触发器的响应部分的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
每日时间间隔会触发特定详细信息。 |
|
|
间隔(以毫秒为单位),添加到触发时间中,以计算下一次触发器重复的时间。 |
|
|
一周中要触发的天数数组。 |
|
|
以给定的时间间隔(如果有)开始触发的时间。 |
|
|
在给定间隔 (如果有) 完成触发的时间。 |
|
|
触发器应重复的次数,或 -1 表示无限期重复。 |
|
|
触发器已触发的次数。 |
日历间隔触发器响应结构
日历间隔触发器用于根据重复的日历时间间隔触发 Job。 此类触发器实现的结果响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 669
{
"group" : "samples",
"name" : "example",
"description" : "Example trigger",
"state" : "NORMAL",
"type" : "calendarInterval",
"calendarName" : "bankHolidays",
"startTime" : "2020-11-30T17:00:00.000+00:00",
"endTime" : "2020-12-30T03:00:00.000+00:00",
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 5,
"finalFireTime" : "2020-12-28T17:00:00.000+00:00",
"data" : { },
"calendarInterval" : {
"interval" : 604800000,
"timeZone" : "Etc/UTC",
"timesTriggered" : 0,
"preserveHourOfDayAcrossDaylightSavings" : false,
"skipDayIfHourDoesNotExist" : false
}
}
大部分响应对于所有触发器类型都是通用的。 响应的常见元素的结构已在前面描述。 下表描述了特定于日历间隔触发器的响应部分的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
日历间隔会触发特定详细信息。 |
|
|
间隔(以毫秒为单位),添加到触发时间中,以计算下一次触发器重复的时间。 |
|
|
执行时间计算的时区(如果有)。 |
|
|
触发器已触发的次数。 |
|
|
是否在一天中的同一时间触发触发器,而不管夏令时转换如何。 |
|
|
如果给定日期不存在一天中的小时,是否跳过。 |
自定义触发器响应结构
自定义触发器是任何其他实现。 此类触发器实现的结果响应类似于以下内容:
HTTP/1.1 200 OK
Content-Type: application/vnd.spring-boot.actuator.v3+json
Content-Length: 457
{
"group" : "samples",
"name" : "example",
"description" : "Example trigger.",
"state" : "NORMAL",
"type" : "custom",
"calendarName" : "bankHolidays",
"startTime" : "2020-11-30T17:00:00.000+00:00",
"endTime" : "2020-12-30T03:00:00.000+00:00",
"previousFireTime" : "2020-12-04T03:00:00.000+00:00",
"nextFireTime" : "2020-12-07T03:00:00.000+00:00",
"priority" : 10,
"custom" : {
"trigger" : "com.example.CustomTrigger@fdsfsd"
}
}
大部分响应对于所有触发器类型都是通用的。 响应的常见元素的结构已在前面描述。 下表描述了特定于自定义触发器的响应部分的结构:
路径 | 类型 | 描述 |
---|---|---|
|
|
自定义触发器特定的详细信息。 |
|
|
自定义触发器实例的 toString 表示形式。 |