インデックスを解決（Resolve index）

インデックス API の解決

指定された名前またはインデックスパターンをインデックス、エイリアス、およびデータストリームに対して解決します。複数のパターンとリモートクラスターがサポートされています。

Python

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

Ruby

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

Js

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 で非推奨。

例

Python

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

Ruby

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

Js

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"
   }
  ]
}