Path parameters

• node_idstring Required

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

Query parameters

• master_timeoutstring

  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.

  Values are -1 or 0.

• timeoutstring

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

  Values are -1 or 0.

Responses

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

  • _nodesobject Required

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

    Hide _nodes attributes Show _nodes attributes object

    • failuresarray[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

      • typestring Required

        The type of error

      • reasonstring | null

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

        One of:

        string-1stringstring-2string | null
      • stack_tracestring

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

      • caused_byobject

        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_causearray[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.

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

    • totalnumber Required

      Total number of nodes selected by the request.

    • successfulnumber Required

      Number of nodes that responded successfully to the request.

    • failednumber 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_namestring Required
  • nodesobject Required
    Hide nodes attribute Show nodes attribute object

    • *object Additional properties
      Hide * attributes Show * attributes object

      • attributesobject Required
        Hide attributes attribute Show attributes attribute object

        • *string Additional properties
      • jvmobject Required
        Hide jvm attributes Show jvm attributes object

        • heap_maxnumber | string

          One of:

          ByteSizenumberByteSizestring
        • heap_max_in_bytesnumber Required

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

        • java_inferencenumber | string

          One of:

          ByteSizenumberByteSizestring
        • java_inference_in_bytesnumber Required

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

        • java_inference_maxnumber | string

          One of:

          ByteSizenumberByteSizestring
        • java_inference_max_in_bytesnumber Required

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

      • memobject Required
        Hide mem attributes Show mem attributes object

        • adjusted_totalnumber | string

          One of:

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

        • totalnumber | string

          One of:

          ByteSizenumberByteSizestring
        • total_in_bytesnumber Required

          Total amount of physical memory in bytes.

        • mlobject Required
          Hide ml attributes Show ml attributes object

          • anomaly_detectorsnumber | string

            One of:

            ByteSizenumberByteSizestring
          • anomaly_detectors_in_bytesnumber Required

            Amount of native memory, in bytes, set aside for anomaly detection jobs.

          • data_frame_analyticsnumber | string

            One of:

            ByteSizenumberByteSizestring
          • data_frame_analytics_in_bytesnumber Required

            Amount of native memory, in bytes, set aside for data frame analytics jobs.

          • maxnumber | string

            One of:

            ByteSizenumberByteSizestring
          • max_in_bytesnumber Required

            Maximum amount of native memory (separate to the JVM heap), in bytes, that may be used by machine learning native processes.

          • native_code_overheadnumber | string

            One of:

            ByteSizenumberByteSizestring
          • native_code_overhead_in_bytesnumber Required

            Amount of native memory, in bytes, set aside for loading machine learning native code shared libraries.

          • native_inferencenumber | string

            One of:

            ByteSizenumberByteSizestring
          • native_inference_in_bytesnumber Required

            Amount of native memory, in bytes, set aside for trained models that have a PyTorch model_type.

      • namestring Required
      • rolesarray[string] Required

        Roles assigned to the node.

      • transport_addressstring Required
      • ephemeral_idstring Required