rest-api-spec.api.nodes.hot_threads.json Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation
Elasticsearch subproject :rest-api-spec
There is a newer version: 8.16.0
{
  "nodes.hot_threads":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html",
      "description":"Returns information about hot threads on each node in the cluster."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "text/plain"]
    },
    "url":{
      "paths":[
        {
          "path":"/_nodes/hot_threads",
          "methods":[
            "GET"
          ]
        },
        {
          "path":"/_nodes/{node_id}/hot_threads",
          "methods":[
            "GET"
          ],
          "parts":{
            "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"
            }
          }
        },
        {
          "path":"/_cluster/nodes/hotthreads",
          "methods":[
            "GET"
          ],
          "parts":{},
          "deprecated":{
            "version":"7.0.0",
            "description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
          }
        },
        {
          "path":"/_cluster/nodes/{node_id}/hotthreads",
          "methods":[
            "GET"
          ],
          "parts":{
            "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"
            }
          },
          "deprecated":{
            "version":"7.0.0",
            "description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
          }
        },
        {
          "path":"/_nodes/hotthreads",
          "methods":[
            "GET"
          ],
          "parts":{},
          "deprecated":{
            "version":"7.0.0",
            "description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
          }
        },
        {
          "path":"/_nodes/{node_id}/hotthreads",
          "methods":[
            "GET"
          ],
          "parts":{
            "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"
            }
          },
          "deprecated":{
            "version":"7.0.0",
            "description":"The hot threads API accepts `hotthreads` but only `hot_threads` is documented"
          }
        },
        {
          "path":"/_cluster/nodes/hot_threads",
          "methods":[
            "GET"
          ],
          "parts":{},
          "deprecated":{
            "version":"7.0.0",
            "description":"The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"
          }
        },
        {
          "path":"/_cluster/nodes/{node_id}/hot_threads",
          "methods":[
            "GET"
          ],
          "parts":{
            "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"
            }
          },
          "deprecated":{
            "version":"7.0.0",
            "description":"The hot accepts /_cluster/nodes as prefix for backwards compatibility reasons"
          }
        }
      ]
    },
    "params":{
      "interval":{
        "type":"time",
        "description":"The interval for the second sampling of threads"
      },
      "snapshots":{
        "type":"number",
        "description":"Number of samples of thread stacktrace (default: 10)"
      },
      "threads":{
        "type":"number",
        "description":"Specify the number of threads to provide information for (default: 3)"
      },
      "ignore_idle_threads":{
        "type":"boolean",
        "description":"Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true)"
      },
      "type":{
        "type":"enum",
        "options":[
          "cpu",
          "wait",
          "block",
          "mem"
        ],
        "description":"The type to sample (default: cpu)"
      },
      "sort":{
        "type":"enum",
        "options":[
          "cpu",
          "total"
        ],
        "description":"The sort order for 'cpu' type (default: total)"
      },
      "timeout":{
        "type":"time",
        "description":"Explicit operation timeout"
      }
    }
  }
}