Analyze index disk usage API example
ServerlessUnavailableStack
The_disk_usage API analyzes how much disk space each field in an index or data stream consumes. It helps you understand storage distribution and identify fields that use the most space. This page shows an example request and response for theAnalyze index disk usage API.
The following request analyzes the disk usage of the indexmy-index-000001:
POST /my-index-000001/_disk_usage?run_expensive_tasks=trueThe API returns:
{ "_shards": { "total": 1, "successful": 1, "failed": 0 }, "my-index-000001": { "store_size": "929mb", "store_size_in_bytes": 974192723, "all_fields": { "total": "928.9mb", "total_in_bytes": 973977084, "inverted_index": { "total": "107.8mb", "total_in_bytes": 113128526 }, "stored_fields": "623.5mb", "stored_fields_in_bytes": 653819143, "doc_values": "125.7mb", "doc_values_in_bytes": 131885142, "points": "59.9mb", "points_in_bytes": 62885773, "norms": "2.3kb", "norms_in_bytes": 2356, "term_vectors": "2.2kb", "term_vectors_in_bytes": 2310, "knn_vectors": "0b", "knn_vectors_in_bytes": 0 }, "fields": { "_id": { "total": "49.3mb", "total_in_bytes": 51709993, "inverted_index": { "total": "29.7mb", "total_in_bytes": 31172745 }, "stored_fields": "19.5mb", "stored_fields_in_bytes": 20537248, "doc_values": "0b", "doc_values_in_bytes": 0, "points": "0b", "points_in_bytes": 0, "norms": "0b", "norms_in_bytes": 0, "term_vectors": "0b", "term_vectors_in_bytes": 0, "knn_vectors": "0b", "knn_vectors_in_bytes": 0 }, "_primary_term": {...}, "_seq_no": {...}, "_version": {...}, "_source": { "total": "603.9mb", "total_in_bytes": 633281895, "inverted_index": {...}, "stored_fields": "603.9mb", "stored_fields_in_bytes": 633281895, "doc_values": "0b", "doc_values_in_bytes": 0, "points": "0b", "points_in_bytes": 0, "norms": "0b", "norms_in_bytes": 0, "term_vectors": "0b", "term_vectors_in_bytes": 0, "knn_vectors": "0b", "knn_vectors_in_bytes": 0 }, "context": { "total": "28.6mb", "total_in_bytes": 30060405, "inverted_index": { "total": "22mb", "total_in_bytes": 23090908 }, "stored_fields": "0b", "stored_fields_in_bytes": 0, "doc_values": "0b", "doc_values_in_bytes": 0, "points": "0b", "points_in_bytes": 0, "norms": "2.3kb", "norms_in_bytes": 2356, "term_vectors": "2.2kb", "term_vectors_in_bytes": 2310, "knn_vectors": "0b", "knn_vectors_in_bytes": 0 }, "context.keyword": {...}, "message": {...}, "message.keyword": {...} } }}The total disk space used by the shards analyzed by the API. By default, only primary shards are analyzed.
The total disk space used by all fields in the analyzed shards. This total is usually smaller than the
store_sizeannotated in <1>, because the API ignores some metadata files.The disk space used by
_idfield values for direct document retrieval. This storage enablesgetting a document by its ID, without needing to search the inverted index.The disk space used by the
_sourcefield. As stored fields are storedtogether in a compressed format, the sizes of stored fields areestimates and can be inaccurate. The stored size of the_idfieldis likely underestimated while the_sourcefield is overestimated.