情報API（Info API）

情報 API

インストールされた X-Pack 機能に関する一般情報を提供します。

リクエスト

GET /_xpack

前提条件

• Elasticsearch のセキュリティ機能が有効になっている場合、この API を使用するには monitor または manage クラスター権限 が必要です。

説明

この API によって提供される情報には次のものが含まれます：

• ビルド情報 - ビルド番号とタイムスタンプを含む。
• ライセンス情報 - 現在インストールされているライセンスに関する基本情報。
• 機能情報 - 現在のライセンスの下で有効で利用可能な機能。

パスパラメータ

• categories
• (オプション、リスト) レスポンスに含める情報カテゴリのカンマ区切りリスト。例えば、build,license,features。
• human
• (オプション、ブール値) レスポンスに追加の人間可読情報が含まれるかどうかを定義します。特に、説明とタグラインが追加されます。デフォルト値は true です。

例

次の例は情報 API をクエリします：

Python

resp = client.xpack.info()
print(resp)

Ruby

response = client.xpack.info
puts response

Js

const response = await client.xpack.info();
console.log(response);

コンソール

GET /_xpack

例のレスポンス：

コンソール-結果

{
   "build" : {
   "hash" : "2798b1a3ce779b3611bb53a0082d4d741e4d3168",
   "date" : "2015-04-07T13:34:42Z"
   },
   "license" : {
   "uid" : "893361dc-9749-4997-93cb-xxx",
   "type" : "trial",
   "mode" : "trial",
   "status" : "active",
   "expiry_date_in_millis" : 1542665112332
   },
   "features" : {
   "ccr" : {
   "available" : true,
   "enabled" : true
   },
   "aggregate_metric" : {
   "available" : true,
   "enabled" : true
   },
   "analytics" : {
   "available" : true,
   "enabled" : true
   },
   "archive" : {
   "available" : true,
   "enabled" : true
   },
   "enrich" : {
   "available" : true,
   "enabled" : true
   },
   "frozen_indices" : {
   "available" : true,
   "enabled" : true
   },
   "graph" : {
   "available" : true,
   "enabled" : true
   },
   "ilm" : {
   "available" : true,
   "enabled" : true
   },
   "logstash" : {
   "available" : true,
   "enabled" : true
   },
   "ml" : {
   "available" : true,
   "enabled" : true
   },
   "esql" : {
   "available" : true,
   "enabled" : true
   },
   "monitoring" : {
   "available" : true,
   "enabled" : true
   },
   "rollup": {
   "available": true,
   "enabled": true
   },
   "searchable_snapshots" : {
   "available" : true,
   "enabled" : true
   },
   "security" : {
   "available" : true,
   "enabled" : true
   },
   "slm" : {
   "available" : true,
   "enabled" : true
   },
   "spatial" : {
   "available" : true,
   "enabled" : true
   },
   "eql" : {
   "available" : true,
   "enabled" : true
   },
   "sql" : {
   "available" : true,
   "enabled" : true
   },
   "transform" : {
   "available" : true,
   "enabled" : true
   },
   "voting_only" : {
   "available" : true,
   "enabled" : true
   },
   "watcher" : {
   "available" : true,
   "enabled" : true
   },
   "data_streams" : {
   "available" : true,
   "enabled" : true
   },
   "data_tiers" : {
   "available" : true,
   "enabled" : true
   },
   "enterprise_search": {
   "available": true,
   "enabled": true
   },
   "universal_profiling": {
   "available": true,
   "enabled": true
   }
   },
   "tagline" : "You know, for X"
}

次の例はビルドと機能情報のみを返します：

Python

resp = client.xpack.info(
   categories="build,features",
)
print(resp)

Ruby

response = client.xpack.info(
  categories: 'build,features'
)
puts response

Js

const response = await client.xpack.info({
  categories: "build,features",
});
console.log(response);

コンソール

GET /_xpack?categories=build,features

次の例はレスポンスから説明を削除します：

Python

resp = client.xpack.info(
   human=False,
)
print(resp)

Ruby

response = client.xpack.info(
  human: false
)
puts response

Js

const response = await client.xpack.info({
  human: "false",
});
console.log(response);

コンソール

GET /_xpack?human=false