私のブックマーク
ブックマークを追加
ブックマークを削除cat nodes API
cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、nodes info APIを使用してください。
クラスターのノードに関する情報を返します。
Request
GET /_cat/nodes
Prerequisites
- Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するには
monitorまたはmanageクラスター権限が必要です。
Query parameters
bytes- (オプション、バイトサイズ単位) バイト値を表示するために使用される単位。
format- (オプション、文字列) HTTP accept headerの短縮版。 有効な値にはJSON、YAMLなどが含まれます。
full_id- (オプション、ブール値)
trueの場合、完全なノードIDを返します。falseの場合、短縮されたノードIDを返します。 デフォルトはfalseです。 h- (オプション、文字列) 表示する列名のカンマ区切りリスト。
列を指定しない場合、APIは以下にリストされたデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみを返します。
有効な列は：ip,i- (デフォルト) IPアドレス、例えば
127.0.1.1。 heap.percent,hp,heapPercent- (デフォルト) 割り当てられたElasticsearch JVMヒープの合計使用率、例えば
7。 これは、オペレーティングシステム内で実行されているElasticsearchプロセスのみを反映し、そのJVM/ヒープ/メモリリソースのパフォーマンスの最も直接的な指標です。 heap.max,hm,heapMax- 合計ヒープ、例えば
4gb。 ram.percent,rp,ramPercent- (デフォルト) オペレーティングシステムのメモリの合計使用率、例えば
47。 これは、Elasticsearchだけでなくオペレーティングシステム上で実行されているすべてのプロセスを反映し、そのパフォーマンスと相関することは保証されません。 file_desc.percent,fdp,fileDescriptorPercent- 使用されているファイルディスクリプタの割合、例えば
1。 node.role,r,role,nodeRole- (デフォルト) ノードの役割。 返される値には
c(コールドノード)、d(データノード)、f(フローズンノード)、h(ホットノード)、i(インジェストノード)、l(機械学習ノード)、m(マスター候補ノード)、r(リモートクラスタークライアントノード)、s(コンテンツノード)、t(変換ノード)、v(投票専用ノード)、w(ウォームノード)、および-(コーディネートノードのみ)が含まれます。
例えば、dimはマスター候補のデータおよびインジェストノードを示します。 ノードを参照してください。 master,m- (デフォルト) ノードが選出されたマスターノードであるかどうかを示します。 返される値には
*(選出されたマスター)と-(選出されていないマスター)が含まれます。 name,n- (デフォルト) ノード名、例えば
I8hydUG。 id,nodeId- ノードのID、例えば
k0zy。 pid,p- プロセスID、例えば
13061。 port,po- バウンドトランスポートポート、例えば
9300。 http_address,http- バウンドHTTPアドレス、例えば
127.0.0.1:9200。 version,v- Elasticsearchのバージョン、例えば8.15.2。
build,b- Elasticsearchのビルドハッシュ、例えば
5c03844。 jdk,j- Javaのバージョン、例えば
1.8.0。 disk.total,dt,diskTotal- 合計ディスクスペース、例えば
458.3gb。 disk.used,du,diskUsed- 使用されているディスクスペース、例えば
259.8gb。 disk.avail,d,disk,diskAvail- 利用可能なディスクスペース、例えば
198.4gb。 disk.used_percent,dup,diskUsedPercent- 使用されているディスクスペースの割合、例えば
47。 heap.current,hc,heapCurrent- 使用されているヒープ、例えば
311.2mb。 ram.current,rc,ramCurrent- 使用されている合計メモリ、例えば
513.4mb。 ram.max,rm,ramMax- 合計メモリ、例えば
2.9gb。 file_desc.current,fdc,fileDescriptorCurrent- 使用されているファイルディスクリプタ、例えば
123。 file_desc.max,fdm,fileDescriptorMax- 最大ファイルディスクリプタ数、例えば
1024。 cpu- (デフォルト) 最近のシステムCPU使用率のパーセント、例えば
12。 load_1m,l- (デフォルト) 最も最近の負荷平均、例えば
0.22。 load_5m,l- (デフォルト) 過去5分間の負荷平均、例えば
0.78。 load_15m,l- (デフォルト) 過去15分間の負荷平均、例えば
1.24。 uptime,u- ノードの稼働時間、例えば
17.3m。 completion.size,cs,completionSize- 完了サイズ、例えば
0b。 fielddata.memory_size,fm,fielddataMemory- 使用されているフィールドデータキャッシュメモリ、例えば
0b。 fielddata.evictions,fe,fielddataEvictions- フィールドデータキャッシュの排出、例えば
0。 query_cache.memory_size,qcm,queryCacheMemory- 使用されているクエリキャッシュメモリ、例えば
0b。 query_cache.evictions,qce,queryCacheEvictions- クエリキャッシュの排出、例えば
0。 query_cache.hit_count,qchc,queryCacheHitCount- クエリキャッシュヒット数、例えば
0。 query_cache.miss_count,qcmc,queryCacheMissCount- クエリキャッシュミス数、例えば
0。 request_cache.memory_size,rcm,requestCacheMemory- 使用されているリクエストキャッシュメモリ、例えば
0b。 request_cache.evictions,rce,requestCacheEvictions- リクエストキャッシュの排出、例えば
0。 request_cache.hit_count,rchc,requestCacheHitCount- リクエストキャッシュヒット数、例えば
0。 request_cache.miss_count,rcmc,requestCacheMissCount- リクエストキャッシュミス数、例えば
0。 flush.total,ft,flushTotal- フラッシュの数、例えば
1。 flush.total_time,ftt,flushTotalTime- フラッシュにかかった時間、例えば
1。 get.current,gc,getCurrent- 現在の取得操作の数、例えば
0。 get.time,gti,getTime- 取得にかかった時間、例えば
14ms。 get.total,gto,getTotal- 取得操作の数、例えば
2。 get.exists_time,geti,getExistsTime- 成功した取得にかかった時間、例えば
14ms。 get.exists_total,geto,getExistsTotal- 成功した取得操作の数、例えば
2。 get.missing_time,gmti,getMissingTime- 失敗した取得にかかった時間、例えば
0s。 get.missing_total,gmto,getMissingTotal- 失敗した取得操作の数、例えば
1。 indexing.delete_current,idc,indexingDeleteCurrent- 現在の削除操作の数、例えば
0。 indexing.delete_time,idti,indexingDeleteTime- 削除にかかった時間、例えば
2ms。 indexing.delete_total,idto,indexingDeleteTotal- 削除操作の数、例えば
2。 indexing.index_current,iic,indexingIndexCurrent- 現在のインデックス操作の数、例えば
0。 indexing.index_time,iiti,indexingIndexTime- インデックスにかかった時間、例えば
134ms。 indexing.index_total,iito,indexingIndexTotal- インデックス操作の数、例えば
1。 indexing.index_failed,iif,indexingIndexFailed- 失敗したインデックス操作の数、例えば
0。 merges.current,mc,mergesCurrent- 現在のマージ操作の数、例えば
0。 merges.current_docs,mcd,mergesCurrentDocs- 現在のマージドキュメントの数、例えば
0。 merges.current_size,mcs,mergesCurrentSize- 現在のマージのサイズ、例えば
0b。 merges.total,mt,mergesTotal- 完了したマージ操作の数、例えば
0。 merges.total_docs,mtd,mergesTotalDocs- マージされたドキュメントの数、例えば
0。 merges.total_size,mts,mergesTotalSize- 現在のマージのサイズ、例えば
0b。 merges.total_time,mtt,mergesTotalTime- ドキュメントのマージにかかった時間、例えば
0s。 refresh.total,rto,refreshTotal- リフレッシュの数、例えば
16。 refresh.time,rti,refreshTime- リフレッシュにかかった時間、例えば
91ms。 script.compilations,scrcc,scriptCompilations- 合計スクリプトコンパイル数、例えば
17。 script.cache_evictions,scrce,scriptCacheEvictions- キャッシュから排出された合計コンパイル済みスクリプト、例えば
6。 search.fetch_current,sfc,searchFetchCurrent- 現在のフェッチフェーズ操作の数、例えば
0。 search.fetch_time,sfti,searchFetchTime- フェッチフェーズにかかった時間、例えば
37ms。 search.fetch_total,sfto,searchFetchTotal- フェッチ操作の数、例えば
7。 search.open_contexts,so,searchOpenContexts- オープン検索コンテキスト、例えば
0。 search.query_current,sqc,searchQueryCurrent- 現在のクエリフェーズ操作の数、例えば
0。 search.query_time,sqti,searchQueryTime- クエリフェーズにかかった時間、例えば
43ms。 search.query_total,sqto,searchQueryTotal- クエリ操作の数、例えば
9。 search.scroll_current,scc,searchScrollCurrent- オープンスクロールコンテキスト、例えば
2。 search.scroll_time,scti,searchScrollTime- スクロールコンテキストがオープンに保持されている時間、例えば
2m。 search.scroll_total,scto,searchScrollTotal- 完了したスクロールコンテキスト、例えば
1。 segments.count,sc,segmentsCount- セグメントの数、例えば
4。 segments.memory,sm,segmentsMemory- セグメントによって使用されるメモリ、例えば
1.4kb。 segments.index_writer_memory,siwm,segmentsIndexWriterMemory- インデックスライターによって使用されるメモリ、例えば
18mb。 segments.version_map_memory,svmm,segmentsVersionMapMemory- バージョンマップによって使用されるメモリ、例えば
1.0kb。 segments.fixed_bitset_memory,sfbm,fixedBitsetMemoryjoinフィールドで参照されるネストされたオブジェクトフィールドタイプおよびタイプフィルターのための固定ビットセットによって使用されるメモリ、例えば1.0kb。suggest.current,suc,suggestCurrent- 現在のサジェスト操作の数、例えば
0。 suggest.time,suti,suggestTime- サジェストにかかった時間、例えば
0。 suggest.total,suto,suggestTotal- サジェスト操作の数、例えば
0。 shard_stats.total_count,sstc,shards,shardStatsTotalCount- 割り当てられたシャードの数。
mappings.total_count,mtc,mappingsTotalCount- マッピングの数、ランタイムおよびオブジェクトフィールドを含む。
mappings.total_estimated_overhead_in_bytes,mteo,mappingsTotalEstimatedOverheadInBytes- このノードのマッピングの推定ヒープオーバーヘッド（バイト単位）、マッピングされたフィールドごとに1KiBのヒープを許可します。
help- (オプション、ブール値)
trueの場合、レスポンスにはヘルプ情報が含まれます。 デフォルトはfalseです。 master_timeout- (オプション、時間単位) マスターノードを待機する期間。 タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーが返されます。 デフォルトは
30sです。 リクエストがタイムアウトしないことを示すために-1に設定することもできます。 s- (オプション、文字列) レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
time- (オプション、時間単位) 時間値を表示するために使用される単位。
v- (オプション、ブール値)
trueの場合、レスポンスには列見出しが含まれます。 デフォルトはfalseです。 include_unloaded_segments- (オプション、ブール値)
trueの場合、レスポンスにはメモリにロードされていないセグメントの情報が含まれます。 デフォルトはfalseです。
Examples
Example with default columns
Python
resp = client.cat.nodes(v=True,)print(resp)
Ruby
response = client.cat.nodes(v: true)puts response
Js
const response = await client.cat.nodes({v: "true",});console.log(response);
Console
GET /_cat/nodes?v=true
APIは以下のレスポンスを返します：
Txt
ip heap.percent ram.percent cpu load_1m load_5m load_15m node.role master name127.0.0.1 65 99 42 3.07 dim * mJw06l1
`````node.role`````、`````master`````、`````name`````列は、特に大規模なクラスター全体を監視するのに役立つ情報を提供します。### Example with explicit columns次のAPIリクエストは、`````id`````、`````ip`````、`````port`````、`````v````` (バージョン)、および`````m````` (マスター)列を返します。#### Python``````pythonresp = client.cat.nodes(v=True,h="id,ip,port,v,m",)print(resp)`
Ruby
response = client.cat.nodes(v: true,h: 'id,ip,port,v,m')puts response
Js
const response = await client.cat.nodes({v: "true",h: "id,ip,port,v,m",});console.log(response);
Console
GET /_cat/nodes?v=true&h=id,ip,port,v,m
APIは以下のレスポンスを返します：
Txt
id ip port v mveJR 127.0.0.1 59938 8.15.2 *
