OpenSearch/docs/reference/repositories-metering-api/apis/get-repositories-metering.a...

36 lines
1.2 KiB
Plaintext

[role="xpack"]
[testenv="basic"]
[[get-repositories-metering-api]]
=== Get repositories metering information
++++
<titleabbrev>Get repositories metering information</titleabbrev>
++++
Returns cluster repositories metering information.
[[get-repositories-metering-api-request]]
==== {api-request-title}
`GET /_nodes/<node_id>/_repositories_metering`
[[get-repositories-metering-api-desc]]
==== {api-description-title}
You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
This API exposes monotonically non-decreasing counters and it's expected that clients would durably store
the information needed to compute aggregations over a period of time. Additionally, the information
exposed by this API is volatile, meaning that it won't be present after node restarts.
[[get-repositories-metering-api-path-params]]
==== {api-path-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
All the nodes selective options are explained <<cluster-nodes,here>>.
[role="child_attributes"]
[[get-repositories-metering-api-response-body]]
==== {api-response-body-title}
include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body]