Get rollup job information
- GET /_rollup/job/{id}
- GET /_rollup/job
Get the configuration, stats, and status of rollup jobs.
This API returns only active (both STARTED and STOPPED) jobs.
If a job was created, ran for a while, then was deleted, the API does not return any details about it.
For details about a historical rollup job, the rollup capabilities API may be more useful.
Required authorization
- Cluster privileges monitor_rollup
Response
-
jobsobjectrequired -
configobjectrequired -
The rollup job configuration.
-
groupsobjectrequired -
date_histogramobject -
A date histogram group aggregates a date field into time-based buckets. This group is mandatory; you currently cannot roll up documents without a timestamp and a
date_histogramgroup. -
delaystring -
How long to wait before rolling up new documents. By default, the indexer attempts to roll up all data that is available. However, it is not uncommon for data to arrive out of order. The indexer is unable to deal with data that arrives after a time-span has been rolled up. You need to specify a delay that matches the longest period of time you expect out-of-order data to arrive.
-
histogramobject -
The histogram group aggregates one or more numeric fields into numeric histogram intervals.
-
fieldsstringrequired -
The set of fields that you wish to build histograms for. All fields specified must be some kind of numeric. Order does not matter.
-
intervalnumberrequired -
The interval of histogram buckets to be generated when rolling up. For example, a value of
5creates buckets that are five units wide (0-5,5-10, etc). Note that only one interval can be specified in the histogram group, meaning that all fields being grouped via the histogram must share the same interval. -
termsobject -
The terms group can be used on keyword or numeric fields to allow bucketing via the terms aggregation at a later point. The indexer enumerates and stores all values of a field for each time-period. This can be potentially costly for high-cardinality groups such as IP addresses, especially if the time-bucket is particularly sparse.