Path parameters

• node_id string Required

  The names of particular nodes in the cluster to target. For example, nodeId1,nodeId2 or ml:true

Query parameters

• 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.

  External documentation
• timeout string

  Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  External documentation

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • _nodes object Required

    Contains statistics about the number of nodes selected by the request.

    Hide _nodes attributes Show _nodes attributes object

    • failures array[object]

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      Hide failures attributes Show failures attributes object

      Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • type string Required

        The type of error

      • reason string | null

        A human-readable explanation of the error, in English.

        One of:

        string-1 string string-2 string | null
      • stack_trace string

        The server stack trace. Present only if the error_trace=true parameter was sent with the request.

      • caused_by object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • root_cause array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

      • suppressed array[object]

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

    • 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
      Hide * attributes Show * attributes object

      • attributes object Required
        Hide attributes attribute Show attributes attribute object

        • * string Additional properties
      • jvm object Required

        Contains Java Virtual Machine (JVM) statistics for the node.

        Hide jvm attributes Show jvm attributes object

        • heap_max
        • heap_max_in_bytes number Required

          Maximum amount of memory, in bytes, available for use by the heap.

        • java_inference
        • java_inference_in_bytes number Required

          Amount of Java heap, in bytes, currently being used for caching inference models.

        • java_inference_max
        • java_inference_max_in_bytes number Required

          Maximum amount of Java heap, in bytes, to be used for caching inference models.

      • mem object Required

        Contains statistics about memory usage for the node.

        Hide mem attributes Show mem attributes object

        • adjusted_total
        • adjusted_total_in_bytes number Required

          If the amount of physical memory has been overridden using the es.total_memory_bytes system property then this reports the overridden value in bytes. Otherwise it reports the same value as total_in_bytes.

        • total
        • total_in_bytes number Required

          Total amount of physical memory in bytes.

        • ml object Required

          Contains statistics about machine learning use of native memory on the node.

      • name string Required

        Human-readable identifier for the node. Based on the Node name setting setting.

      • roles array[string] Required

        Roles assigned to the node.

      • transport_address string Required

        The host and port where transport HTTP connections are accepted.

      • ephemeral_id string Required