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 throttle for this request in sub-requests per second. To turn off throttling, set it to
-1.
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_idnumber | string TaskId