OpenSearch/rest-api-spec/api/cat.recovery.json
Andrew Selden 89e45fde9c Recovery API
Adds a new API endpoint at /_recovery as well as to the Java API. The
recovery API allows one to see the recovery status of all shards in the
cluster. It will report on percent complete, recovery type, and which
files are copied.

Closes #4637
2014-03-20 10:13:30 -07:00

43 lines
1.2 KiB
JSON

{
"cat.recovery": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html",
"methods": ["GET"],
"url": {
"path": "/_cat/recovery",
"paths": ["/_cat/recovery", "/_cat/recovery/{index}"],
"parts": {
"index": {
"type" : "list",
"description": "A comma-separated list of index names to limit the returned information"
}
},
"params": {
"bytes": {
"type": "enum",
"description" : "The unit in which to display byte values",
"options": [ "b", "k", "m", "g" ]
},
"master_timeout": {
"type" : "time",
"description" : "Explicit operation timeout for connection to master node"
},
"h": {
"type": "list",
"description" : "Comma-separated list of column names to display"
},
"help": {
"type": "boolean",
"description": "Return help information",
"default": false
},
"v": {
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
}
}
},
"body": null
}
}