Get snapshot lifecycle stats API

Get snapshot lifecycle stats API

New API reference

For the most up-to-date API details, refer to Snapshot lifecycle management APIs.

Returns global and policy-level statistics about actions taken by snapshot lifecycle management.

Request

GET /_slm/stats

Prerequisites

If the Elasticsearch security features are enabled, you must have the manage_slm cluster privilege to use this API. For more information, see Security privileges.

Examples

  1. resp = client.slm.get_stats()
  2. print(resp)
  1. response = client.slm.get_stats
  2. puts response
  1. const response = await client.slm.getStats();
  2. console.log(response);
  1. GET /_slm/stats

The API returns the following response:

  1. {
  2.   "retention_runs": 13,
  3.   "retention_failed": 0,
  4.   "retention_timed_out": 0,
  5.   "retention_deletion_time": "1.4s",
  6.   "retention_deletion_time_millis": 1404,
  7.   "policy_stats": [ ],
  8.   "total_snapshots_taken": 1,
  9.   "total_snapshots_failed": 1,
  10.   "total_snapshots_deleted": 0,
  11.   "total_snapshot_deletion_failures": 0
  12. }