Path parameters

• node_id string | array[string] Required

  A comma-separated list of node IDs or names to limit the returned information; use _local to return information from the node you're connecting to, leave empty to get information from all nodes

• metric string | array[string] Required

  Limits the information returned to the specific metrics. A comma-separated list of the following options: _all, rest_actions.

Query parameters

• timeout string

  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

  • _nodes object

    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

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

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

    • 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

      • rest_actions object Required
        Hide rest_actions attribute Show rest_actions attribute object

        • * number Additional properties

      • Time unit for milliseconds

      • Time unit for milliseconds

      • aggregations object Required
        Hide aggregations attribute Show aggregations attribute object

        • * object Additional properties