version 1.2 is now the default API, and is available in the client
This commit is contained in:
Spencer Alger
@ -1,10 +1,11 @@
|
||||
[[api-reference]]
|
||||
== 1.1 API
|
||||
== 1.2 API
|
||||
|
||||
|
||||
NOTE: This is currently the default API, but in upcomming versions that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change unexpectedly.
|
||||
|
||||
[[js-api-method-index]]
|
||||
* <<api-abortbenchmark,abortBenchmark>>
|
||||
* <<api-bulk,bulk>>
|
||||
* <<api-clearscroll,clearScroll>>
|
||||
* <<api-count,count>>
|
||||
@ -18,6 +19,7 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
|
||||
* <<api-getsource,getSource>>
|
||||
* <<api-index,index>>
|
||||
* <<api-info,info>>
|
||||
* <<api-listbenchmarks,listBenchmarks>>
|
||||
* <<api-mget,mget>>
|
||||
* <<api-mlt,mlt>>
|
||||
* <<api-mpercolate,mpercolate>>
|
||||
@ -35,6 +37,7 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
|
||||
* <<api-cat-aliases,cat.aliases>>
|
||||
* <<api-cat-allocation,cat.allocation>>
|
||||
* <<api-cat-count,cat.count>>
|
||||
* <<api-cat-fielddata,cat.fielddata>>
|
||||
* <<api-cat-health,cat.health>>
|
||||
* <<api-cat-help,cat.help>>
|
||||
* <<api-cat-indices,cat.indices>>
|
||||
@ -83,7 +86,6 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
|
||||
* <<api-indices-recovery,indices.recovery>>
|
||||
* <<api-indices-refresh,indices.refresh>>
|
||||
* <<api-indices-segments,indices.segments>>
|
||||
* <<api-indices-snapshotindex,indices.snapshotIndex>>
|
||||
* <<api-indices-stats,indices.stats>>
|
||||
* <<api-indices-status,indices.status>>
|
||||
* <<api-indices-updatealiases,indices.updateAliases>>
|
||||
@ -101,6 +103,29 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
|
||||
* <<api-snapshot-restore,snapshot.restore>>
|
||||
* <<api-snapshot-status,snapshot.status>>
|
||||
|
||||
[[api-abortbenchmark]]
|
||||
=== `abortBenchmark`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.abortBenchmark([params, [callback]])
|
||||
--------
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`name`::
|
||||
`String` -- A benchmark name
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-bulk]]
|
||||
=== `bulk`
|
||||
|
||||
@ -918,6 +943,31 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
|
||||
|
||||
|
||||
[[api-listbenchmarks]]
|
||||
=== `listBenchmarks`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.listBenchmarks([params, [callback]])
|
||||
--------
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
`String` -- The name of the document type
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-mget]]
|
||||
=== `mget`
|
||||
|
||||
@ -1580,7 +1630,7 @@ client.searchTemplate([params, [callback]])
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html[the elasticsearch docs] for more about this method.
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
@ -1588,6 +1638,32 @@ The default method is `POST` and the usual <<api-conventions,params and return v
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`ignoreUnavailable`::
|
||||
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
`allowNoIndices`::
|
||||
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
Options:::
|
||||
* `"open"`
|
||||
* `"closed"`
|
||||
|
||||
`preference`::
|
||||
`String` -- Specify the node or shard the operation should be performed on (default: random)
|
||||
`routing`::
|
||||
`String, String[], Boolean` -- A comma-separated list of specific routing values
|
||||
`scroll`::
|
||||
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
|
||||
`searchType`::
|
||||
`String` -- Search operation type
|
||||
Options:::
|
||||
* `"query_then_fetch"`
|
||||
* `"query_and_fetch"`
|
||||
* `"dfs_query_then_fetch"`
|
||||
* `"dfs_query_and_fetch"`
|
||||
* `"count"`
|
||||
* `"scan"`
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
|
||||
`type`::
|
||||
@ -1840,8 +1916,6 @@ Options:::
|
||||
`String` -- Specific version type
|
||||
Options:::
|
||||
* `"internal"`
|
||||
* `"external"`
|
||||
* `"external_gte"`
|
||||
* `"force"`
|
||||
|
||||
`id`::
|
||||
@ -1960,6 +2034,47 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-cat-fielddata]]
|
||||
=== `cat.fielddata`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.cat.fielddata([params, [callback]])
|
||||
--------
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`bytes`::
|
||||
`String` -- The unit in which to display byte values
|
||||
Options:::
|
||||
* `"b"`
|
||||
* `"k"`
|
||||
* `"m"`
|
||||
* `"g"`
|
||||
|
||||
`local`::
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Explicit operation timeout for connection to master node
|
||||
`h`::
|
||||
`String, String[], Boolean` -- Comma-separated list of column names to display
|
||||
`help`::
|
||||
`Boolean` -- Return help information
|
||||
`v`::
|
||||
`Boolean` -- Verbose mode. Display column headers
|
||||
`fields`::
|
||||
`String, String[], Boolean` -- A comma-separated list of fields to return the fielddata size
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-cat-health]]
|
||||
=== `cat.health`
|
||||
|
||||
@ -2465,8 +2580,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
|
||||
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
|
||||
`masterTimeout`::
|
||||
`Date, Number` -- Specify timeout for connection to master
|
||||
`indexTemplates`::
|
||||
`String, String[], Boolean` -- A comma separated list to return specific index templates when returning metadata
|
||||
`flatSettings`::
|
||||
`Boolean` -- Return settings in flat format (default: false)
|
||||
`index`::
|
||||
@ -3580,39 +3693,6 @@ Options:::
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-indices-snapshotindex]]
|
||||
=== `indices.snapshotIndex`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.indices.snapshotIndex([params, [callback]])
|
||||
--------
|
||||
|
||||
Initiate a snapshot through the gateway of one or more indices.
|
||||
|
||||
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/indices-gateway-snapshot.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`ignoreUnavailable`::
|
||||
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
`allowNoIndices`::
|
||||
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
||||
`[expandWildcards=open]`::
|
||||
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
|
||||
Options:::
|
||||
* `"open"`
|
||||
* `"closed"`
|
||||
|
||||
`index`::
|
||||
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string for all indices
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-indices-stats]]
|
||||
=== `indices.stats`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user