Throttle an update by query operation
- POST /_update_by_query/{task_id}/_rethrottle
Change the number of requests per second for a particular update 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.
Path Parameters
-
task_idstring Idrequired -
The ID for the task.
Query Parameters
-
requests_per_secondnumberrequired The maximum number of documents to update per second, across the entire update_by_query operation (including slices). It can be either
-1to turn off throttling or any decimal number like1.7or12to throttle to that level.
Response
-
nodesmap string to UpdateByQueryRethrottleNoderequired -
<string>UpdateByQueryRethrottleNode -
attributesmap string to stringrequired -
hoststringrequired -
ipstringrequired -
namestring Namerequired -
rolesNodeRoles -
Values:
masterdatadata_colddata_contentdata_frozendata_hotdata_warmclientingestmlvoting_onlytransformremote_cluster_clientcoordinating_only -
transport_addressstringrequired -
tasksmap string to TaskInforequired -
<string>TaskInfo -
actionstringrequired -
cancelledboolean -
cancellablebooleanrequired -
descriptionstring -
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
_reindexwhich has the source and the destination, or_bulkwhich 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. -
headersmap string to stringrequired -
idnumberrequired -
nodestringrequired -
running_timestring Duration -
running_time_in_nanosDurationValueUnitNanosrequired -
start_time_in_millisEpochTimeUnitMillisrequired -
statusobject -
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.
-
typestringrequired -
parent_task_idstring TaskId -
original_task_idstring TaskId -
The task ID of the original task. Only present when the task is continuing the work of an earlier task that was running on a node which has since shut down (i.e. a relocatable task). For tasks that have not been relocated this is always equal to the task's own ID and is omitted from the response.
-
original_start_time_in_millisEpochTimeUnitMillis -
The time at which the original task started, in milliseconds since the Unix epoch. Only present together with
original_task_id. -
original_start_timestring -
The time at which the original task started, as an ISO 8601 formatted string. Only present together with
original_task_idand when the request includes the?human=truequery parameter.