get-repositories-metering.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. [role="xpack"]
  2. [[get-repositories-metering-api]]
  3. === Get repositories metering information
  4. ++++
  5. <titleabbrev>Get repositories metering information</titleabbrev>
  6. ++++
  7. Returns cluster repositories metering information.
  8. [[get-repositories-metering-api-request]]
  9. ==== {api-request-title}
  10. `GET /_nodes/<node_id>/_repositories_metering`
  11. [[get-repositories-metering-api-prereqs]]
  12. ==== {api-prereq-title}
  13. * If the {es} {security-features} are enabled, you must have the `monitor` or
  14. `manage` <<privileges-list-cluster,cluster privilege>> to use this API.
  15. [[get-repositories-metering-api-desc]]
  16. ==== {api-description-title}
  17. You can use the cluster repositories metering API to retrieve repositories metering information in a cluster.
  18. This API exposes monotonically non-decreasing counters and it's expected that clients would durably store
  19. the information needed to compute aggregations over a period of time. Additionally, the information
  20. exposed by this API is volatile, meaning that it won't be present after node restarts.
  21. [[get-repositories-metering-api-path-params]]
  22. ==== {api-path-parms-title}
  23. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=node-id]
  24. All the nodes selective options are explained <<cluster-nodes,here>>.
  25. [role="child_attributes"]
  26. [[get-repositories-metering-api-response-body]]
  27. ==== {api-response-body-title}
  28. include::{es-repo-dir}/repositories-metering-api/apis/repositories-meterings-body.asciidoc[tag=repositories-metering-body]