本篇文章为你整理了Rollover index API（）的详细内容，包含有 Rollover index API，希望能帮助你了解 Rollover index API。
IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Creates a new index for a rollover target when the target s existing index meets
a condition you provide. A rollover target can be either an
index alias or a
data stream. When targeting an alias, the alias
is updated to point to the new index. When targeting a data stream, the new
index becomes the data stream s write index and its generation is incremented.
POST /alias1/_rollover/my-index-000002
"conditions": {
"max_age": "7d",
"max_docs": 1000,
"max_size": "5gb"
}
Descriptionedit
The rollover index API rolls a rollover target to a new index when
the existing index meets a condition you provide. You can use this API to retire
an index that becomes too large or too old.
To roll over an index, a condition must be met when you call the API.
Elasticsearch does not monitor the index after you receive an API response. To
automatically roll over indices when a condition is met, you can use Elasticsearch s
index lifecycle management (ILM) policies.
and a list of conditions.
If the specified rollover target is an alias pointing to a single index,
the rollover request:
If the specified rollover target is an alias pointing to multiple indices,
one of these indices must have is_write_index set to true.
In this case, the rollover request:
Name of the existing index alias or data stream on which to
to assign to the target index. perform the rollover.
(Optional*, string)
Name of the target index to create and assign the index alias.
Index names must meet the following criteria:
Indices prior to 7.0 could contain a colon (:), but that s been deprecated and won t be supported in 7.0+
Cannot be longer than 255 bytes (note it is bytes, so multi-byte characters will count towards the 255 limit faster)
Names starting with . are deprecated, except for hidden indices and internal indices managed by plugins
*This parameter is not permitted if rollover-target is a data stream. In
that case, the new index name will be in the form .ds- rollover-target -000001
where the zero-padded number of length 6 is the generation of the data stream.
If rollover-target is an alias that is assigned to an index name that ends
with - and a number such as logs-000001. In this case, the name of the new
index follows the same pattern and increments the number. For example,
logs-000001 increments to logs-000002. This number is zero-padded with a
length of 6, regardless of the prior index name.
If the existing index for the alias does not match this pattern, this parameter
is required.
the request checks whether the index matches provided conditions
but does not perform a rollover.
Defaults to false.
Deprecated in 7.0.0. Mapping types have been deprecated. See Removal of mapping types.
(Optional, Boolean) If true, a mapping type is expected in the body of
mappings. Defaults to false.
(Optional, string) The number of shard copies that must be active before
proceeding with the operation. Set to all or any positive integer up
to the total number of shards in the index (number_of_replicas+1).
Default: 1, the primary shard.
See Active shards.
(Optional, time units) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to 30s.
(Optional, time units) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to 30s.
(Optional, object)
If supplied, the set of conditions the rollover target s existing index must
meet to roll over. If omitted, the rollover will be performed unconditionally.
Parameters include:
Maximum number of documents in the index.
Documents added since the last refresh are not included in the document count.
The document count does not include documents in replica shards.
(Optional, byte units)
Maximum index size.
This is the total size of all primary shards in the index.
Replicas are not counted toward the maximum index size.
To see the current index size, use the _cat indices API.
The pri.store.size value shows the combined size of all primary shards.
(Optional, mapping object) Mapping for fields in the index. If
specified, this mapping can include:
If the index pointed to by logs_write was created 7 or more days ago, or
contains 1,000 or more documents, or has an index size at least around 5GB, then the logs-000002 index is created
and the logs_write alias is updated to point to logs-000002.
Creates a data stream called my-data-stream with one initial backing index
named my-data-stream-000001.
This request creates a new backing index, my-data-stream-000002, and adds
it as the write index for my-data-stream if the current
write index meets at least one of the following conditions:
"shards_acknowledged": true,
"old_index": ".ds-my-data-stream-000001",
"new_index": ".ds-my-data-stream-000002",
"rolled_over": true,
"dry_run": false,
"conditions": {
"[max_age: 7d]": false,
"[max_docs: 1000]": true,
"[max_size: 5gb]": false,
}
Specify settings for the target indexedit
The settings, mappings, and aliases for the new index are taken from any
matching index templates. If the rollover target is an
index alias, you can specify settings, mappings, and aliases in the body
of the request just like the create index API. Values
specified in the request override any values set in matching index templates.
For example, the following rollover request overrides the
index.number_of_shards setting:
PUT /logs-000001
"aliases": {
"logs_write": {}
POST /logs_write/_rollover
"conditions" : {
"max_age": "7d",
"max_docs": 1000,
"max_size": "5gb"
"settings": {
"index.number_of_shards": 2
}
Specify a target index nameedit
If the rollover target is an index alias and the name of the existing index ends
with - and a number e.g. logs-000001 then the name of the new index
will follow the same pattern, incrementing the number (logs-000002). The
number is zero-padded with a length of 6, regardless of the old index name.
If the old name doesn t match this pattern then you must specify the name for
the new index as follows:
POST /my_alias/_rollover/my_new_index_name
"conditions": {
"max_age": "7d",
"max_docs": 1000,
"max_size": "5gb"
}
Use date math with a rolloveredit
If the rollover target is an index alias, it can be useful to use
date math to name the rollover index according to the
date that the index rolled over, e.g. logstash-2016.02.03. The rollover API
supports date math, but requires the index name to end with a dash followed by
a number, e.g. logstash-2016.02.03-1 which is incremented every time the
index is rolled over. For instance:
# PUT / logs-{now/d}-1 with URI encoding:
PUT /%3Clogs_%7Bnow%2Fd%7D-1%3E
"aliases": {
"logs_write": {}
PUT logs_write/_doc/1
"message": "a dummy log"
POST logs_write/_refresh
# Wait for a day to pass
POST /logs_write/_rollover
"conditions": {
"max_docs": "1"
}
Rolls over to a new index with today s date, e.g. logs_2016.10.31-000002 if run immediately, or logs-2016.11.01-000002 if run after 24 hours
These indices can then be referenced as described in the
date math documentation. For example, to search
over indices created in the last three days, you could do the following:
# GET / logs-{now/d}-* , logs-{now/d-1d}-* , logs-{now/d-2d}-* /_search
GET /%3Clogs-%7Bnow%2Fd%7D-*%3E%2C%3Clogs-%7Bnow%2Fd-1d%7D-*%3E%2C%3Clogs-%7Bnow%2Fd-2d%7D-*%3E/_search
Dry runedit
The rollover API supports dry_run mode, where request conditions can be
checked without performing the actual rollover.
POST /logs_write/_rollover?dry_run
"conditions" : {
"max_age": "7d",
"max_docs": 1000,
"max_size": "5gb"
}
Roll over a write indexedit
If the rollover target is an index alias for a write index that has is_write_index explicitly set to true, it is not
swapped during rollover actions. Since having an alias point to multiple indices is ambiguous in distinguishing
which is the correct write index to roll over, it is not valid to rollover an alias that points to multiple indices.
For this reason, the default behavior is to swap which index is being pointed to by the write-oriented alias. This
was logs_write in some of the above examples. Since setting is_write_index enables an alias to point to multiple indices
while also being explicit as to which is the write index that rollover should target, removing the alias from the rolled over
index is not necessary. This simplifies things by allowing for one alias to behave both as the write and read aliases for
indices that are being managed with Rollover.
Look at the behavior of the aliases in the following example where is_write_index is set on the rolled over index.
PUT my_logs_index-000001
"aliases": {
"logs": { "is_write_index": true }
PUT logs/_doc/1
"message": "a dummy log"
POST logs/_refresh
POST /logs/_rollover
"conditions": {
"max_docs": "1"
PUT logs/_doc/2
"message": "a newer log"
}
After the rollover, the alias metadata for the two indices will have the is_write_index setting
reflect each index s role, with the newly created index as the write index.
{
"my_logs_index-000002": {
"aliases": {
"logs": { "is_write_index": true }
"my_logs_index-000001": {
"aliases": {
"logs": { "is_write_index" : false }
}
以上就是Rollover index API（）的详细内容，想要了解更多 Rollover index API的内容，请持续关注盛行IT软件开发工作室。
郑重声明：本文由网友发布，不代表盛行IT的观点，版权归原作者所有，仅为传播更多信息之目的，如有侵权请联系，我们将第一时间修改或删除，多谢。