OpenSearch/rest-api-spec/api/nodes.stats.json

{
  "nodes.stats": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html",
    "methods": ["GET"],
    "url": {
      "path": "/_nodes/stats",
      "paths": [
        "/_nodes/stats",
        "/_nodes/{node_id}/stats",
        "/_nodes/stats/{metric}",
        "/_nodes/{node_id}/stats/{metric}",
        "/_nodes/stats/{metric}/{index_metric}",
        "/_nodes/{node_id}/stats/{metric}/{index_metric}"
      ],
      "parts": {
        "metric" : {
          "type" : "list",
          "options" : ["_all", "breaker", "fs", "http", "indices", "jvm", "network", "os", "process", "thread_pool", "transport"],
          "description" : "Limit the information returned to the specified metrics"
        },
        "index_metric" : {
          "type" : "list",
          "options" : ["_all", "completion", "docs", "fielddata", "filter_cache", "flush", "get", "id_cache", "indexing", "merge", "percolate", "refresh", "search", "segments", "store", "warmer"],
          "description" : "Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified."
        },
        "node_id": {
          "type" : "list",
          "description" : "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"
        }
      },
      "params": {
        "completion_fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)"
        },
        "fielddata_fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields for `fielddata` index metric (supports wildcards)"
        },
        "fields": {
          "type" : "list",
          "description" : "A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)"
        },
        "groups": {
          "type" : "boolean",
          "description" : "A comma-separated list of search groups for `search` index metric"
        },
        "human": {
            "type": "boolean",
            "description": "Whether to return time and byte values in human-readable format.",
            "default": false
        },
        "level": {
          "type" : "enum",
          "description": "Return indices stats aggregated at node, index or shard level",
          "options" : ["node", "indices", "shards"],
          "default" : "node"
        },
        "types" : {
          "type" : "list",
          "description" : "A comma-separated list of document types for the `indexing` index metric"
        }
      }
    },
    "body": null
  }
}