Get node information | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

• metric
  string | array[string] Required
  Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest.

Query parameters

• If true, returns settings in flat format.
• 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
  • Hide _nodes attributes Show _nodes attributes object
    * Hide failures attributes Show failures attributes object
    * The type of error
    * A human-readable explanation of the error, in English.
    * The server stack trace. Present only if the error_trace=true parameter was sent with the request.
    * 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
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide attributes attribute Show attributes attribute object
    * *
    string Additional properties
    * Short hash of the last git commit in this release.
    * Hide http attributes Show http attributes object
    * Hide jvm attributes Show jvm attributes object
    * Hide mem attributes Show mem attributes object
    * Time unit for milliseconds
    * Hide network attributes Show network attributes object
    * Hide primary_interface attributes Show primary_interface attributes object
    * Hide os attributes Show os attributes object
    * Name of the JVM architecture (ex: amd64, x86)
    * Number of processors available to the Java virtual machine
    * 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.
    * Time unit for milliseconds
    * Hide cpu attributes Show cpu attributes object
    * Hide mem attributes Show mem attributes object
    * Hide swap attributes Show swap attributes object
    * Hide plugins attributes Show plugins attributes object
    * Hide process attributes Show process attributes object
    * Process identifier (PID)
    * Indicates if the process address space has been successfully locked in memory
    * 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, or coordinating_only.
    * Hide settings attributes Show settings attributes object
    * Hide cluster attributes Show cluster attributes object
    * Hide node attributes Show node attributes object
    * Hide path attributes Show path attributes object
    * Hide repositories attribute Show repositories attribute object
    * Hide discovery attributes Show discovery attributes object
    * Hide action attribute Show action attribute object
    * Hide client attribute Show client attribute object
    * Hide http attributes Show http attributes object
    * Hide bootstrap attribute Show bootstrap attribute object
    * Hide transport attributes Show transport attributes object
    * Hide network attribute Show network attribute object
    * Hide xpack attributes Show xpack attributes object
    * Hide script attributes Show script attributes object
    * Hide search attribute Show search attribute object
    * Hide ingest attributes Show ingest attributes object
    * Hide thread_pool attribute Show thread_pool attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * 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.
    * 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.
    * Hide transport attributes Show transport attributes object
    * Hide profiles attribute Show profiles attribute object
    * *
    string Additional properties
    * Hide modules attributes Show modules attributes object
    * Hide ingest attribute Show ingest attribute object
    * Hide aggregations attribute Show aggregations attribute object
    * *
    object Additional properties
    Hide * attribute Show * attribute object
    * types
    array[string] Required