Returns cluster nodes information Added in 1.3.0
Path parameters
-
Comma-separated list of node IDs or names used to limit returned information.
-
Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.
Query parameters
-
flat_settings boolean
If true, returns settings in flat format.
-
master_timeout string
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
-
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
-
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 of nodes selected by the request.
-
Number of nodes that responded successfully to the request.
-
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.
-
-
Hide nodes attribute Show nodes attribute object
-
Additional properties are allowed.
Hide * attributes Show * attributes object
-
Hide attributes attribute Show attributes attribute object
-
Short hash of the last git commit in this release.
-
http object
Additional properties are allowed.
Hide http attributes Show http attributes object
max_content_length number | string
-
jvm object
Additional properties are allowed.
Hide jvm attributes Show jvm attributes object
-
Additional properties are allowed.
Hide mem attributes Show mem attributes object
-
start_time_in_millis number
Time unit for milliseconds
using_compressed_ordinary_object_pointers boolean | string
-
network object
Additional properties are allowed.
Hide network attributes Show network attributes object
-
Additional properties are allowed.
Hide primary_interface attributes Show primary_interface attributes object
-
-
os object
Additional properties are allowed.
Hide os attributes Show os attributes object
-
Name of the JVM architecture (ex: amd64, x86)
-
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.
-
refresh_interval_in_millis number
Time unit for milliseconds
-
cpu object
Additional properties are allowed.
Hide cpu attributes Show cpu attributes object
-
mem object
Additional properties are allowed.
Hide mem attributes Show mem attributes object
-
swap object
Additional properties are allowed.
Hide swap attributes Show swap attributes object
-
-
plugins array[object]
Hide plugins attributes Show plugins attributes object
-
process object
Additional properties are allowed.
Hide process attributes Show process attributes object
-
Process identifier (PID)
-
Indicates if the process address space has been successfully locked in memory
-
refresh_interval_in_millis number
Time unit for milliseconds
-
-
- @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
-
Additional properties are allowed.
Hide cluster attributes Show cluster attributes object
-
routing object
Additional properties are allowed.
-
Additional properties are allowed.
-
initial_master_nodes array[string]
-
deprecation_indexing object
Additional properties are allowed.
-
Additional properties are allowed.
Hide node attributes Show node attributes object
-
max_local_storage_nodes string
-
path object
Additional properties are allowed.
-
repositories object
Additional properties are allowed.
Hide repositories attribute Show repositories attribute object
-
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
-
client object
Additional properties are allowed.
Hide client attribute Show client attribute object
-
Additional properties are allowed.
Hide http attributes Show http attributes object
-
Additional properties are allowed.
-
type.default string
-
-
bootstrap object
Additional properties are allowed.
Hide bootstrap attribute Show bootstrap attribute object
-
Additional properties are allowed.
Hide transport attributes Show transport attributes object
-
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.
-
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
-
search object
Additional properties are allowed.
Hide search attribute Show search attribute object
-
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
-
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
-
size number
-
-
-
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
-
Hide profiles attribute Show profiles attribute object
-
modules array[object]
Hide modules attributes Show modules attributes object
-
ingest object
Additional properties are allowed.
Hide ingest attribute Show ingest attribute object
-
Additional properties are allowed.
-
-
aggregations object
-
-
-
curl \
-X GET http://api.example.com/_nodes/{node_id}/{metric}
{
"_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
}
]
}
}
}