Throttle a reindex operation

Auth

Change the number of requests per second for a particular reindex operation. For example:

POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1

Rethrottling that speeds up the query takes effect immediately. Rethrottling that slows down the query will take effect after completing the current batch. This behavior prevents scroll timeouts.

Path parameters

task_id string required

The task identifier, which can be found by using the tasks API.

Query parameters

requests_per_second number required

The throttle for this request in sub-requests per second. It can be either -1 to turn off throttling or any decimal number like 1.7 or 12 to throttle to that level.

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
cancellable boolean required
description string required
id number required
node string required
running_time_in_nanos number required
start_time_in_millis number required
status object required
batches number required

The number of scroll responses pulled back by the reindex.

created number required

The number of documents that were successfully created.

deleted number required

The number of documents that were successfully deleted.

noops number required

The number of documents that were ignored because the script used for the reindex returned a noop value for ctx.op.

requests_per_second number required

The number of requests per second effectively executed during the reindex.

retries object required

The number of retries attempted by reindex. bulk is the number of bulk actions retried and search is the number of search actions retried.

bulk number required

The number of bulk actions retried.

The number of search actions retried.

throttled string
throttled_millis number required

Number of milliseconds the request slept to conform to requests_per_second.

throttled_until string
throttled_until_millis number required

This field should always be equal to zero in a _reindex response. It only has meaning when using the Task API, where it indicates the next time (in milliseconds since epoch) a throttled request will be executed again in order to conform to requests_per_second.

total number required

The number of documents that were successfully processed.

updated number required

The number of documents that were successfully updated, for example, a document with same ID already existed prior to reindex updating it.

version_conflicts number required

The number of version conflicts that reindex hits.

type string required
headers object required