› › ›

API получения отображения

Получает определения отображения для одного или нескольких индексов. Для потоков данных API получает отображения для базовых индексов потока.

resp = client.indices.get_mapping(
    index="my-index-000001",
)
print(resp)

response = client.indices.get_mapping(
  index: 'my-index-000001'
)
puts response

res, err := es.Indices.GetMapping(es.Indices.GetMapping.WithIndex("my-index-000001"))
fmt.Println(res, err)

const response = await client.indices.getMapping({
  index: "my-index-000001",
});
console.log(response);

GET /my-index-000001/_mapping

Запрос

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.

ignore_unavailable

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

local

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

master_timeout

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

Примеры

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

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

resp = client.indices.get_mapping(
    index="my-index-000001,my-index-000002",
)
print(resp)

response = client.indices.get_mapping(
  index: 'my-index-000001,my-index-000002'
)
puts response

const response = await client.indices.getMapping({
  index: "my-index-000001,my-index-000002",
});
console.log(response);

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

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

$params = [
    'index' => '*',
];
$response = $client->indices()->getMapping($params);
$params = [
    'index' => '_all',
];
$response = $client->indices()->getMapping($params);
$response = $client->indices()->getMapping();

resp = client.indices.get_mapping(
    index="*",
)
print(resp)

resp1 = client.indices.get_mapping(
    index="_all",
)
print(resp1)

resp2 = client.indices.get_mapping()
print(resp2)

response = client.indices.get_mapping(
  index: '*'
)
puts response

response = client.indices.get_mapping(
  index: '_all'
)
puts response

response = client.indices.get_mapping
puts response

{
	res, err := es.Indices.GetMapping(es.Indices.GetMapping.WithIndex("*"))
	fmt.Println(res, err)
}

{
	res, err := es.Indices.GetMapping(es.Indices.GetMapping.WithIndex("_all"))
	fmt.Println(res, err)
}

{
	res, err := es.Indices.GetMapping()
	fmt.Println(res, err)
}

const response = await client.indices.getMapping({
  index: "*",
});
console.log(response);

const response1 = await client.indices.getMapping({
  index: "_all",
});
console.log(response1);

const response2 = await client.indices.getMapping();
console.log(response2);

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/8.17/indices-get-mapping.html