Stop rollup jobs
- POST /_rollup/job/{id}/_stop
If you try to stop a job that does not exist, an exception occurs. If you try to stop a job that is already stopped, nothing happens.
Since only a stopped job can be deleted, it can be useful to block the API until the indexer has fully stopped.
This is accomplished with the wait_for_completion query parameter, and optionally a timeout. For example:
POST _rollup/job/sensor/_stop?wait_for_completion=true&timeout=10s
The parameter blocks the API call from returning until either the job has moved to STOPPED or the specified time has elapsed. If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.
- Cluster privileges:
manage_rollup
Path Parameters
-
idstring Idrequired -
Identifier for the rollup job.
Query Parameters
-
timeoutstring Duration · default: 30s If
wait_for_completionistrue, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more thantimeouttime has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change.-
wait_for_completionboolean · default: false If set to
true, causes the API to block until the indexer state completely stops. If set tofalse, the API returns immediately and the indexer is stopped asynchronously in the background.