honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added the API definition for `_stats`

This commit is contained in:
Karel Minarik 2013-05-27 17:42:04 +02:00
parent 2cd85fa232
commit dbdb44f838
1 changed files with 49 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
rest-api-spec/api/indices.stats.json
View File

@ -4,59 +4,96 @@
"methods": ["GET"],
"url": {
"path": "/_stats",
"paths": ["/_stats", "/{index}/_stats", "_stats/docs", "/{index}/_stats/docs", "/_stats/store", "/{index}/_stats/store", "/_stats/indexing", "/{index}/_stats/indexing", "/_stats/indexing/{indexingTypes1}", "/{index}/_stats/indexing/{indexingTypes2}", "/_stats/search", "/{index}/_stats/search", "/_stats/search/{searchGroupsStats1}", "/{index}/_stats/search/{searchGroupsStats2}", "/_stats/get", "/{index}/_stats/get", "/_stats/refresh", "/{index}/_stats/refresh", "/_stats/merge", "/{index}/_stats/merge", "/_stats/flush", "/{index}/_stats/flush", "/_stats/warmer", "/{index}/_stats/warmer", "/_stats/filter_cache", "/{index}/_stats/filter_cache", "/_stats/id_cache", "/{index}/_stats/id_cache", "/_stats/fielddata", "/{index}/_stats/fielddata", "/_stats/fielddata/{fields}", "/{index}/_stats/fielddata/{fields}"],
"paths": ["/_stats", "/{index}/_stats", "_stats/{metric_family}", "/{index}/_stats/{metric_family}", "/_stats/indexing", "/{index}/_stats/indexing", "/_stats/indexing/{indexing_types}", "/_stats/search/{search_groups}", "/{index}/_stats/search/{search_groups}", "/_stats/fielddata/{fields}", "/{index}/_stats/fielddata/{fields}"],
"parts": {
"fields": {
"type" : "list",
"description" : "A comma-separated list of fields to return detailed information for, when returning the `search` statistics"
},
"index": {
"metric_family" : {
"type" : "enum",
"values" : ["docs", "fielddata", "fields", "filter_cache", "flush", "get", "groups", "id_cache", "ignore_indices", "indexing", "merge", "refresh", "search", "store", "warmer"],
"description" : "Limit the information returned to a specific metric"
},
"indexingTypes1": {
"indexing_types" : {
"type" : "list",
"description" : "A comma-separated list of document types to include in the `indexing` statistics"
},
"indexingTypes2": {
},
"searchGroupsStats1": {
},
"searchGroupsStats2": {
"search_groups" : {
"type" : "list",
"description" : "A comma-separated list of search groups to include in the `search` statistics"
}
},
"params": {
"all": {
"type" : "boolean",
"description" : "Return all available information"
},
"clear": {
"type" : "boolean",
"description" : "Reset the default level of detail"
},
"docs": {
"type" : "boolean",
"description" : "Return information about indexed and deleted documents"
},
"fielddata": {
"type" : "boolean",
"description" : "Return information about field data"
},
"fields": {
"type" : "boolean",
"description" : "A comma-separated list of fields for `fielddata` metric (supports wildcards)"
},
"filter_cache": {
"type" : "boolean",
"description" : "Return information about filter cache"
},
"flush": {
"type" : "boolean",
"description" : "Return information about flush operations"
},
"get": {
"type" : "boolean",
"description" : "Return information about get operations"
},
"groups": {
"type" : "boolean",
"description" : "A comma-separated list of search groups for `search` statistics"
},
"id_cache": {
"type" : "boolean",
"description" : "Return information about ID cache"
},
"ignore_indices": {
},
"index": {
"type" : "enum",
"options" : ["none","missing"],
"default" : "none",
"description" : "When performed on multiple indices, allows to ignore `missing` ones"
},
"indexing": {
"type" : "boolean",
"description" : "Return information about indexing operations"
},
"merge": {
"type" : "boolean",
"description" : "Return information about merge operations"
},
"refresh": {
"type" : "boolean",
"description" : "Return information about refresh operations"
},
"search": {
"type" : "boolean",
"description" : "Return information about search operations; use the `groups` parameter to include information for specific search groups"
},
"store": {
},
"types": {
"type" : "boolean",
"description" : "Return information about the size of the index"
},
"warmer": {
"type" : "boolean",
"description" : "Return information about warmers"
}
}
},