elasticsearch/docs/reference/modules
Ali Beyad 743217a430 Enhances get snapshots API to allow retrieving repository index only (#24477)
Currently, the get snapshots API (e.g. /_snapshot/{repositoryName}/_all)
provides information about snapshots in the repository, including the
snapshot state, number of shards snapshotted, failures, etc.  In order
to provide information about each snapshot in the repository, the call
must read the snapshot metadata blob (`snap-{snapshot_uuid}.dat`) for
every snapshot.  In cloud-based repositories, this can be expensive,
both from a cost and performance perspective.  Sometimes, all the user
wants is to retrieve all the names/uuids of each snapshot, and the
indices that went into each snapshot, without any of the other status
information about the snapshot.  This minimal information can be
retrieved from the repository index blob (`index-N`) without needing to
read each snapshot metadata blob.

This commit enhances the get snapshots API with an optional `verbose`
parameter.  If `verbose` is set to false on the request, then the get
snapshots API will only retrieve the minimal information about each
snapshot (the name, uuid, and indices in the snapshot), and only read
this information from the repository index blob, thereby giving users
the option to retrieve the snapshots in a repository in a more
cost-effective and efficient manner.

Closes #24288
2017-05-10 15:48:40 -04:00
..
cluster Add a note about cluster.routing.allocation.node_concurrent_recoveries (#23160) 2017-02-14 14:14:41 +02:00
discovery Link to minimum master nodes docs from Zen docs 2017-04-25 16:53:05 -04:00
indices Deprecate request_cache for clear-cache (#23638) 2017-03-22 08:28:04 -04:00
scripting Fixed docs syntax for for-in loop in painless 2017-05-05 16:07:20 +02:00
cluster.asciidoc Fix typo in cluster module docs 2016-07-12 16:32:23 -04:00
cross-cluster-search.asciidoc CONSOLEify a few more docs 2017-05-04 21:01:14 -04:00
discovery.asciidoc [DOCS] add azure and gce discovery plugins 2014-02-06 09:18:42 +01:00
gateway.asciidoc Update gateway.asciidoc (#19572) 2016-07-28 13:09:05 +02:00
http.asciidoc Enforce Content-Type requirement on the rest layer and remove deprecated methods (#23146) 2017-02-17 14:45:41 -05:00
indices.asciidoc Fix doc build. 2016-06-22 09:34:49 +02:00
memcached.asciidoc Fix organization rename in all files in project 2016-03-03 12:04:13 -07:00
network.asciidoc Document using round-robin DNS for discovery (#21810) 2016-12-14 11:29:39 +01:00
node.asciidoc Reflect cross-cluster search in "dedicated" terminology (#23771) 2017-03-27 23:14:34 -04:00
plugins.asciidoc Docs: Prepare plugin and integration docs for 2.0 2015-08-15 18:02:43 +02:00
scripting.asciidoc Remove groovy scripting language (#21607) 2016-11-22 19:24:12 -08:00
snapshots.asciidoc Enhances get snapshots API to allow retrieving repository index only (#24477) 2017-05-10 15:48:40 -04:00
threadpool.asciidoc Fix bulk queue size in thread pool docs 2017-04-03 22:39:24 -04:00
thrift.asciidoc Fix organization rename in all files in project 2016-03-03 12:04:13 -07:00
transport.asciidoc Docs: CONSOLEify transport docs (#23027) 2017-02-07 20:06:28 -06:00
tribe.asciidoc Deprecate the Tribe node 2017-05-10 14:05:12 +02:00