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

52 lines
1.8 KiB
JSON

{
"search_shards": {
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html",
"methods": ["GET", "POST"],
"url": {
"path": "/{index}/{type}/_search_shards",
"paths": ["/_search_shards", "/{index}/_search_shards", "/{index}/{type}/_search_shards"],
"parts": {
"index": {
"type" : "string",
"required" : false,
"description" : "The name of the index"
},
"type": {
"type" : "string",
"required" : false,
"description" : "The type of the document"
}
},
"params": {
"preference": {
"type" : "string",
"description" : "Specify the node or shard the operation should be performed on (default: random)"
},
"routing": {
"type" : "string",
"description" : "Specific routing value"
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
},
"ignore_unavailable": {
"type" : "boolean",
"description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"allow_no_indices": {
"type" : "boolean",
"description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
},
"expand_wildcards": {
"type" : "enum",
"options" : ["open","closed","none","all"],
"default" : "open",
"description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
}
}
},
"body": null
}
}