Elasticsearch 索引模版（Index template）

冷不防 2023-07-13 13:53 30阅读 0赞

**目录**

一、问题产生背景

二、作用

三、添加索引模版

四、更新索引模版

五、查询索引模版

六，删除索引模版

--------------------

# 一、问题产生背景 #

在做Elasticsearch和Logstash集成时，由于ES默认的索引分片数是5、副本数是1，导致Logstash在ES中创建索引时，引起ES的健康值变黄。虽然目前看上去没有问题，但是黄颜色，始终不健康。因此，找寻是否有默认索引方案。由此搜索ES官方文档，发现可以添加索引模版(Index template)。

# 二、作用 #

当创建索引时，索引模版可以定义索引的设置和相关字段映射。ES会基于匹配索引名字的方式，将模板应用于创建新的索引。

模版索引，只会在索引创建过程中起作用，不会影响已经存在的索引。具体的settings和mapping的配置，可以参考创建索引的api。

如下为原文：

Index templates define [settings][] and [mappings][] that you can automatically apply when creating new indices. Elasticsearch applies templates to new indices based on an index pattern that matches the index name.

Index templates are only applied during index creation. Changes to index templates do not affect existing indices. Settings and mappings specified in [create index][] API requests override any settings or mappings specified in an index template.

# 三、添加索引模版 #

请求形式 PUT

内容格式 application/json

请求地址 /\_template/<index-template>

<index-template> 索引模版名称

请求body中参数

<table> 
 <tbody> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;width:105pt;">参数名称</td> 
 <td style="text-align:center;vertical-align:middle;width:65pt;">是否必传</td> 
 <td style="text-align:center;vertical-align:middle;width:137pt;">类型</td> 
 <td style="text-align:center;vertical-align:middle;width:110pt;">默认值</td> 
 <td style="text-align:center;vertical-align:middle;width:379pt;">说明</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">index_patterns</td> 
 <td style="text-align:center;vertical-align:middle;">是</td> 
 <td style="text-align:center;vertical-align:middle;">array of strings</td> 
 <td style="text-align:center;vertical-align:middle;">　</td> 
 <td style="text-align:center;vertical-align:middle;">在创建过程中，匹配索引名字的通配符</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">settings</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">index setting object</td> 
 <td style="text-align:center;vertical-align:middle;">　</td> 
 <td style="text-align:center;vertical-align:middle;">索引设置，包括分片数和副本数量等，具体详见索引设置</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">order</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">integer</td> 
 <td style="text-align:center;vertical-align:middle;">0</td> 
 <td style="text-align:center;vertical-align:middle;width:379pt;">该索引模版的权重值。 当有多个索引模版时，order值越小，越先匹配；order值越大，越后匹配</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">create</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">boolean</td> 
 <td style="text-align:center;vertical-align:middle;">FALSE</td> 
 <td style="text-align:center;vertical-align:middle;">标明该索引模版是否被替换或者更新</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">timeout</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">time unit</td> 
 <td style="text-align:center;vertical-align:middle;">30s</td> 
 <td style="text-align:center;vertical-align:middle;">请求响应时间</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">master_timeout</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">time unit</td> 
 <td style="text-align:center;vertical-align:middle;">30s</td> 
 <td style="text-align:center;vertical-align:middle;">连接主节点的请求响应时间</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">aliases</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">alias object</td> 
 <td style="text-align:center;vertical-align:middle;">　</td> 
 <td style="text-align:center;vertical-align:middle;">索引别名，详见更新索引别名设置</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">mappings</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">mapping object</td> 
 <td style="text-align:center;vertical-align:middle;">　</td> 
 <td style="text-align:center;vertical-align:middle;">索引映射</td> 
 </tr> 
 <tr> 
 <td style="text-align:center;vertical-align:middle;">version</td> 
 <td style="text-align:center;vertical-align:middle;">否</td> 
 <td style="text-align:center;vertical-align:middle;">integer</td> 
 <td style="text-align:center;vertical-align:middle;">　</td> 
 <td style="text-align:center;vertical-align:middle;">索引模版的版本号</td> 
 </tr> 
 </tbody> 
</table>

调用举例

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2E4MEM1MQ_size_16_color_FFFFFF_t_70][]

# 四、更新索引模版 #

和添加一致，只需要保证索引模版的名字一样就行。

# 五、查询索引模版 #

请求形式 GET

内容格式 application/json

请求地址 /\_template/<index-template1>\[,<index-template2>\]

<index-template> 索引模版名称

如果要获取多个索引模版，用逗号隔开

如果不加索引模板名字，则是获取当前ES中所有的索引模版信息。

调用举例

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2E4MEM1MQ_size_16_color_FFFFFF_t_70 1][]

# 六，删除索引模版 #

请求形式 DELETE

内容格式 application/json

请求地址 /\_template/<index-template>

<index-template> 索引模版名称

调用举例

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2E4MEM1MQ_size_16_color_FFFFFF_t_70 2][]

[settings]: https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index-modules.html#index-modules-settings
[mappings]: https://www.elastic.co/guide/en/elasticsearch/reference/7.5/mapping.html
[create index]: https://www.elastic.co/guide/en/elasticsearch/reference/7.5/indices-create-index.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2E4MEM1MQ_size_16_color_FFFFFF_t_70]: /images/20230529/6adada18027642a9b5e4095ae7059867.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2E4MEM1MQ_size_16_color_FFFFFF_t_70 1]: /images/20230529/a0e35df5da364c99b3fc9f839de46c8c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2E4MEM1MQ_size_16_color_FFFFFF_t_70 2]: /images/20230529/1a96858d22304c33b001456b7daf9c12.png