Get node information
Added in 1.3.0
By default, the API returns all attributes and core settings for cluster nodes.
Query parameters
-
flat_settings
boolean If true, returns settings in flat format.
-
timeout
string Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Responses
-
200 application/json
Hide response attributes Show response attributes object
-
_nodes
object Additional properties are allowed.
Hide _nodes attributes Show _nodes attributes object
-
failures
array[object] Hide failures attributes Show failures attributes object
-
type
string Required The type of error
-
reason
string A human-readable explanation of the error, in English.
-
stack_trace
string The server stack trace. Present only if the
error_trace=true
parameter was sent with the request. -
caused_by
object Additional properties are allowed.
-
root_cause
array[object] Additional properties are allowed.
-
suppressed
array[object] Additional properties are allowed.
-
-
total
number Required Total number of nodes selected by the request.
-
successful
number Required Number of nodes that responded successfully to the request.
-
failed
number Required 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_name
string Required -
nodes
object Required Hide nodes attribute Show nodes attribute object
-
*
object Additional properties Additional properties are allowed.
Hide * attributes Show * attributes object
-
attributes
object Required Hide attributes attribute Show attributes attribute object
-
*
string Additional properties
-
-
build_flavor
string Required -
build_hash
string Required Short hash of the last git commit in this release.
-
build_type
string Required -
host
string Required -
http
object Additional properties are allowed.
Hide http attributes Show http attributes object
-
bound_address
array[string] Required max_content_length
number | string -
max_content_length_in_bytes
number Required -
publish_address
string Required
-
-
ip
string Required -
jvm
object Additional properties are allowed.
Hide jvm attributes Show jvm attributes object
-
gc_collectors
array[string] Required -
mem
object Required Additional properties are allowed.
Hide mem attributes Show mem attributes object
-
direct_max_in_bytes
number Required -
heap_init_in_bytes
number Required -
heap_max_in_bytes
number Required -
non_heap_init_in_bytes
number Required -
non_heap_max_in_bytes
number Required
-
memory_pools
array[string] Required -
pid
number Required -
start_time_in_millis
number Time unit for milliseconds
-
version
string Required -
vm_name
string Required -
vm_vendor
string Required -
vm_version
string Required -
using_bundled_jdk
boolean Required using_compressed_ordinary_object_pointers
boolean | string -
input_arguments
array[string] Required
-
-
name
string Required -
network
object Additional properties are allowed.
Hide network attributes Show network attributes object
-
primary_interface
object Required Additional properties are allowed.
Hide primary_interface attributes Show primary_interface attributes object
-
address
string Required -
mac_address
string Required -
name
string Required
-
-
refresh_interval
number Required
-
-
os
object Additional properties are allowed.
Hide os attributes Show os attributes object
-
arch
string Required Name of the JVM architecture (ex: amd64, x86)
-
available_processors
number Required Number of processors available to the Java virtual machine
-
allocated_processors
number 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.
-
name
string Required -
pretty_name
string Required -
refresh_interval_in_millis
number Time unit for milliseconds
-
version
string Required -
cpu
object Additional properties are allowed.
Hide cpu attributes Show cpu attributes object
-
cache_size
string Required -
cache_size_in_bytes
number Required -
cores_per_socket
number Required -
mhz
number Required -
model
string Required -
total_cores
number Required -
total_sockets
number Required -
vendor
string Required
-
-
mem
object Additional properties are allowed.
Hide mem attributes Show mem attributes object
-
total
string Required -
total_in_bytes
number Required
-
-
swap
object Additional properties are allowed.
Hide swap attributes Show swap attributes object
-
total
string Required -
total_in_bytes
number Required
-
-
-
plugins
array[object] Hide plugins attributes Show plugins attributes object
-
classname
string Required -
description
string Required -
elasticsearch_version
string Required -
extended_plugins
array[string] Required -
has_native_controller
boolean Required -
java_version
string Required -
name
string Required -
version
string Required -
licensed
boolean Required
-
-
process
object Additional properties are allowed.
Hide process attributes Show process attributes object
-
id
number Required Process identifier (PID)
-
mlockall
boolean Required Indicates if the process address space has been successfully locked in memory
-
refresh_interval_in_millis
number Time unit for milliseconds
-
-
roles
array[string] Required - @doc_id node-roles
Values are
master
,data
,data_cold
,data_content
,data_frozen
,data_hot
,data_warm
,client
,ingest
,ml
,voting_only
,transform
,remote_cluster_client
, orcoordinating_only
. -
settings
object Additional properties are allowed.
Hide settings attributes Show settings attributes object
-
cluster
object Required Additional properties are allowed.
Hide cluster attributes Show cluster attributes object
-
name
string Required -
routing
object Additional properties are allowed.
-
election
object Required Additional properties are allowed.
-
initial_master_nodes
array[string] -
deprecation_indexing
object Additional properties are allowed.
-
-
node
object Required Additional properties are allowed.
Hide node attributes Show node attributes object
-
name
string Required -
attr
object Required -
max_local_storage_nodes
string
-
-
path
object Additional properties are allowed.
-
repositories
object Additional properties are allowed.
Hide repositories attribute Show repositories attribute object
-
url
object Required Additional properties are allowed.
-
-
discovery
object Additional properties are allowed.
Hide discovery attributes Show discovery attributes object
-
seed_hosts
array[string] -
type
string -
seed_providers
array[string]
-
-
action
object Additional properties are allowed.
Hide action attribute Show action attribute object
-
destructive_requires_name
string Required
-
-
client
object Additional properties are allowed.
Hide client attribute Show client attribute object
-
type
string Required
-
-
http
object Required Additional properties are allowed.
Hide http attributes Show http attributes object
-
type
object Required Additional properties are allowed.
-
type.default
string
-
-
bootstrap
object Additional properties are allowed.
Hide bootstrap attribute Show bootstrap attribute object
-
memory_lock
string Required
-
-
transport
object Required Additional properties are allowed.
Hide transport attributes Show transport attributes object
-
type
object Required Additional properties are allowed.
-
type.default
string -
features
object Additional properties are allowed.
-
-
network
object Additional properties are allowed.
Hide network attribute Show network attribute object
-
xpack
object Additional properties are allowed.
Hide xpack attributes Show xpack attributes object
-
license
object Additional properties are allowed.
-
security
object Required Additional properties are allowed.
-
notification
object -
ml
object Additional properties are allowed.
-
-
script
object Additional properties are allowed.
Hide script attributes Show script attributes object
-
allowed_types
string Required
-
-
search
object Additional properties are allowed.
Hide search attribute Show search attribute object
-
remote
object Required Additional properties are allowed.
-
-
ingest
object Additional properties are allowed.
Hide ingest attributes Show ingest attributes object
-
attachment
object Additional properties are allowed.
-
append
object Additional properties are allowed.
-
csv
object Additional properties are allowed.
-
convert
object Additional properties are allowed.
-
date
object Additional properties are allowed.
-
date_index_name
object Additional properties are allowed.
-
dot_expander
object Additional properties are allowed.
-
enrich
object Additional properties are allowed.
-
fail
object Additional properties are allowed.
-
foreach
object Additional properties are allowed.
-
json
object Additional properties are allowed.
-
user_agent
object Additional properties are allowed.
-
kv
object Additional properties are allowed.
-
geoip
object Additional properties are allowed.
-
grok
object Additional properties are allowed.
-
gsub
object Additional properties are allowed.
-
join
object Additional properties are allowed.
-
lowercase
object Additional properties are allowed.
-
remove
object Additional properties are allowed.
-
rename
object Additional properties are allowed.
-
script
object Additional properties are allowed.
-
set
object Additional properties are allowed.
-
sort
object Additional properties are allowed.
-
split
object Additional properties are allowed.
-
trim
object Additional properties are allowed.
-
uppercase
object Additional properties are allowed.
-
urldecode
object Additional properties are allowed.
-
bytes
object Additional properties are allowed.
-
dissect
object Additional properties are allowed.
-
set_security_user
object Additional properties are allowed.
-
pipeline
object Additional properties are allowed.
-
drop
object Additional properties are allowed.
-
circle
object Additional properties are allowed.
-
inference
object Additional properties are allowed.
-
-
-
thread_pool
object Hide thread_pool attribute Show thread_pool attribute object
-
*
object Additional properties Additional properties are allowed.
Hide * attributes Show * attributes object
-
core
number -
keep_alive
string A duration. Units can be
nanos
,micros
,ms
(milliseconds),s
(seconds),m
(minutes),h
(hours) andd
(days). Also accepts "0" without a unit and "-1" to indicate an unspecified value. -
max
number -
queue_size
number Required -
size
number -
type
string Required
-
-
-
total_indexing_buffer
number 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.
-
transport
object Additional properties are allowed.
Hide transport attributes Show transport attributes object
-
bound_address
array[string] Required -
publish_address
string Required -
profiles
object Required Hide profiles attribute Show profiles attribute object
-
*
string Additional properties
-
-
-
transport_address
string Required -
version
string Required -
modules
array[object] Hide modules attributes Show modules attributes object
-
classname
string Required -
description
string Required -
elasticsearch_version
string Required -
extended_plugins
array[string] Required -
has_native_controller
boolean Required -
java_version
string Required -
name
string Required -
version
string Required -
licensed
boolean Required
-
-
ingest
object Additional properties are allowed.
Hide ingest attribute Show ingest attribute object
-
processors
array[object] Required Additional properties are allowed.
-
-
aggregations
object
-
-
-
curl \
--request GET http://api.example.com/_nodes \
--header "Authorization: $API_KEY"
{
"_nodes": {},
"cluster_name": "elasticsearch",
"nodes": {
"USpTGYaBSIKbgSUJR2Z9lg": {
"name": "node-0",
"transport_address": "192.168.17:9300",
"host": "node-0.elastic.co",
"ip": "192.168.17",
"version": "{version}",
"transport_version": 100000298,
"index_version": 100000074,
"component_versions": {
"ml_config_version": 100000162,
"transform_config_version": 100000096
},
"build_flavor": "default",
"build_type": "{build_type}",
"build_hash": "587409e",
"roles": [
"master",
"data",
"ingest"
],
"attributes": {},
"plugins": [
{
"name": "analysis-icu",
"version": "{version}",
"description": "The ICU Analysis plugin integrates Lucene ICU
module into elasticsearch, adding ICU relates analysis components.",
"classname":
"org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin",
"has_native_controller": false
}
],
"modules": [
{
"name": "lang-painless",
"version": "{version}",
"description": "An easy, safe and fast scripting language for
Elasticsearch",
"classname": "org.elasticsearch.painless.PainlessPlugin",
"has_native_controller": false
}
]
}
}
}