› › ›

API хранилищ фрагментов индексов

Возвращает информацию о хранилищах фрагментов реплик в одном или нескольких индексах. Для потоков данных API возвращает информацию о хранилищах для базовых индексов потока.

GET /my-index-000001/_shard_stores

Запрос

GET /<target>/_shard_stores

GET /_shard_stores

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

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

Описание

API хранилищ фрагментов индексов возвращает следующую информацию:

Узел, на котором находится каждый фрагмент реплики
Идентификатор распределения для каждого фрагмента реплики
Уникальный идентификатор для каждого фрагмента реплики
Любые ошибки, возникшие при открытии индекса фрагмента или при предыдущей ошибке

По умолчанию API возвращает информацию о хранилищах только для первичных фрагментов, которые не назначены или имеют один или несколько не назначенных фрагментов реплик.

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

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

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

allow_no_indices

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

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

expand_wildcards

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

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

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

ignore_unavailable

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

status

(Необязательно, строка) Список состояний здоровья фрагментов, разделенных запятыми, используемых для ограничения запроса.

Допустимые значения включают:

green: Первичный фрагмент и все фрагменты реплики назначены.
yellow: Один или несколько фрагментов реплики не назначены.
red: Первичный фрагмент не назначен.
all: Возвращаются все фрагменты, независимо от состояния здоровья.

По умолчанию yellow,red.

Примеры

Получение информации о хранилище фрагментов для определенного потока данных или индекса

GET /test/_shard_stores

Получение информации о хранилище фрагментов для нескольких потоков данных и индексов

GET /test1,test2/_shard_stores

Получение информации о хранилище фрагментов для всех потоков данных и индексов

GET /_shard_stores

Получение информации о хранилище фрагментов на основе состояния кластера

Вы можете использовать параметр запроса status для ограничения возвращаемой информации на основе состояния фрагмента.

Следующий запрос возвращает только информацию для назначенных первичных и фрагментов реплик.

GET /_shard_stores?status=green

API возвращает следующий ответ:

{
  "indices": {
    "my-index-00001": {
      "shards": {
        "0": {                                          
          "stores": [                                   
            {
            "sPa3OgxLSYGvQ4oPs-Tajw": {                 
              "name": "node_t0",
              "ephemeral_id": "9NlXRFGCT1m8tkvYCMK-8A",
              "transport_address": "local[1]",
              "attributes": {},
              "roles": [...]
            },
            "allocation_id": "2iNySv_OQVePRX-yaRH_lQ",  
            "allocation": "primary|replica|unused"      
            "store_exception": ...                      
            }
          ]
        }
      }
    }
  }
}

	Ключ — соответствующий идентификатор фрагмента для информации о хранилище
	Список информации о хранилище для всех копий фрагмента
	Информация о узле, на котором размещена копия хранилища, ключ — уникальный идентификатор узла.
	Идентификатор распределения копии хранилища
	Состояние копии хранилища, является ли она первичной, репликой или вообще не используется
	Любое исключение, возникшее при открытии индекса фрагмента или при предыдущей ошибке движка

© 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-shards-stores.html