- Elasticsearch Guide: other versions:
- Elasticsearch basics
- Quick starts
- Set up Elasticsearch
- Run Elasticsearch locally
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Data stream lifecycle settings
- Field data cache settings
- Local gateway settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- Inference settings
- License settings
- Machine learning settings
- Monitoring settings
- Node settings
- Networking
- Node query cache settings
- Path settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Set JVM options
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Search your data
- The search API
- Sort search results
- Paginate search results
- Retrieve selected fields
- Search multiple data streams and indices using a query
- Collapse search results
- Filter search results
- Highlighting
- Long-running searches
- Near real-time search
- Retrieve inner hits
- Search shard routing
- Searching with query rules
- Search templates
- Full-text search
- Search relevance optimizations
- Retrievers
- kNN search
- Semantic search
- Retrieval augmented generation
- Search across clusters
- Search with synonyms
- Search Applications
- Search analytics
- The search API
- Re-ranking
- Index modules
- Index templates
- Aliases
- Mapping
- Dynamic mapping
- Explicit mapping
- Runtime fields
- Field data types
- Aggregate metric
- Alias
- Arrays
- Binary
- Boolean
- Completion
- Date
- Date nanoseconds
- Dense vector
- Flattened
- Geopoint
- Geoshape
- Histogram
- IP
- Join
- Keyword
- Nested
- Numeric
- Object
- Pass-through object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Rank Vectors
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
analyzer
coerce
copy_to
doc_values
dynamic
eager_global_ordinals
enabled
format
ignore_above
index.mapping.ignore_above
ignore_malformed
index
index_options
index_phrases
index_prefixes
meta
fields
normalizer
norms
null_value
position_increment_gap
properties
search_analyzer
similarity
store
subobjects
term_vector
- Mapping limit settings
- Removal of mapping types
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- IP Location
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Terminate
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Connectors
- Data streams
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Roll up or transform your data
- Query DSL
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- Watcher
- Monitor a cluster
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Set up a cluster for high availability
- Optimizations
- Autoscaling
- Snapshot and restore
- Cross-cluster replication
- Data store architecture
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Connector APIs
- Create connector
- Delete connector
- Get connector
- List connectors
- Update connector API key id
- Update connector configuration
- Update connector index name
- Update connector features
- Update connector filtering
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Create connector sync job
- Cancel connector sync job
- Delete connector sync job
- Get connector sync job
- List connector sync jobs
- Check in a connector
- Update connector error
- Update connector last sync stats
- Update connector status
- Check in connector sync job
- Claim connector sync job
- Set connector sync job error
- Set connector sync job stats
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL APIs
- Features APIs
- Fleet APIs
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Resolve cluster
- Advantages of using this endpoint before a cross-cluster search
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Delete inference API
- Get inference API
- Perform inference API
- Chat completion inference API
- Create inference API
- Stream inference API
- Update inference API
- Elastic Inference Service (EIS)
- AlibabaCloud AI Search inference integration
- Amazon Bedrock inference integration
- Anthropic inference integration
- Azure AI studio inference integration
- Azure OpenAI inference integration
- Cohere inference integration
- Elasticsearch inference integration
- ELSER inference integration
- Google AI Studio inference integration
- Google Vertex AI inference integration
- HuggingFace inference integration
- JinaAI inference integration
- Mistral inference integration
- OpenAI inference integration
- Watsonx inference integration
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Root API
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Bulk create or update roles API
- Bulk delete roles API
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Query Role
- Get service accounts
- Get service account credentials
- Get Security settings
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Query User
- Update API key
- Update Security settings
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Text structure APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Troubleshooting broken repositories
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- Troubleshooting an unbalanced cluster
- Capture diagnostics
- Upgrade Elasticsearch
- Migration guide
- Release notes
- Dependencies and versions
Reindex data stream API
editReindex data stream API
editThese APIs are designed for indirect use by Kibana’s Upgrade Assistant. We strongly recommend you use the Upgrade Assistant to upgrade from 8.18 to 9.0.0-beta1. For upgrade instructions, refer to Upgrading to Elastic 9.0.0-beta1.
The reindex data stream API is used to upgrade the backing indices of a data stream to the most recent major version. It works by reindexing each backing index into a new index, then replacing the original backing index with its replacement and deleting the original backing index. The settings and mappings from the original backing indices are copied to the resulting backing indices.
This api runs in the background because reindexing all indices in a large data stream is expected to take a large amount of time and resources. The endpoint will return immediately and a persistent task will be created to run in the background. The current status of the task can be checked with the reindex status API. This status will be available for 24 hours after the task completes, whether it finished successfully or failed. However, only the last status is retained so re-running a reindex will overwrite the previous status for that data stream. A running or recently completed data stream reindex task can be cancelled using the reindex cancel API.
Request
editPOST /_migration/reindex
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage
index privilege for the data stream.
Request body
edit-
source
-
-
index
- (Required, string) The name of the data stream to upgrade.
-
-
mode
-
(Required, enum) Set to
upgrade
to upgrade the data stream in-place, using the same source and destination data stream. Each out-of-date backing index will be reindexed. Then the new backing index is swapped into the data stream and the old index is deleted. Currently, the only allowed value for this parameter isupgrade
.
Settings
editYou can use the following settings to control the behavior of the reindex data stream API:
migrate.max_concurrent_indices_reindexed_per_data_stream
(Dynamic)
The number of backing indices within a given data stream which will be reindexed concurrently. Defaults to 1
.
migrate.data_stream_reindex_max_request_per_second
(Dynamic)
The average maximum number of documents within a given backing index to reindex per second.
Defaults to 1000
, though can be any decimal number greater than 0
.
To remove throttling, set to -1
.
This setting can be used to throttle the reindex process and manage resource usage.
Consult the reindex throttle docs for more information.
Examples
editAssume we have a data stream my-data-stream
with the following backing indices, all of which have index major version 7.x.
- .ds-my-data-stream-2025.01.23-000001
- .ds-my-data-stream-2025.01.23-000002
- .ds-my-data-stream-2025.01.23-000003
Let’s also assume that .ds-my-data-stream-2025.01.23-000003
is the write index.
If Elasticsearch is version 8.x and we wish to upgrade to major version 9.x, the version 7.x indices must be upgraded in preparation.
We can use this API to reindex a data stream with version 7.x backing indices and make them version 8 backing indices.
Start by calling the API:
POST _migration/reindex { "source": { "index": "my-data-stream" }, "mode": "upgrade" }
As this task runs in the background this API will return immediately. The task will do the following.
First, the data stream is rolled over. So that no documents are lost during the reindex, we add write blocks
to the existing backing indices before reindexing them. Since a data stream’s write index cannot have a write block,
the data stream is must be rolled over. This will produce a new write index, .ds-my-data-stream-2025.01.23-000004
; which
has an 8.x version and thus does not need to be upgraded.
Once the data stream has a write index with an 8.x version we can proceed with reindexing the old indices. For each of the version 7.x indices, we now do the following:
- Add a write block to the source index to guarantee that no writes are lost.
- Open the source index if it is closed.
- Delete the destination index if one exists. This is done in case we are retrying after a failure, so that we start with a fresh index.
- Create the destination index using the create from source API. This copies the settings and mappings from the old backing index to the new backing index.
- Use the reindex API to copy the contents of the old backing index to the new backing index.
- Close the destination index if the source index was originally closed.
- Replace the old index in the data stream with the new index, using the modify data streams API.
- Finally, the old backing index is deleted.
By default only one backing index will be processed at a time.
This can be modified using the migrate_max_concurrent_indices_reindexed_per_data_stream-setting
setting.
While the reindex data stream task is running, we can inspect the current status using the reindex status API:
GET /_migration/reindex/my-data-stream/_status
For the above example, the following would be a possible status:
{ "start_time_millis": 1737676174349, "complete": false, "total_indices_in_data_stream": 4, "total_indices_requiring_upgrade": 3, "successes": 0, "in_progress": [ { "index": ".ds-my-data-stream-2025.01.23-000001", "total_doc_count": 10000000, "reindexed_doc_count": 999999 } ], "pending": 2, "errors": [] }
This output means that the first backing index, .ds-my-data-stream-2025.01.23-000001
, is currently being processed,
and none of the backing indices have yet completed. Notice that total_indices_in_data_stream
has a value of 4
,
because after the rollover, there are 4 indices in the data stream. But the new write index has an 8.x version, and
thus doesn’t need to be reindexed, so total_indices_requiring_upgrade
is only 3.
Cancelling and Restarting
editThe reindex datastream settings provide a few ways to control the performance and resource usage of a reindex task. This example shows how we can stop a running reindex task, modify the settings, and restart the task.
Continuing with the above example, assume the reindexing task has not yet completed, and the reindex status API returns the following:
{ "start_time_millis": 1737676174349, "complete": false, "total_indices_in_data_stream": 4, "total_indices_requiring_upgrade": 3, "successes": 1, "in_progress": [ { "index": ".ds-my-data-stream-2025.01.23-000002", "total_doc_count": 10000000, "reindexed_doc_count": 1000 } ], "pending": 1, "errors": [] }
Let’s assume the task has been running for a long time. By default, we throttle how many requests the reindex operation
can execute per second. This keeps the reindex process from consuming too many resources.
But the default value of 1000
request per second will not be correct for all use cases.
The migrate.data_stream_reindex_max_request_per_second
setting
can be used to increase or decrease the number of requests per second, or to remove the throttle entirely.
Changing this setting won’t have an effect on the backing index that is currently being reindexed.
For example, changing the setting won’t have an effect on .ds-my-data-stream-2025.01.23-000002
, but would have an
effect on the next backing index.
But in the above status, .ds-my-data-stream-2025.01.23-000002
has values of 1000 and 10M for the
reindexed_doc_count
and total_doc_count
, respectively. This means it has only reindexed 0.01% of the documents in the index.
It might be a good time to cancel the run and optimize some settings without losing much work.
So we call the cancel API:
POST /_migration/reindex/my-data-stream/_cancel
Now we can use the update cluster settings API to increase the throttle:
const response = await client.cluster.putSettings({ persistent: { "migrate.data_stream_reindex_max_request_per_second": 10000, }, }); console.log(response);
PUT /_cluster/settings { "persistent" : { "migrate.data_stream_reindex_max_request_per_second" : 10000 } }
The original reindex command can now be used to restart reindexing.
Because the first backing index, .ds-my-data-stream-2025.01.23-000001
, has already been reindexed and thus is already version 8.x,
it will be skipped. The task will start by reindexing .ds-my-data-stream-2025.01.23-000002
again from the beginning.
Later, once all the backing indices have finished, the reindex status API will return something like the following:
{ "start_time_millis": 1737676174349, "complete": true, "total_indices_in_data_stream": 4, "total_indices_requiring_upgrade": 2, "successes": 2, "in_progress": [], "pending": 0, "errors": [] }
Notice that the value of total_indices_requiring_upgrade
is 2
, unlike the previous status, which had a value of 3
.
This is because .ds-my-data-stream-2025.01.23-000001
was upgraded before the task cancellation.
After the restart, the API sees that it does not need to be upgraded, thus does not include it in total_indices_requiring_upgrade
or successes
,
despite the fact that it upgraded successfully.
The completed status will be accessible from the status API for 24 hours after completion of the task.
We can now check the data stream to verify that indices were upgraded:
const response = await client.indices.getDataStream({ name: "my-data-stream", filter_path: "data_streams.indices.index_name", }); console.log(response);
GET _data_stream/my-data-stream?filter_path=data_streams.indices.index_name
which returns:
{ "data_streams": [ { "indices": [ { "index_name": ".migrated-ds-my-data-stream-2025.01.23-000003" }, { "index_name": ".migrated-ds-my-data-stream-2025.01.23-000002" }, { "index_name": ".migrated-ds-my-data-stream-2025.01.23-000001" }, { "index_name": ".ds-my-data-stream-2025.01.23-000004" } ] } ] }
Index .ds-my-data-stream-2025.01.23-000004
is the write index and didn’t need to be upgraded because it was created with version 8.x.
The other three backing indices are now prefixed with .migrated
because they have been upgraded.
We can now check the indices and verify that they have version 8.x:
const response = await client.indices.get({ index: ".migrated-ds-my-data-stream-2025.01.23-000001", human: "true", filter_path: "*.settings.index.version.created_string", }); console.log(response);
GET .migrated-ds-my-data-stream-2025.01.23-000001?human&filter_path=*.settings.index.version.created_string
which returns:
{ ".migrated-ds-my-data-stream-2025.01.23-000001": { "settings": { "index": { "version": { "created_string": "8.18.0" } } } } }
Handling Failures
editSince the reindex data stream API runs in the background, failure information can be obtained through the reindex status API.
For example, if the backing index .ds-my-data-stream-2025.01.23-000002
was accidentally deleted by a user, we would see a status like the following:
{ "start_time_millis": 1737676174349, "complete": false, "total_indices_in_data_stream": 4, "total_indices_requiring_upgrade": 3, "successes": 1, "in_progress": [], "pending": 1, "errors": [ { "index": ".ds-my-data-stream-2025.01.23-000002", "message": "index [.ds-my-data-stream-2025.01.23-000002] does not exist" } ] }
Once the issue has been fixed, the failed reindex task can be re-run. First, the failed run’s status must be cleared using the reindex cancel API. Then the original reindex command can be called to pick up where it left off.
On this page