Get node information
- GET /_nodes/{node_id}/{metric}
- GET /_nodes/{node_id}
- GET /_nodes/{metric}
- GET /_nodes
By default, the API returns all attributes and core settings for cluster nodes.
Path Parameters
-
node_idNodeId | NodeIdoptional -
Comma-separated list of node IDs or names used to limit returned information.
Leave it out to use
/_nodes. -
metricstring | stringoptional -
Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.
Leave it out to use
/_nodes.
Query Parameters
-
flat_settingsboolean · default: false If true, returns settings in flat format.
-
timeoutstring Duration · default: 30s Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Response
-
_nodesNodeStatistics -
Contains statistics about the number of nodes selected by the request’s node filters.
-
failuresErrorCause -
typestringrequired -
The type of error
-
reasonstringnullable -
A human-readable explanation of the error, in English.
-
stack_tracestring -
The server stack trace. Present only if the
error_trace=trueparameter was sent with the request. -
caused_byErrorCause -
root_causeErrorCause -
suppressedErrorCause -
totalnumberrequired -
Total number of nodes selected by the request.
-
successfulnumberrequired -
Number of nodes that responded successfully to the request.
-
failednumberrequired -
Number of nodes that rejected the request or failed to respond. If this value is not 0, a reason for the rejection or failure is included in the response.
-
cluster_namestring Namerequired -
nodesmap string to NodeInforequired -
<string>NodeInfo -
attributesmap string to stringrequired -
build_flavorstringrequired -
build_hashstringrequired -
Short hash of the last git commit in this release.
-
build_typestringrequired -
component_versionsmap string to numberrequired -
hoststringrequired -
The node’s host name.
-
httpNodeInfoHttp -
bound_addressstringrequired -
max_content_lengthnumber | string ByteSize -
max_content_length_in_bytesnumberrequired -
publish_addressstringrequired -
index_versionnumber VersionNumberrequired -
ipstringrequired -
The node’s IP address.
-
jvmNodeJvmInfo -
gc_collectorsstringrequired -
memNodeInfoJvmMemoryrequired -
direct_maxnumber | string ByteSize -
direct_max_in_bytesnumberrequired -
heap_initnumber | string ByteSize -
heap_init_in_bytesnumberrequired -
heap_maxnumber | string ByteSize -
heap_max_in_bytesnumberrequired -
non_heap_initnumber | string ByteSize -
non_heap_init_in_bytesnumberrequired -
non_heap_maxnumber | string ByteSize -
non_heap_max_in_bytesnumberrequired -
memory_poolsstringrequired -
pidnumberrequired -
start_time_in_millisEpochTimeUnitMillisrequired -
versionstringrequired -
vm_namestring Namerequired -
vm_vendorstringrequired -
vm_versionstringrequired -
using_bundled_jdkbooleanrequired -
using_compressed_ordinary_object_pointersboolean | string -
input_argumentsstringrequired -
namestring Namerequired -
The node's name
-
osNodeOperatingSystemInfo -
archstringrequired -
Name of the JVM architecture (ex: amd64, x86)
-
available_processorsnumberrequired -
Number of processors available to the Java virtual machine
-
allocated_processorsnumber -
The number of processors actually used to calculate thread pool size. This number can be set with the node.processors setting of a node and defaults to the number of processors reported by the OS.
-
namestring Namerequired -
Name of the operating system (ex: Linux, Windows, Mac OS X)
-
pretty_namestring Namerequired -
refresh_interval_in_millisDurationValueUnitMillisrequired -
Refresh interval for the OS statistics
-
versionstringrequired -
Version of the operating system
-
cpuNodeInfoOSCPU -
cache_sizestringrequired -
cache_size_in_bytesnumberrequired -
cores_per_socketnumberrequired -
mhznumberrequired -
modelstringrequired -
total_coresnumberrequired -
total_socketsnumberrequired -
vendorstringrequired -
memNodeInfoMemory -
totalstringrequired -
total_in_bytesnumberrequired -
swapNodeInfoMemory -
totalstringrequired -
total_in_bytesnumberrequired -
pluginsPluginStats -
classnamestringrequired -
descriptionstringrequired -
elasticsearch_versionstringrequired -
extended_pluginsstringrequired -
has_native_controllerbooleanrequired -
java_versionstringrequired -
namestring Namerequired -
versionstringrequired -
licensedbooleanrequired -
processNodeProcessInfo -
idnumberrequired -
Process identifier (PID)
-
mlockallbooleanrequired -
Indicates if the process address space has been successfully locked in memory
-
refresh_interval_in_millisDurationValueUnitMillisrequired -
Refresh interval for the process statistics
-
rolesNodeRolesrequired -
Values:
masterdatadata_colddata_contentdata_frozendata_hotdata_warmclientingestmlvoting_onlytransformremote_cluster_clientcoordinating_only -
settingsNodeInfoSettings -
clusterNodeInfoSettingsClusterrequired -
namestring Namerequired -
routingIndexRouting -
allocationIndexRoutingAllocation -
enableIndexRoutingAllocationOptions -
Values:
allprimariesnew_primariesnone -
includeIndexRoutingAllocationInclude -
_tier_preferencestring -
_idstring Id -
initial_recoveryIndexRoutingAllocationInitialRecovery -
_idstring Id -
diskIndexRoutingAllocationDisk -
threshold_enabledboolean | string -
initial_master_nodesstring | string -
deprecation_indexingDeprecationIndexing -
enabledboolean | stringrequired -
nodeNodeInfoSettingsNoderequired -
namestring Namerequired -
attrmap string to objectrequired -
max_local_storage_nodesstring -
repositoriesNodeInfoRepositories -
urlNodeInfoRepositoriesUrlrequired -
allowed_urlsstringrequired -
discoveryNodeInfoDiscover -
seed_hostsstring | string -
typestring -
seed_providersstring | string -
actionNodeInfoAction -
destructive_requires_namestringrequired -
httpNodeInfoSettingsHttprequired -
type.defaultstring -
compressionboolean | string -
portnumber | string -
bootstrapNodeInfoBootstrap -
memory_lockstringrequired -
transportNodeInfoSettingsTransportrequired -
type.defaultstring -
xpackNodeInfoXpack -
licenseNodeInfoXpackLicense -
self_generatedNodeInfoXpackLicenseTyperequired -
typestringrequired -
securityNodeInfoXpackSecurityrequired -
notificationmap string to object -
mlNodeInfoXpackMl -
use_auto_machine_memory_percentboolean -
scriptNodeInfoScript -
allowed_typesstringrequired -
ingestNodeInfoSettingsIngest -
attachmentNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
appendNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
csvNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
convertNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
dateNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
date_index_nameNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
dot_expanderNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
enrichNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
failNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
foreachNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
jsonNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
user_agentNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
kvNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
geoipNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
grokNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
gsubNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
joinNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
lowercaseNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
removeNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
renameNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
scriptNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
setNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
sortNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
splitNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
trimNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
uppercaseNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
urldecodeNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
bytesNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
dissectNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
set_security_userNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
pipelineNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
dropNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
circleNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
inferenceNodeInfoIngestInfo -
downloaderNodeInfoIngestDownloaderrequired -
enabledstringrequired -
thread_poolmap string to NodeThreadPoolInfo -
<string>NodeThreadPoolInfo -
corenumber -
keep_alivestring Duration -
maxnumber -
queue_sizenumberrequired -
sizenumber -
typestringrequired -
total_indexing_buffernumber -
Total heap allowed to be used to hold recently indexed documents before they must be written to disk. This size is a shared pool across all shards on this node, and is controlled by Indexing Buffer settings.
-
total_indexing_buffer_in_bytesnumber | string ByteSize -
Same as total_indexing_buffer, but expressed in bytes.
-
transportNodeInfoTransport -
bound_addressstringrequired -
publish_addressstringrequired -
profilesmap string to stringrequired -
transport_addressstringrequired -
Host and port where transport HTTP connections are accepted.
-
transport_versionnumber VersionNumberrequired -
versionstringrequired -
Elasticsearch version running on this node.
-
modulesPluginStats -
classnamestringrequired -
descriptionstringrequired -
elasticsearch_versionstringrequired -
extended_pluginsstringrequired -
has_native_controllerbooleanrequired -
java_versionstringrequired -
namestring Namerequired -
versionstringrequired -
licensedbooleanrequired -
ingestNodeInfoIngest -
processorsNodeInfoIngestProcessorrequired -
typestringrequired -
aggregationsmap string to NodeInfoAggregation -
<string>NodeInfoAggregation -
typesstringrequired -
remote_cluster_serverRemoveClusterServer -
bound_addressstringrequired -
publish_addressstringrequired