[SPEC] Updated cluster.state spec

This commit is contained in:
Clinton Gormley 2014-01-13 18:02:15 +01:00
parent b7cddea495
commit 7779196c8a
1 changed files with 16 additions and 26 deletions

View File

@ -4,33 +4,23 @@
"methods": ["GET"],
"url": {
"path": "/_cluster/state",
"paths": ["/_cluster/state"],
"parts": {},
"paths": [
"/_cluster/state",
"/_cluster/state/{metric}",
"/_cluster/state/{metric}/{index}"
],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
},
"metric" : {
"type" : "list",
"options" : ["_all", "blocks", "index_templates", "metadata", "nodes", "routing_table"],
"description" : "Limit the information returned to the specified metrics"
}
},
"params": {
"filter_blocks": {
"type": "boolean",
"description": "Do not return information about blocks"
},
"filter_index_templates": {
"type": "boolean",
"description": "Do not return information about index templates"
},
"filter_indices": {
"type": "list",
"description": "Limit returned metadata information to specific indices"
},
"filter_metadata": {
"type": "boolean",
"description": "Do not return information about indices metadata"
},
"filter_nodes": {
"type": "boolean",
"description": "Do not return information about nodes"
},
"filter_routing_table": {
"type": "boolean",
"description": "Do not return information about shard allocation (`routing_table` and `routing_nodes`)"
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"