OpenSearch/rest-api-spec/api/cat.json

46 lines
1.5 KiB
JSON

{
"cat": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html",
"methods": ["GET"],
"url": {
"path": "/_cat",
"paths": ["/_cat/aliases", "/_cat/aliases/{alias}", "/_cat/allocation", "/_cat/allocation/{nodes}", "/_cat", "/_cat/health", "/_cat/indices", "/_cat/indices/{index}", "/_cat/master", "/_cat/nodes", "/_cat/pending_tasks", "/_cat/shards", "/_cat/shards/{index}"],
"parts": {
"alias": {
"type" : "list",
"description" : "A comma-separated list of alias names to return"
},
"nodes": {
"type": "list",
"description": "A comma-separated list of node IDs or names to limit the returned information"
},
"index": {
"type" : "list",
"description": "A comma-separated list of index names to limit the returned information"
}
},
"params": {
"local": {
"type" : "boolean",
"description" : "Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout": {
"type" : "time",
"description" : "Explicit operation timeout for connection to master node"
},
"h": {
"type": "boolean",
"description": "Return help information",
"default": false
},
"v": {
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
}
}
},
"body": null
}
}