Retrieve the Eviction Policy for a Redis Cluster

v1.0.0

To retrieve the configured eviction policy for an existing Redis cluster, send a GET request to /v2/databases/$DATABASE_ID/eviction_policy. The response will be a JSON object with an eviction_policy key. This will be set to a string representing the eviction policy.

Input

{
  "type": "object",
  "properties": {
    "database_cluster_uuid": {
      "type": "string",
      "format": "uuid"
    }
  },
  "required": [
    "database_cluster_uuid"
  ],
  "additionalProperties": false
}

Output

{
  "required": [
    "eviction_policy"
  ],
  "properties": {
    "eviction_policy": {
      "type": "string",
      "description": "A string specifying the desired eviction policy for the Redis cluster.\n\n- `noeviction`: Don't evict any data, returns error when memory limit is reached.\n- `allkeys_lru:` Evict any key, least recently used (LRU) first.\n- `allkeys_random`: Evict keys in a random order.\n- `volatile_lru`: Evict keys with expiration only, least recently used (LRU) first.\n- `volatile_random`: Evict keys with expiration only in a random order.\n- `volatile_ttl`: Evict keys with expiration only, shortest time-to-live (TTL) first.",
      "enum": [
        "noeviction",
        "allkeys_lru",
        "allkeys_random",
        "volatile_lru",
        "volatile_random",
        "volatile_ttl"
      ]
    }
  }
}