› › ›

API анализа использования диска индексом

Данная функциональность находится в техническом превью и может быть изменена или удалена в будущих релизах. Elastic будет работать над устранением любых проблем, но функции в техническом превью не подпадают под SLA поддержки официальных функций GA.

Анализирует использование диска каждым полем индекса или потока данных. Этот API может не поддерживать индексы, созданные в предыдущих версиях Elasticsearch. Результат для небольшого индекса может быть неточным, так как некоторые части индекса могут не быть проанализированы API.

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

Запрос

POST /<target>/_disk_usage

Предварительные условия

Если включены функции безопасности Elasticsearch, у вас должен быть manage доступ к индексу для целевого индекса, потока данных или алиаса.

Параметры пути

<target>: (Обязательный, строка) Список потоков данных, индексов и алиасов, разделенных запятыми, используемых для ограничения запроса. Рекомендуется выполнять этот API с одним индексом (или последним поддерживающим индексом потока данных), так как API потребляет значительные ресурсы.

Параметры запроса

allow_no_indices

(Необязательный, булево) Если false, запрос возвращает ошибку, если какие-либо выражения с подстановкой, алиас индекса или _all значение указывают только на отсутствующие или закрытые индексы. Это поведение действует даже если запрос направлен на другие открытые индексы. Например, запрос, направленный на foo*,bar*, возвращает ошибку, если индекс начинается с foo, но индекс, начинающийся с bar, отсутствует.

По умолчанию true.

expand_wildcards

(Необязательный, строка) Тип индекса, с которым могут совпадать шаблоны с подстановкой. Если запрос может направляться на потоки данных, этот аргумент определяет, соответствуют ли выражения с подстановкой скрытым потокам данных. Поддерживает значения, разделенные запятыми, такие как open,hidden. Допустимые значения:

all: Соответствует любому потоку данных или индексу, включая скрытые.
open: Соответствует открытым индексам, не скрытым. Также соответствует любому нескрытому потоку данных.
closed: Соответствует закрытым индексам, не скрытым. Также соответствует любому нескрытому потоку данных. Потоки данных не могут быть закрыты.
hidden: Соответствует скрытым потокам данных и скрытым индексам. Должен быть объединен с open, closed или обоими.
none: Шаблоны с подстановкой не принимаются.

По умолчанию open.

flush

(Необязательный, булево) Если true, API выполняет сброс перед анализом. Если false, ответ может не включать несохраненные данные. По умолчанию true.

ignore_unavailable

(Необязательный, булево) Если false, запрос возвращает ошибку, если он обращается к отсутствующему или закрытому индексу. По умолчанию false.

run_expensive_tasks

(Обязательный, булево) Анализ использования диска поля индекса ресурсоемкий. Для использования API этот параметр должен быть установлен в true. По умолчанию false.

wait_for_active_shards

(Необязательный, строка) Количество копий фрагментов, которые должны быть активными перед продолжением операции. Установите в all или любое положительное целое число до общего количества фрагментов в индексе (number_of_replicas+1). По умолчанию: 1, основной фрагмент.

См. Активные фрагменты.

Примеры

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

API возвращает:

{
    "_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
        },
        "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
            },
            "_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
            },
            "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
            },
            "context.keyword": {...},
            "message": {...},
            "message.keyword": {...}
        }
    }
}

	Размер хранилища только проанализированных фрагментов индекса.
	Общий размер полей проанализированных фрагментов индекса. Эта сумма обычно меньше размера индекса, указанного в <1>, так как некоторые небольшие метаданные игнорируются, и некоторые части файлов данных могут не быть просканированы API.
	Хранимый размер поля `_id`
	Хранимый размер поля `_source`. Поскольку хранимые поля хранятся вместе в сжатом формате, оценки размеров хранимых полей являются приближенными и могут быть неточными. Хранимый размер поля `_id`, вероятно, недооценен, а хранимый размер поля `_source`, вероятно, переоценен.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/indices-disk-usage.html