带你读《Elastic Stack 实战手册》之28:——3.4.2.13.Rollover API(1)

本文涉及的产品
Elasticsearch Serverless通用抵扣包,测试体验金 200元
简介: 带你读《Elastic Stack 实战手册》之28:——3.4.2.13.Rollover API(1)

3.4.2.13.Rollover API


创作人:杨松柏

 

了解 Elasticsearch 的同学应该都知道,索引的主分片在设定之后,改变(shrinksplit

reindex)主分片数目的成本相当大;因此在设计之初,一定要规划好索引的分片数目。如果集群的中节点数目固定,且写入的数据不会再有更新操作或者更新操作极其少;可以使用Rollover index的方式来限制每个索引的大小。

 

Rollover:

 

rollover-target绑定的当前索引满足设定的条件,执行滚动操作将会为rollover-target创建新索引。滚动目标可以是索引别名或者数据流;

 

l 当滚动目标是别名时,执行滚动别名将指向新的索引。

l 当滚动目标是数据流时,数据流将数据写入到新的索引,且新索引名后缀自增 1。


POST /alias1/_rollover/my-index-000002
{
  "conditions": {
    "max_age":   "7d",
    "max_docs":  2,
    "max_size": "5gb"
  }
}


如果需要实现 Rollover 自动化,可以自行实现一个定时任务请求该 API 或者使用 Elasticsearch 的 index lifecycle management (ILM) 功能。

 

API 介绍


Rollover API


POST /<rollover-target>/_rollover/<target-index>?wait_for_active_shards=<number>
POST /<rollover-target>/_rollover?wait_for_active_shards=<number>

URI 参数

 

 

必填参数,参数类型string。将已存的索引别名或数据流,分配给目标索引,来完成执行滚动。

 

 

可选参数,参数类型string。代表要被创建和分配索引别名的目标索引名称;

 

目标索引名称必须遵循以下规则:

 

l 所有字符必须小写

l 不允许包含\ / * ? " < >| ` ` (space character) , #

l 在7.0版本之前允许包含:,在7.0+不再支持

l 不能够以-_+开头

l 名称不能够是.或者..

l 长度不能超过 255 字节(注意:这是字节数限制,如果是字符得看表示一个字符需要多少个字节)

l 名称以 . 开头已经过时;除了隐藏索引和由插件管理的内部索引

 

如果rollover-target为数据流, 参数是不被允许的;执行 Rollover 数据流会按照相应规则生产新的索引:格式为 .ds--000001,其中-000001,数字必为6位数,左侧高位用0 补充,每发生一次 Rollover 自增加1。

 如果rollover-target为一个索引别名,且别名绑定的索引以 - 结尾;如果不指定

 执行 Rollover ,将生成新的索引indexName-+1

 

如果别名现绑定的索引名称不满足以 - 形式结尾,则必须指定 

 

查询参数

 

dry_run

 

可选参数,参数类型为boolean,默认值为 false。该参数的作用为检测 index 是否满足提供的 rollover 条件。 如果设置为true,将会完成检查工作,但不会真正执行 rollover 。

 

include_type_name

 

可选参数,参数类型为boolean,默认值为 false。在 mappings体内要求必须有mapping

type。

 

wait_for_active_shards

 

可选参数,参数类型为 string,默认值为 1(即只要一个主分片处于活跃便可以执行操作)。在执行rollover,要求处于活跃状态的索引分片副本数目,以保证数据的可靠和安全性;设置为

all或任何正整数,最多为索引分片的总数(number_of_replicas+1)。

 

详情可以参考 Active shardshttps://www.elastic.co/guide/en/elasticsearch/reference/7.10/docs-index_.html#index-wait-for-active-shards

 

master_timeout

 

可选参数,value值的单位可为dhmsmsmicrosnanos,默认值为30s。等待连接到主节点的时间。如果在超时时间阈值之前没有收到响应,则请求失败并返回错误。


timeout

 

可选参数,value 值的单位可为dhmsmsmicrosnanos,默认值为30s。请求等待

 

响应的时间。如果在超时时间阈值之前没有收到响应,则请求失败并返回错误。

 

请求体参数

 

aliases

 

可选参数,alias object。包含索引的 Index aliases。详情可以参看索引别名,批量操作的相关内容(即_aliases API)。

 

conditions

 

