OpenSearch/rest-api-spec/api/cluster.node_stats.json

95 lines
3.4 KiB
JSON

{
"cluster.node_stats": {
"documentation": "http://elasticsearch.org/guide/reference/api/admin-cluster-nodes-stats/",
"methods": ["GET"],
"url": {
"path": "/_cluster/nodes/stats",
"paths": [
"/_cluster/nodes/stats",
"/_cluster/nodes/{node_id}/stats",
"/_nodes/stats",
"/_nodes/{node_id}/stats",
"/_nodes/stats/{metric_family}",
"/_nodes/{node_id}/stats/{metric_family}",
"/_nodes/{metric_family}/stats",
"/_nodes/{node_id}/{metric_family}/stats",
"/_nodes/stats/indices/{metric}/{fields}",
"/_nodes/{node_id}/stats/indices/{metric}/{fields}",
"/_nodes/indices/{metric}/{fields}/stats",
"/_nodes/{node_id}/indices/{metric}/{fields}/stats"
],
"parts": {
"fields" : {
"type" : "list",
"description" : "A comma-separated list of fields to return detailed information for, when returning the `indices` metric family (supports wildcards)"
},
"metric_family" : {
"type" : "enum",
"options" : ["all","fs","http","indices","jvm","network","os","process","thread_pool","transport"],
"description" : "Limit the information returned to a certain metric family"
},
"metric" : {
"type" : "enum",
"options" : ["docs", "fielddata", "filter_cache", "flush", "get", "id_cache", "indexing", "merges", "refresh", "search", "store", "warmer"],
"description" : "Limit the information returned for `indices` family to a specific metric"
},
"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": {
"all": {
"type" : "boolean",
"description" : "Return all available information"
},
"clear": {
"type" : "boolean",
"description" : "Reset the default level of detail"
},
"fields": {
"type" : "list",
"description" : "A comma-separated list of fields for `fielddata` metric (supports wildcards)"
},
"fs": {
"type" : "boolean",
"description" : "Return information about the filesystem"
},
"http": {
"type" : "boolean",
"description" : "Return information about HTTP"
},
"indices": {
"type" : "boolean",
"description" : "Return information about indices"
},
"jvm": {
"type" : "boolean",
"description" : "Return information about the JVM"
},
"network": {
"type" : "boolean",
"description" : "Return information about network"
},
"os": {
"type" : "boolean",
"description" : "Return information about the operating system"
},
"process": {
"type" : "boolean",
"description" : "Return information about the Elasticsearch process"
},
"thread_pool": {
"type" : "boolean",
"description" : "Return information about the thread pool"
},
"transport": {
"type" : "boolean",
"description" : "Return information about transport"
}
}
},
"body": null
}
}