Get machine learning memory usage info Added in 8.2.0

GET /_ml/memory/_stats

Get information about how machine learning jobs and trained models are using memory, on each node, both within the JVM heap, and natively, outside of the JVM.

Query parameters

  • human boolean

    Specify this query parameter to include the fields with units in the response. Otherwise only the _in_bytes sizes are returned in the response.

  • 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

GET /_ml/memory/_stats
curl \
 -X GET http://api.example.com/_ml/memory/_stats
Response examples (200)
{
  "_nodes": {
    "failures": [
      {
        "type": "string",
        "reason": "string",
        "stack_trace": "string",
        "caused_by": {},
        "root_cause": [
          {}
        ],
        "suppressed": [
          {}
        ]
      }
    ],
    "total": 42.0,
    "successful": 42.0,
    "failed": 42.0
  },
  "cluster_name": "string",
  "nodes": {
    "additionalProperty1": {
      "attributes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "jvm": {
        "": 42.0,
        "heap_max_in_bytes": 42.0,
        "java_inference_in_bytes": 42.0,
        "java_inference_max_in_bytes": 42.0
      },
      "mem": {
        "": 42.0,
        "adjusted_total_in_bytes": 42.0,
        "total_in_bytes": 42.0,
        "ml": {
          "": 42.0,
          "anomaly_detectors_in_bytes": 42.0,
          "data_frame_analytics_in_bytes": 42.0,
          "max_in_bytes": 42.0,
          "native_code_overhead_in_bytes": 42.0,
          "native_inference_in_bytes": 42.0
        }
      },
      "name": "string",
      "roles": [
        "string"
      ],
      "transport_address": "string",
      "ephemeral_id": "string"
    },
    "additionalProperty2": {
      "attributes": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "jvm": {
        "": 42.0,
        "heap_max_in_bytes": 42.0,
        "java_inference_in_bytes": 42.0,
        "java_inference_max_in_bytes": 42.0
      },
      "mem": {
        "": 42.0,
        "adjusted_total_in_bytes": 42.0,
        "total_in_bytes": 42.0,
        "ml": {
          "": 42.0,
          "anomaly_detectors_in_bytes": 42.0,
          "data_frame_analytics_in_bytes": 42.0,
          "max_in_bytes": 42.0,
          "native_code_overhead_in_bytes": 42.0,
          "native_inference_in_bytes": 42.0
        }
      },
      "name": "string",
      "roles": [
        "string"
      ],
      "transport_address": "string",
      "ephemeral_id": "string"
    }
  }
}