WARNING: Version 5.6 of Elasticsearch has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
The close job API enables you to close a job. A job can be opened and closed multiple times throughout its lifecycle.
A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.
When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open.
After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.
When a datafeed that has a specified end date stops, it automatically closes the job.
If you use the
force query parameter, the request returns without performing
the associated actions such as flushing buffers and persisting the model snapshots.
Therefore, do not use this parameter if you want the job to be in a consistent state
after the close job API returns. The
force query parameter should only be used in
situations where the job has already failed, or where you are not interested in
results the job might have recently produced or might produce in the future.
- (boolean) Use to close a failed job, or to forcefully close a job which has not responded to its initial close request.
- (time units) Controls the time to wait until a job has closed. The default value is 30 minutes.
You must have
manage cluster privileges to use this API.
For more information, see Security Privileges.