mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
e6326078a0
The simulate template api should include the settings that registered IndexSettingProvider generate. Currently, these settings are not included in the simulate template api response, but are only used to create a dummy IndexService instance to validate aliases.
220 lines
5.3 KiB
Text
220 lines
5.3 KiB
Text
[[indices-simulate-index]]
|
|
=== Simulate index API
|
|
++++
|
|
<titleabbrev>Simulate index</titleabbrev>
|
|
++++
|
|
|
|
experimental[]
|
|
|
|
Returns the index configuration that would be applied to the specified index from an
|
|
existing <<index-templates, index template>>.
|
|
|
|
////
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _index_template/template_1
|
|
{
|
|
"index_patterns": ["my-index-*"],
|
|
"template": {
|
|
"settings": {
|
|
"number_of_shards": 1
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TESTSETUP
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE _index_template/*
|
|
--------------------------------------------------
|
|
// TEARDOWN
|
|
////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_index_template/_simulate_index/my-index-000001
|
|
--------------------------------------------------
|
|
|
|
[[simulate-index-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST /_index_template/_simulate_index/<index>`
|
|
|
|
[[simulate-index-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the
|
|
`manage_index_templates` or `manage` <<privileges-list-cluster,cluster
|
|
privilege>> to use this API.
|
|
|
|
[[simulate-index-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<index>`::
|
|
(Required, string)
|
|
Name of the index to simulate.
|
|
|
|
[[simulate-index-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
////
|
|
`cause`::
|
|
(Optional, string) The reason for running the simulation.
|
|
////
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
|
[role="child_attributes"]
|
|
[[simulate-index-api-response-body]]
|
|
==== {api-response-body-title}
|
|
|
|
`overlapping`::
|
|
(array) Any templates that also matched the index but were superseded by a higher-priority template.
|
|
Response includes an empty array if there are no overlapping templates.
|
|
+
|
|
.Properties of `overlapping`
|
|
[%collapsible%open]
|
|
====
|
|
`name`::
|
|
(string) Name of the superseded template.
|
|
|
|
`index_patterns`::
|
|
(array) Index patterns that the superseded template applies to.
|
|
====
|
|
|
|
`template`::
|
|
(object)
|
|
The settings, mappings, and aliases that would be applied to the index.
|
|
+
|
|
.Properties of `template`
|
|
[%collapsible%open]
|
|
====
|
|
`aliases`::
|
|
(object) Aliases for the index. If no aliases apply, the response returns an
|
|
empty `aliases` object.
|
|
+
|
|
=====
|
|
`<alias>`::
|
|
(object) The key is the alias name. The object body contains options for the
|
|
alias.
|
|
+
|
|
.Properties of `<alias>`
|
|
[%collapsible%open]
|
|
======
|
|
`filter`::
|
|
(<<query-dsl,Query DSL object>>) Query used to limit documents the alias can
|
|
access.
|
|
|
|
`index_routing`::
|
|
(string) Value used to route indexing operations to a specific shard. This
|
|
overwrites the `routing` value for indexing operations.
|
|
|
|
`is_hidden`::
|
|
(Boolean) If `true`, the alias is <<hidden,hidden>>.
|
|
|
|
`is_write_index`::
|
|
(Boolean) If `true`, the index is the <<write-index,write index>> for the alias.
|
|
|
|
`routing`::
|
|
(string) Value used to route indexing and search operations to a specific shard.
|
|
|
|
`search_routing`::
|
|
(string) Value used to route search operations to a specific shard. This
|
|
overwrites the `routing` value for search operations.
|
|
======
|
|
=====
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=mappings]
|
|
+
|
|
Omitted from the response if no mappings would be applied.
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=settings]
|
|
+
|
|
Response includes an empty object if no settings would be applied.
|
|
====
|
|
|
|
[[simulate-index-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
The following example shows the configuration that would be applied to `my-index-000001` by
|
|
an existing template.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT /_component_template/ct1 <1>
|
|
{
|
|
"template": {
|
|
"settings": {
|
|
"index.number_of_shards": 2
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT /_component_template/ct2 <2>
|
|
{
|
|
"template": {
|
|
"settings": {
|
|
"index.number_of_replicas": 0
|
|
},
|
|
"mappings": {
|
|
"properties": {
|
|
"@timestamp": {
|
|
"type": "date"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
PUT /_index_template/final-template <3>
|
|
{
|
|
"index_patterns": ["my-index-*"],
|
|
"composed_of": ["ct1", "ct2"],
|
|
"priority": 5
|
|
}
|
|
|
|
POST /_index_template/_simulate_index/my-index-000001 <4>
|
|
--------------------------------------------------
|
|
<1> Create a component template (`ct1`) that sets the number of shards to 2
|
|
<2> Create a second component template (`ct2`) that sets the number of replicas to 0 and defines a mapping
|
|
<3> Create an index template (`final-template`) that uses the component templates
|
|
<4> Show the configuration that would be applied to `my-index-000001`
|
|
|
|
The response shows the index settings, mappings, and aliases applied by the `final-template`:
|
|
|
|
[source,console-result]
|
|
---------------------------------------------------------
|
|
{
|
|
"template" : {
|
|
"settings" : {
|
|
"index" : {
|
|
"number_of_shards" : "2",
|
|
"number_of_replicas" : "0",
|
|
"routing" : {
|
|
"allocation" : {
|
|
"include" : {
|
|
"_tier_preference" : "data_content"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"mappings" : {
|
|
"properties" : {
|
|
"@timestamp" : {
|
|
"type" : "date"
|
|
}
|
|
}
|
|
},
|
|
"aliases" : { }
|
|
},
|
|
"overlapping" : [
|
|
{
|
|
"name" : "template_1",
|
|
"index_patterns" : [
|
|
"my-index-*"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
---------------------------------------------------------
|