› › ›

API получения схемы

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

GET /my-index-000001/_mapping

До версии 7.0.0 определение mappings включало имя типа. Хотя схемы в ответах по умолчанию больше не содержат имени типа, вы всё ещё можете запросить старый формат с помощью параметра include_type_name. Подробнее см. Удаление типов схемы.

Запрос

GET /_mapping

GET /<target>/_mapping

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

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

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

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

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

allow_no_indices

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

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

expand_wildcards

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

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

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

include_type_name

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

ignore_unavailable

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

local

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

master_timeout

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

Примеры

Несколько потоков данных и индексов

API получения схемы можно использовать для получения более одного потока данных или индекса с помощью одного вызова. Общее использование API имеет следующий синтаксис: host:port/<target>/_mapping, где <target> может принимать список имен, разделенных запятыми. Чтобы получить схемы всех потоков данных и индексов в кластере, используйте _all или * для <target> или опустите параметр <target>. Ниже приведены некоторые примеры:

GET /my-index-000001,my-index-000002/_mapping

Если вы хотите получить схемы всех индексов в кластере, следующие примеры эквивалентны:

GET /*/_mapping

GET /_all/_mapping

GET /_mapping

© 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-get-mapping.html