OpenSearch/rest-api-spec/api/indices.stats.json

131 lines
4.6 KiB
JSON

{
"indices.stats": {
"documentation": "http://elasticsearch.org/guide/reference/api/admin-indices-stats/",
"methods": ["GET"],
"url": {
"path": "/_stats",
"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": {
"type" : "list",
"description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
},
"indexing_types" : {
"type" : "list",
"description" : "A comma-separated list of document types to include in the `indexing` statistics"
},
"metric_family" : {
"type" : "enum",
"options" : ["completion","docs", "fielddata", "filter_cache", "flush", "get", "groups", "id_cache", "ignore_indices", "indexing", "merge", "refresh", "search", "store", "warmer"],
"description" : "Limit the information returned to a specific metric"
},
"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"
},
"completion": {
"type" : "boolean",
"description" : "Return information about completion suggester stats"
},
"completion_fields": {
"type" : "list",
"description" : "A comma-separated list of fields for `completion` metric (supports wildcards)"
},
"docs": {
"type" : "boolean",
"description" : "Return information about indexed and deleted documents"
},
"fielddata": {
"type" : "boolean",
"description" : "Return information about field data"
},
"fielddata_fields": {
"type" : "list",
"description" : "A comma-separated list of fields for `fielddata` metric (supports wildcards)"
},
"fields": {
"type" : "list",
"description" : "A comma-separated list of fields for `fielddata` and `completion` 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": {
"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": {
"type" : "boolean",
"description" : "Return information about the size of the index"
},
"warmer": {
"type" : "boolean",
"description" : "Return information about warmers"
}
}
},
"body": null
}
}