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
|
|
|
|
|
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>>
|
|
|
|
|
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[]
|
2023-04-05 00:37:38 +08:00
|
|
|
|