Throttle a delete by query operation
Added in 6.5.0
Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
Query parameters
-
The throttle for this request in sub-requests per second. To disable throttling, set it to
-1
.
Responses
-
Hide response attributes Show response attributes object
-
Hide node_failures attributes Show node_failures attributes object
-
Hide task_failures attributes Show task_failures attributes object
-
Task information grouped by node, if
group_by
was set tonode
(the default).Hide nodes attribute Show nodes attribute object
-
Hide * attributes Show * attributes object
-
Hide tasks attribute Show tasks attribute object
-
Hide * attributes Show * attributes object
-
Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like
_reindex
which has the source and the destination, or_bulk
which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
Time unit for nanoseconds
-
Time unit for milliseconds
-
The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.
-
-
tasks
array[object] | object One of: Hide attributes Show attributes object
-
Human readable text that identifies the particular request that the task is performing. For example, it might identify the search request being performed by a search task. Other kinds of tasks have different descriptions, like
_reindex
which has the source and the destination, or_bulk
which just has the number of requests and the destination indices. Many requests will have only an empty description because more detailed information about the request is not easily available or particularly helpful in identifying the request. -
A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
Time unit for nanoseconds
-
Time unit for milliseconds
-
The internal status of the task, which varies from task to task. The format also varies. While the goal is to keep the status for a particular task consistent from version to version, this is not always possible because sometimes the implementation changes. Fields might be removed from the status for a particular request so any parsing you do of the status might break in minor releases.
-
curl \
--request POST 'http://api.example.com/_delete_by_query/{task_id}/_rethrottle' \
--header "Authorization: $API_KEY"