Throttle an update by query operation

  • POST /_update_by_query/{task_id}/_rethrottle
Auth

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_id string required

The ID for the task.

Query parameters

requests_per_second number required

The throttle for this request in sub-requests per second. To turn off throttling, set it to -1.

Response

application/json
nodes map string to object required
<string> object
attributes map string to string required
host string required
ip string required
name string required
roles enum[]
Values: master data data_cold data_content data_frozen data_hot data_warm client ingest ml voting_only transform remote_cluster_client coordinating_only
transport_address string required
tasks map string to object required
<string> object
action string required
cancelled boolean
cancellable boolean required
description string

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.

headers map string to string required
id number required
node string required
running_time string
running_time_in_nanos number required
start_time_in_millis number required
status object

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.

type string required
parent_task_id number | string