Analyzes the disk usage of each field of an index or data stream Technical preview
Path parameters
-
Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly.
Query parameters
-
allow_no_indices boolean
If false, the request returns an error if any wildcard expression, index alias, or
_all
value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targetingfoo*,bar*
returns an error if an index starts withfoo
but no index starts withbar
. -
expand_wildcards string | array[string]
Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as
open,hidden
. -
flush boolean
If
true
, the API performs a flush before analysis. Iffalse
, the response may not include uncommitted data. -
run_expensive_tasks boolean
Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to
true
.
curl \
-X POST http://api.example.com/{index}/_disk_usage
{}