Analyze the index disk usage

POST /{index}/_disk_usage

Analyze the disk usage of each field of an index or data stream. This API might not support indices created in previous Elasticsearch versions. The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API.

NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index store_size value because some small metadata files are ignored and some parts of data files might not be scanned by the API. Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. The stored size of the _id field is likely underestimated while the _source field is overestimated.

Path Parameters

index union IndexName | [] IndexName required: 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

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /my-index-000001/_disk_usage?run_expensive_tasks=true

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.diskUsage({
  index: "my-index-000001",
  run_expensive_tasks: "true",
});

Python Elasticsearch Python Client

resp = client.indices.disk_usage(
    index="my-index-000001",
    run_expensive_tasks=True,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/my-index-000001/_disk_usage?run_expensive_tasks=true" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().diskUsage(d -> d
    .index("my-index-000001")
    .runExpensiveTasks(true)
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .DiskUsageAsync(indices: new[] { "my-index-000001" }, d1 => d1
        .RunExpensiveTasks(true)
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->diskUsage([
    "index" => "my-index-000001",
    "run_expensive_tasks" => "true",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.disk_usage(
  index: "my-index-000001",
  run_expensive_tasks: "true"
)

Response

No example

Path Parameters

Query Parameters { allow_no_indices , expand_wildcards , flush , ignore_unavailable , run_expensive_tasks , }

Response

Query Parameters