インデックスディスク使用量を分析（Analyze index disk usage）

インデックスディスク使用状況分析API

この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。

インデックスまたはデータストリームの各フィールドのディスク使用状況を分析します。このAPIは、以前のElasticsearchバージョンで作成されたインデックスをサポートしていない可能性があります。小さなインデックスの結果は不正確である可能性があり、インデックスの一部がAPIによって分析されない場合があります。

Python

resp = client.indices.disk_usage(
   index="my-index-000001",
   run_expensive_tasks=True,
)
print(resp)

Ruby

response = client.indices.disk_usage(
  index: 'my-index-000001',
  run_expensive_tasks: true
)
puts response

Js

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

コンソール

POST /my-index-000001/_disk_usage?run_expensive_tasks=true

リクエスト

POST /<target>/_disk_usage

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、ターゲットインデックス、データストリーム、またはエイリアスに対してmanage インデックス権限を持っている必要があります。

パスパラメータ

• <target>
• (必須、文字列) リクエストを制限するために使用されるデータストリーム、インデックス、およびエイリアスのカンマ区切りリスト。APIはリソースを大幅に消費するため、単一のインデックス（またはデータストリームの最新のバックインデックス）でこのAPIを実行することをお勧めします。

クエリパラメータ

• allow_no_indices
• （オプション、ブール値）falseの場合、リクエストは、ワイルドカード式、インデックスエイリアス、または_all値が欠落または閉じたインデックスのみをターゲットにする場合にエラーを返します。この動作は、リクエストが他のオープンインデックスをターゲットにしている場合でも適用されます。たとえば、foo*,bar*をターゲットにするリクエストは、fooで始まるインデックスがあるがbarで始まるインデックスがない場合にエラーを返します。
  デフォルトはtrueです。
• expand_wildcards
• （オプション、文字列）ワイルドカードパターンが一致できるインデックスのタイプ。リクエストがデータストリームをターゲットにできる場合、この引数はワイルドカード式が隠されたデータストリームと一致するかどうかを決定します。カンマ区切りの値をサポートし、open,hiddenのように指定できます。有効な値は：
  • all
  • すべてのデータストリームまたはインデックスに一致します。隠されたものも含まれます。隠されたもの。
  • open
  • オープンで非隠されたインデックスに一致します。また、非隠されたデータストリームにも一致します。
  • closed
  • 閉じた非隠されたインデックスに一致します。また、非隠されたデータストリームにも一致します。データストリームは閉じることができません。
  • hidden
  • 隠されたデータストリームと隠されたインデックスに一致します。open、closed、またはその両方と組み合わせる必要があります。
  • none
  • ワイルドカードパターンは受け入れられません。
    デフォルトはopenです。
• flush
• (オプション、ブール値) trueの場合、APIは分析の前にフラッシュを実行します。falseの場合、応答には未コミットのデータが含まれない可能性があります。デフォルトはtrueです。
• ignore_unavailable
• （オプション、ブール値）falseの場合、リクエストは欠落または閉じたインデックスをターゲットにする場合にエラーを返します。デフォルトはfalseです。
• run_expensive_tasks
• (必須、ブール値) フィールドのディスク使用状況を分析することはリソースを多く消費します。APIを使用するには、このパラメータをtrueに設定する必要があります。デフォルトはfalseです。
• wait_for_active_shards
• (オプション、文字列) 操作を進める前にアクティブでなければならないシャードコピーの数。allまたはインデックス内のシャードの総数（number_of_replicas+1）までの任意の正の整数に設定します。デフォルト: 1、プライマリシャード。
  アクティブシャードを参照してください。

例

Python

resp = client.indices.disk_usage(
   index="my-index-000001",
   run_expensive_tasks=True,
)
print(resp)

Ruby

response = client.indices.disk_usage(
  index: 'my-index-000001',
  run_expensive_tasks: true
)
puts response

Js

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

コンソール

POST /my-index-000001/_disk_usage?run_expensive_tasks=true

APIは次のように返します:

コンソール応答

{
   "_shards": {
   "total": 1,
   "successful": 1,
   "failed": 0
   },
   "my-index-000001": {
   "store_size": "929mb",
   "store_size_in_bytes": 974192723,
   "all_fields": {
   "total": "928.9mb",
   "total_in_bytes": 973977084,
   "inverted_index": {
   "total": "107.8mb",
   "total_in_bytes": 113128526
   },
   "stored_fields": "623.5mb",
   "stored_fields_in_bytes": 653819143,
   "doc_values": "125.7mb",
   "doc_values_in_bytes": 131885142,
   "points": "59.9mb",
   "points_in_bytes": 62885773,
   "norms": "2.3kb",
   "norms_in_bytes": 2356,
   "term_vectors": "2.2kb",
   "term_vectors_in_bytes": 2310,
   "knn_vectors": "0b",
   "knn_vectors_in_bytes": 0
   },
   "fields": {
   "_id": {
   "total": "49.3mb",
   "total_in_bytes": 51709993,
   "inverted_index": {
   "total": "29.7mb",
   "total_in_bytes": 31172745
   },
   "stored_fields": "19.5mb",
   "stored_fields_in_bytes": 20537248,
   "doc_values": "0b",
   "doc_values_in_bytes": 0,
   "points": "0b",
   "points_in_bytes": 0,
   "norms": "0b",
   "norms_in_bytes": 0,
   "term_vectors": "0b",
   "term_vectors_in_bytes": 0,
   "knn_vectors": "0b",
   "knn_vectors_in_bytes": 0
   },
   "_primary_term": {...},
   "_seq_no": {...},
   "_version": {...},
   "_source": {
   "total": "603.9mb",
   "total_in_bytes": 633281895,
   "inverted_index": {...},
   "stored_fields": "603.9mb",
   "stored_fields_in_bytes": 633281895,
   "doc_values": "0b",
   "doc_values_in_bytes": 0,
   "points": "0b",
   "points_in_bytes": 0,
   "norms": "0b",
   "norms_in_bytes": 0,
   "term_vectors": "0b",
   "term_vectors_in_bytes": 0,
   "knn_vectors": "0b",
   "knn_vectors_in_bytes": 0
   },
   "context": {
   "total": "28.6mb",
   "total_in_bytes": 30060405,
   "inverted_index": {
   "total": "22mb",
   "total_in_bytes": 23090908
   },
   "stored_fields": "0b",
   "stored_fields_in_bytes": 0,
   "doc_values": "0b",
   "doc_values_in_bytes": 0,
   "points": "0b",
   "points_in_bytes": 0,
   "norms": "2.3kb",
   "norms_in_bytes": 2356,
   "term_vectors": "2.2kb",
   "term_vectors_in_bytes": 2310,
   "knn_vectors": "0b",
   "knn_vectors_in_bytes": 0
   },
   "context.keyword": {...},
   "message": {...},
   "message.keyword": {...}
   }
   }
}