root
/
elasticsearch
mirror of https://github.com/elastic/elasticsearch.git
1
0
Fork 0
Code Issues Actions 1 Packages Projects Releases Wiki Activity
elasticsearch/docs/reference/dlm/apis/dlm-api.asciidoc

21 lines
649 B
Plaintext
Raw Normal View History

Introduce a _lifecycle/explain API for data stream backing indices (#94621) This adds an {index}/_lifecycle/explain API to retrieve information about an index's status within its lifecycle. The response looks like so: ``` "indices" : { ".ds-metrics-foo-2023.03.22-000001" : { "index" : ".ds-metrics-foo-2023.03.22-000001", "managed_by_dlm" : true, "index_creation_date_millis" : 1679475563571, "time_since_index_creation" : "843ms", "rollover_date_millis" : 1679475564293, "time_since_rollover" : "121ms", "lifecycle" : { }, "generation_time" : "121ms" }, ".ds-metrics-foo-2023.03.22-000002" : { "index" : ".ds-metrics-foo-2023.03.22-000002", "managed_by_dlm" : true, "index_creation_date_millis" : 1679475564351, "time_since_index_creation" : "63ms", "lifecycle" : { } } } } ```
2023-03-27 15:44:40 +08:00
[[data-lifecycle-management-api]]
== Data Lifecycle Management APIs
You use the following APIs to configure the data lifecycle management for data streams
and to retrieve lifecycle information for backing indices.
[discrete]
[[dlm-api-management-endpoint]]
=== Operation management APIs
Add new endpoints to configure data lifecycle on a data stream level. (#94590) With PR we introduce CRUD endpoints which update/delete the data lifecycle on the data stream level. When this is updated it will apply at the next DLM run to all the backing indices that are managed by DLM.
2023-04-05 00:37:38 +08:00
* <<dlm-put-lifecycle,Update data stream lifecycle>>
* <<dlm-get-lifecycle,Get data stream lifecycle>>
* <<dlm-delete-lifecycle,Delete data stream lifecycle>>
Introduce a _lifecycle/explain API for data stream backing indices (#94621) This adds an {index}/_lifecycle/explain API to retrieve information about an index's status within its lifecycle. The response looks like so: ``` "indices" : { ".ds-metrics-foo-2023.03.22-000001" : { "index" : ".ds-metrics-foo-2023.03.22-000001", "managed_by_dlm" : true, "index_creation_date_millis" : 1679475563571, "time_since_index_creation" : "843ms", "rollover_date_millis" : 1679475564293, "time_since_rollover" : "121ms", "lifecycle" : { }, "generation_time" : "121ms" }, ".ds-metrics-foo-2023.03.22-000002" : { "index" : ".ds-metrics-foo-2023.03.22-000002", "managed_by_dlm" : true, "index_creation_date_millis" : 1679475564351, "time_since_index_creation" : "63ms", "lifecycle" : { } } } } ```
2023-03-27 15:44:40 +08:00
* <<dlm-explain-lifecycle,Explain Lifecycle API>>
Add new endpoints to configure data lifecycle on a data stream level. (#94590) With PR we introduce CRUD endpoints which update/delete the data lifecycle on the data stream level. When this is updated it will apply at the next DLM run to all the backing indices that are managed by DLM.
2023-04-05 00:37:38 +08:00
include::put-lifecycle.asciidoc[]
include::get-lifecycle.asciidoc[]
include::delete-lifecycle.asciidoc[]
Introduce a _lifecycle/explain API for data stream backing indices (#94621) This adds an {index}/_lifecycle/explain API to retrieve information about an index's status within its lifecycle. The response looks like so: ``` "indices" : { ".ds-metrics-foo-2023.03.22-000001" : { "index" : ".ds-metrics-foo-2023.03.22-000001", "managed_by_dlm" : true, "index_creation_date_millis" : 1679475563571, "time_since_index_creation" : "843ms", "rollover_date_millis" : 1679475564293, "time_since_rollover" : "121ms", "lifecycle" : { }, "generation_time" : "121ms" }, ".ds-metrics-foo-2023.03.22-000002" : { "index" : ".ds-metrics-foo-2023.03.22-000002", "managed_by_dlm" : true, "index_creation_date_millis" : 1679475564351, "time_since_index_creation" : "63ms", "lifecycle" : { } } } } ```
2023-03-27 15:44:40 +08:00
include::explain-data-lifecycle.asciidoc[]
Add new endpoints to configure data lifecycle on a data stream level. (#94590) With PR we introduce CRUD endpoints which update/delete the data lifecycle on the data stream level. When this is updated it will apply at the next DLM run to all the backing indices that are managed by DLM.
2023-04-05 00:37:38 +08:00