可选参数,参数类型object。如果设置条件,则只有现有索引达到条件集任何一个条件的阈值才会完成rollover。如果省略,则无条件执行rollover。条件集包括:

 

l max_age

l 可选参数,value 值的单位可为dhmsmsmicrosnanos;依据索引的创建时间与现在时间差值作为阈值。

 

l max_docs

l 可选参数,参数类型为integer;索引的最大文档数目;计数不包括自上次refresh之后新添加的文档和副本分片的文档。

 

l max_size

l 可选参数, byte units 值(单位bkbmbgbtbpb)。索引大小的最大值,只计算索引主分片的大小,副本不包括在内。

 

 mappings

 

可选参数,参数 mapping object。为索引进行数据建模,定义字段schema等。如果设置,mapping可能包含:

 

l 字段名字(Field names)

l 字段的数据类型(Field data types)

l mapping中一些修饰参数(Mapping parameters)

 

settings

 

可选参数,参数 index setting object。索引的配置选项;比如设置滚动产生的新索引副本分片数目等等。

 

详情可以参看 Index Settings:https://www.elastic.co/guide/en/elasticsearch/reference/7.10/index-modules.html#index-modules-settings

 


《Elastic Stack 实战手册》——三、产品能力——3.4.入门篇——3.4.2.Elasticsearch基础应用——3.4.2.13.Rollover API(2) https://developer.aliyun.com/article/1230208


相关实践学习
以电商场景为例搭建AI语义搜索应用
本实验旨在通过阿里云Elasticsearch结合阿里云搜索开发工作台AI模型服务,构建一个高效、精准的语义搜索系统,模拟电商场景,深入理解AI搜索技术原理并掌握其实现过程。
ElasticSearch 最新快速入门教程
本课程由千锋教育提供。全文搜索的需求非常大。而开源的解决办法Elasricsearch(Elastic)就是一个非常好的工具。目前是全文搜索引擎的首选。本系列教程由浅入深讲解了在CentOS7系统下如何搭建ElasticSearch,如何使用Kibana实现各种方式的搜索并详细分析了搜索的原理,最后讲解了在Java应用中如何集成ElasticSearch并实现搜索。 &nbsp;
相关文章
|
2月前
|
Cloud Native API
微服务引擎 MSE 及云原生 API 网关 2025 年 6 月产品动态
微服务引擎 MSE 及云原生 API 网关 2025 年 6 月产品动态
|
2月前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 API 网关 2025 年 6 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要。
|
2月前
|
JSON API 开发者
产品列表获取API接口详解
本文详解如何设计与调用产品列表获取API接口,涵盖核心概念、实现步骤、Python代码示例及最佳实践,助你高效构建数据驱动应用。
117 0
|
5月前
|
Cloud Native API
微服务引擎 MSE 及云原生 API 网关 2025 年 3 月产品动态
微服务引擎 MSE 及云原生 API 网关 2025 年 3 月产品动态
|
6月前
|
Cloud Native API
微服务引擎 MSE 及云原生 API 网关 2025 年 2 月产品动态
微服务引擎 MSE 及云原生 API 网关 2025 年 2 月产品动态
|
2月前
|
API
阿里云微服务引擎 MSE 及 API 网关 2025 年 7 月产品动态
阿里云微服务引擎 MSE 及 API 网关 2025 年 7 月产品动态
|
2月前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 API 网关 2025 年 7 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要。
|
2月前
|
存储 JSON Prometheus
产品图片上传API接口
产品图片上传API是电商、内容管理系统等常用功能,支持通过HTTP请求上传图片至服务器,便于产品图像管理。本文详解其工作原理、实现步骤与最佳实践,助您快速构建高效上传功能。
199 0
|
2月前
|
XML API 开发者
产品评论获取API接口
在电商与数据分析中,产品评论是重要用户反馈。本文介绍如何通过API接口自动化高效获取评论,涵盖核心概念、实现步骤及Python示例,助您快速构建数据采集流程,提升分析效率与决策能力。
53 0
|
2月前
|
安全 测试技术 API
产品下架与删除API接口
本文介绍电子商务系统中产品下架与删除API的设计与实现,涵盖安全性、数据一致性、错误处理及性能优化要点。通过Python与Flask的示例代码,指导开发者构建高效、可靠的产品管理接口,并提供最佳实践建议,如权限控制、日志记录和接口文档化,助力系统自动化与业务灵活响应市场变化。
46 0