|
对于最新稳定版本，请使用Spring Boot 4.0.0！ |
Quartz（Quartz)
这Quartz端点提供由Quartz调度器管理的作业和触发器的信息。
检索注册组
作业和触发点是分组管理的。
要检索注册作业组和触发组的列表，请设置获取请求/执行器/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" ]
}
}检索注册职位名称
要获取已注册的职位名称列表，请创建获取请求/执行器/Quartz/作业如以下基于卷度的示例所示：
$ 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" ]
}
}
}检索注册触发名称
要获取已注册触发名称的列表，请设置获取请求/执行器/Quartz/触发器如以下基于卷度的示例所示：
$ 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" ]
}
}
}检索工作组概览
要获取特定组中作业的概览，请创建获取请求/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"
}
}
}检索触发组概述
要获取特定组中触发条件的概览，请创建获取请求/actuator/quartz/triggers/{groupName}如以下基于卷度的示例所示：
$ curl 'http://localhost:8080/actuator/quartz/triggers/tests' -i -X GET前例检索了测试群。
最终的响应类似于以下内容：
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触发器。 |
|
|
如果有，按名字标记的简单触发器。 |
|
|
每日时间间隔触发器按名称键入。 |
|
|
按名称键入的日历间隔触发器（如果有的话）。 |
|
|
还有其他用名字标记的触发器吗？ |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
|
|
用克隆表达式。 |
|
|
表达式将被解析的时区（如果有的话）。 |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
|
|
两次执行之间的毫秒间隔。 |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
|
|
以毫秒为单位的间隔，将间隔加到射击时间上，以计算下一次触发重复的时间。 |
|
|
一周中多天的射击时间。 |
|
|
在规定的间隔（如果有的话）开始射击的时间。 |
|
|
在规定的间隔内完成射击的时间（如果有的话）。 |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
|
|
以毫秒为单位的间隔，将间隔加到射击时间上，以计算下一次触发重复的时间。 |
|
|
时间计算将在该区域内进行（如果有的话）。 |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
|
|
自定义触发实例的toString表示。 |
获取工作详情
要获取特定工作的详细信息，请创建获取请求/actuator/quartz/jobs/{groupName}/{jobName}如以下基于卷度的示例所示：
$ curl 'http://localhost:8080/actuator/quartz/jobs/samples/jobOne' -i -X GET前述示例检索了通过
Samples群和工作一号名字。
最终的响应类似于以下内容：
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
} ]
}如果数据映射中的某个键被识别为敏感，其值会被净化。
响应结构
响应包含任务的完整细节，包括与之相关的触发因素（如有）的摘要。 触发器按下一次开火时间和优先级排序。 下表描述了该反应的结构：
| 路径 | 类型 | 描述 |
|---|---|---|
|
|
团体名称。 |
|
|
工作名称。 |
|
|
如果有工作的描述，请提供。 |
|
|
完全合格的职位名称。 |
|
|
该职位在被孤立后是否应继续存储。 |
|
|
如果遇到“恢复”或“故障切换”情况，是否应重新执行该作业。 |
|
|
如果有，作业数据映射为键值对。 |
|
|
与作业相关的触发器数组（如果有的话）。 |
|
|
触发小组名称。 |
|
|
触发器名称。 |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
检索触发器详情
要获取特定触发器的详细信息，请设置获取请求/actuator/quartz/triggers/{groupName}/{triggerName}如以下基于卷度的示例所示：
$ curl 'http://localhost:8080/actuator/quartz/triggers/samples/example' -i -X GET前例检索了通过
Samples群和示例名字。
共同反应结构
该响应具有共同结构和一个针对触发类型的特定对象。 支持的类型有五种：
-
克朗为克隆触发器 -
简单为简单触发器 -
每日时间间隔为DailyTimeIntervalTrigger -
日历间隔为日历间隔触发器 -
习惯对于其他任何触发实现
下表描述了反应中共同元素的结构：
| 路径 | 类型 | 描述 |
|---|---|---|
|
|
团体名称。 |
|
|
触发器名称。 |
|
|
如果有触发点的描述。 |
|
|
触发状态（ |
|
|
触发器类型（ |
|
|
如果有，该触发器关联的日历名称。 |
|
|
触发器应生效的时间（如果有的话）。 |
|
|
触发器应停止重复的时间，无论是否还有重复。 |
|
|
上次触发时，如果有的话。 |
|
|
如果有触发器计划触发，那就是下一次。 |
|
|
如果两个触发器排定的发射时间相同，优先使用。 |
|
|
如果有触发器会触发的最后一次。 |
|
|
职位数据地图按姓名键入，如果有的话。 |
|
|
日历时间区间触发细节（如果有的话）。出现时间 |
|
|
如果有的话，提供自定义触发细节。出现时间 |
|
|
如果有触发点的详细信息，请告诉我。出现时间 |
|
|
每日时间间隔触发细节（如有）。出现时间 |
|
|
如果有的话，只需简单的触发细节。出现时间 |
克隆触发反应结构
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触发具体细节。 |
|
|
用克隆表达式。 |
|
|
表达式将被解析的时区（如果有的话）。 |
简单触发反应结构
只需在特定时刻触发一个简单的触发器，并可选择在指定间隔重复执行。 这种触发实现的结果响应类似于以下内容：
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以无限重复。 |
|
|
扳机已经触发的次数。 |
每日时间区间触发反应结构
基于每日重复的时间间隔，用于触发作业。 这种触发实现的结果响应类似于以下内容：
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以无限重复。 |
|
|
扳机已经触发的次数。 |
日历区间触发反应结构
日历间隔触发器用于基于重复的日历时间间隔触发作业。 这种触发实现的结果响应类似于以下内容：
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表示。 |