› › ›

API разрешения индекса

Разрешает указанные имя(а) и/или шаблоны индексов для индексов, алиасов и потоков данных. Поддерживаются несколько шаблонов и удаленные кластеры.

resp = client.indices.resolve_index(
    name="my-index-*",
)
print(resp)

response = client.indices.resolve_index(
  name: 'my-index-*'
)
puts response

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

GET /_resolve/index/my-index-*

Запрос

GET /_resolve/index/<name>

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

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

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

<name>: (Обязательный, строка) Запятая-разделенный(ые) имя(а) или шаблон(ы) индексов индексов, алиасов и потоков данных для разрешения, с использованием синтаксиса нескольких целей. Ресурсы на удаленных кластерах могут быть указаны с использованием синтаксиса <cluster>:<name>.

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

expand_wildcards

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

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

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

ignore_unavailable

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

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

allow_no_indices

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

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

ignore_throttled

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

[7.16.0] Устарело в 7.16.0.

Примеры

resp = client.indices.resolve_index(
    name="f*,remoteCluster1:bar*",
    expand_wildcards="all",
)
print(resp)

response = client.indices.resolve_index(
  name: 'f*,remoteCluster1:bar*',
  expand_wildcards: 'all'
)
puts response

const response = await client.indices.resolveIndex({
  name: "f*,remoteCluster1:bar*",
  expand_wildcards: "all",
});
console.log(response);

GET /_resolve/index/f*,remoteCluster1:bar*?expand_wildcards=all

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

{
  "indices": [                                 
    {
      "name": "foo_closed",
      "attributes": [
        "closed"                               
      ]
    },
    {
      "name": "freeze-index",
      "aliases": [
        "f-alias"
      ],
      "attributes": [
        "open"
      ]
    },
    {
      "name": "remoteCluster1:bar-01",
      "attributes": [
        "open"
      ]
    }
  ],
  "aliases": [                                 
    {
      "name": "f-alias",
      "indices": [
        "freeze-index",
        "my-index-000001"
      ]
    }
  ],
  "data_streams": [                            
    {
      "name": "foo",
      "backing_indices": [
        ".ds-foo-2099.03.07-000001"
      ],
      "timestamp_field": "@timestamp"
    }
  ]
}

	Все индексы, соответствующие указанным именам или выражениям
	Возможные атрибуты индекса — `open`, `closed`, `hidden`, `system` и `frozen`
	Все алиасы, соответствующие указанным именам или выражениям
	Все потоки данных, соответствующие указанным именам или выражениям

© 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-resolve-index-api.html