- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 7.10
- Getting started with Elasticsearch
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Setting JVM options
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- HTTP
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Node
- Network settings
- Node query cache settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot lifecycle management settings
- Transforms settings
- Transport
- Thread pools
- Watcher settings
- Important Elasticsearch configuration
- 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
- G1GC 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
- Set up X-Pack
- Configuring X-Pack Java Clients
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- 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
- Index templates
- Data streams
- Ingest node
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Geo-distance
- Geohash grid
- Geotile grid
- Global
- Histogram
- IP range
- Missing
- Nested
- Parent
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Bucket aggregations
- EQL
- SQL access
- 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
- Data management
- ILM: Manage the index lifecycle
- Overview
- Concepts
- Automate rollover
- Manage Filebeat time-based indices
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Resolve lifecycle policy execution errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Monitor a cluster
- Frozen indices
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure a cluster
- Overview
- Configuring security
- User authentication
- Built-in users
- Internal users
- Token-based authentication services
- Realms
- Realm chains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- Integrating with other authentication systems
- Enabling anonymous access
- 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
- Granting access to Stack Management features
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and index 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
- Enabling audit logging
- Encrypting communications
- Restricting connections with IP filtering
- Cross cluster search, clients, and integrations
- Tutorial: Getting started with security
- Tutorial: Encrypting communications
- 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
- Watch for cluster and index events
- Command line tools
- How To
- Glossary of terms
- REST APIs
- API conventions
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- 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
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Nodes reload secure settings
- Nodes stats
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Cross-cluster replication APIs
- Data stream APIs
- Document APIs
- Enrich APIs
- Graph explore API
- Index APIs
- Add index alias
- Analyze
- Clear cache
- Clone index
- Close index
- Create index
- Delete index
- Delete index alias
- Delete component template
- Delete index template
- Delete index template (legacy)
- Flush
- Force merge
- Freeze index
- Get component template
- Get field mapping
- Get index
- Get index alias
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Index alias exists
- Index exists
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- Open index
- Put index template
- Put index template (legacy)
- Put component template
- Put mapping
- Refresh
- Rollover index
- Shrink index
- Simulate index
- Simulate template
- Split index
- Synced flush
- Type exists
- Unfreeze index
- Update index alias
- Update index settings
- Resolve index
- List dangling indices
- Import dangling index
- Delete dangling index
- Index lifecycle management APIs
- Ingest APIs
- Info API
- Licensing 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
- Find file structure
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get machine learning info
- Get model snapshots
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Revert model snapshots
- Set upgrade mode
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Create trained models
- Update data frame analytics jobs
- Delete data frame analytics jobs
- Delete trained models
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Get trained models
- Get trained models stats
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Migration APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Search APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete users
- Disable users
- Enable users
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get token
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SSL certificate
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 7.10.2
- Elasticsearch version 7.10.1
- Elasticsearch version 7.10.0
- Elasticsearch version 7.9.3
- Elasticsearch version 7.9.2
- Elasticsearch version 7.9.1
- Elasticsearch version 7.9.0
- Elasticsearch version 7.8.1
- Elasticsearch version 7.8.0
- Elasticsearch version 7.7.1
- Elasticsearch version 7.7.0
- Elasticsearch version 7.6.2
- Elasticsearch version 7.6.1
- Elasticsearch version 7.6.0
- Elasticsearch version 7.5.2
- Elasticsearch version 7.5.1
- Elasticsearch version 7.5.0
- Elasticsearch version 7.4.2
- Elasticsearch version 7.4.1
- Elasticsearch version 7.4.0
- Elasticsearch version 7.3.2
- Elasticsearch version 7.3.1
- Elasticsearch version 7.3.0
- Elasticsearch version 7.2.1
- Elasticsearch version 7.2.0
- Elasticsearch version 7.1.1
- Elasticsearch version 7.1.0
- Elasticsearch version 7.0.0
- Elasticsearch version 7.0.0-rc2
- Elasticsearch version 7.0.0-rc1
- Elasticsearch version 7.0.0-beta1
- Elasticsearch version 7.0.0-alpha2
- Elasticsearch version 7.0.0-alpha1
- Dependencies and versions
Get snapshot status API
editGet snapshot status API
editRetrieves a detailed description of the current state for each shard participating in the snapshot.
GET _snapshot/_status
Request
editGET _snapshot/_status
GET _snapshot/<repository>/_status
GET _snapshot/<repository>/<snapshot>/_status
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
monitor_snapshot
,create_snapshot
, ormanage
cluster privilege to use this API.
Description
editUse the get snapshot status API to get detailed information about the shards participating in a snapshot.
If you omit the <snapshot>
request path parameter, the request only retrieves
information for currently running snapshots. This usage is preferred.
If needed, you can specify <repository>
and <snapshot>
to retrieve
information for specific snapshots, even if they’re not currently running.
Using the get snapshot status API to return any status results other than the currently running snapshots (_current
) can be very expensive. Each request to retrieve snapshot status results in file reads from every shard in a snapshot, for each snapshot. Such requests are taxing to machine resources and can also incur high processing costs when running in the cloud.
For example, if you have 100 snapshots with 1,000 shards each, the API request will result in 100,000 file reads (100 snapshots * 1,000 shards). Depending on the latency of your file storage, the request can take extremely long to retrieve results.
Path parameters
edit-
<repository>
-
(Optional, string)
Snapshot repository name used to limit the request. Supports wildcards (
*
) if<snapshot>
isn’t specified. -
<snapshot>
-
(Optional, string)
Comma-separated list of snapshots to retrieve status for. Defaults to
currently running snapshots. Wildcards (
*
) are not supported.
Request body
edit-
ignore_unavailable
-
(Optional, Boolean) If
false
, the request returns an error for any snapshots that are unavailable. Defaults tofalse
.If
true
, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.
Response body
edit-
repository
- (string) Name of the repository that includes the snapshot.
-
snapshot
- (string) Name of the snapshot.
-
uuid
- (string) Universally unique identifier (UUID) of the snapshot.
-
state
-
(string) Indicates the current snapshot state.
Values for
state
-
FAILED
- The snapshot finished with an error and failed to store any data.
-
IN_PROGRESS
- The snapshot is currently running.
-
PARTIAL
-
The global cluster state was stored, but data of at least one shard was not stored successfully.
The
failures
section of the response contains more detailed information about shards that were not processed correctly. -
SUCCESS
- The snapshot finished and all shards were stored successfully.
-
-
include_global_state
- (Boolean) Indicates whether the current cluster state is included in the snapshot.
-
shards_stats
-
(object) Contains a count of shards in the snapshot.
Properties of
shards_stats
-
initializing
- (integer) Number of shards that are still initializing.
-
started
- (integer) Number of shards that have started but not are not finalized.
-
finalizing
- (integer) Number of shards that are finalizing but are not done.
-
done
- (integer) Number of shards that initialized, started, and finalized successfully.
-
failed
- (integer) Number of shards that failed to be included in the snapshot.
-
total
- (integer) Total number of shards included in the snapshot.
-
-
stats
-
(object) Provides details on the number (
file_count
) and size (size_in_bytes
) of files included in the snapshot.Properties of
stats
-
incremental
-
(object) Number and size of files that still need to be copied as part of the incremental snapshot.
For completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot.
-
processed
-
(object)
Number and size of files that have already been uploaded to the snapshot. After a file is uploaded, the processed
file_count
andsize_in_bytes
are incremented instats
. -
total
- (object) Total number and size of files that are referenced by the snapshot.
-
-
<index>
-
(list of objects) List of objects containing information about the indices included in the snapshot.
Properties of
<index>
-
shards_stats
-
(object)
See
shards_stats
. -
stats
-
(object)
See
stats
. -
shards
-
(list of objects) List of objects containing information about the shards that include the snapshot.
Properties of
shards
-
stage
-
(string) Indicates the current state of the shards that include the snapshot.
Properties of
stage
-
DONE
- Number of shards in the snapshot that were successfully stored in the repository.
-
FAILURE
- Number of shards in the snapshot that were not successfully stored in the repository.
-
FINALIZE
- Number of shards in the snapshot that are in the finalizing stage of being stored in the repository.
-
INIT
- Number of shards in the snapshot that are in the initializing stage of being stored in the repository.
-
STARTED
- Number of shards in the snapshot that are in the started stage of being stored in the repository.
-
-
stats
-
(object)
See
stats
. -
total
- (object) Total number and size of files that are referenced by the snapshot.
-
start_time_in_millis
-
(long)
See
start_time_in_millis
. -
time_in_millis
-
(long)
See
time_in_millis
.
-
-
Example
editThe following request returns detailed status information for snapshot_2
in the my_repository
repository. This response includes additional information beyond the Get snapshot API, such as shard status and file statistics.
GET _snapshot/my_repository/snapshot_2/_status
{ "snapshots" : [ { "snapshot" : "snapshot_2", "repository" : "my_repository", "uuid" : "lNeQD1SvTQCqqJUMQSwmGg", "state" : "SUCCESS", "include_global_state" : false, "shards_stats" : { "initializing" : 0, "started" : 0, "finalizing" : 0, "done" : 1, "failed" : 0, "total" : 1 }, "stats" : { "incremental" : { "file_count" : 3, "size_in_bytes" : 5969 }, "total" : { "file_count" : 4, "size_in_bytes" : 6024 }, "start_time_in_millis" : 1594829326691, "time_in_millis" : 205 }, "indices" : { "index_1" : { "shards_stats" : { "initializing" : 0, "started" : 0, "finalizing" : 0, "done" : 1, "failed" : 0, "total" : 1 }, "stats" : { "incremental" : { "file_count" : 3, "size_in_bytes" : 5969 }, "total" : { "file_count" : 4, "size_in_bytes" : 6024 }, "start_time_in_millis" : 1594829326896, "time_in_millis" : 0 }, "shards" : { "0" : { "stage" : "DONE", "stats" : { "incremental" : { "file_count" : 3, "size_in_bytes" : 5969 }, "total" : { "file_count" : 4, "size_in_bytes" : 6024 }, "start_time_in_millis" : 1594829326896, "time_in_millis" : 0 } } } } } } ] }