インデックスAPIの取得
1つ以上のインデックスに関する情報を返します。データストリームの場合、APIはストリームのバックインデックスに関する情報を返します。
Python
resp = client.indices.get(
index="my-index-000001",
)
print(resp)
Ruby
response = client.indices.get(
index: 'my-index-000001'
)
puts response
Js
const response = await client.indices.get({
index: "my-index-000001",
});
console.log(response);
コンソール
GET /my-index-000001
リクエスト
GET /<target>
前提条件
- 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
です。
features
- (オプション、文字列)特定のインデックス機能に関する情報を返します。カンマ区切りの値をサポートします。有効な値は
aliases
、mappings
、およびsettings
です。デフォルトはaliases,mappings,settings
です。 flat_settings
- (オプション、ブール値)
true
の場合、フラット形式で設定を返します。デフォルトはfalse
です。 include_defaults
- (オプション、ブール値)
true
の場合、レスポンスにすべてのデフォルト設定を返します。デフォルトはfalse
です。 ignore_unavailable
- (オプション、ブール値)
false
の場合、欠落しているインデックスを対象とするリクエストはエラーを返します。デフォルトはfalse
です。 local
- (オプション、ブール値)
true
の場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalse
で、マスターノードから情報を取得します。 master_timeout
- (オプション、時間単位)マスターノードを待機する期間。マスターノードがタイムアウトが切れる前に利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは
30s
です。-1
に設定することもでき、リクエストがタイムアウトしないことを示します。