Cluster

JSON Representation
Methods

A set of methods for managing Redis clusters.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string"
    },
    "redisConfig_5_0": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string"
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string"
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string"
      }
    }
  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folderId	string ID of the folder that the Redis cluster belongs to.
createdAt	string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format.
name	string Name of the Redis cluster. The name is unique within the folder. 3-63 characters long.
description	string Description of the Redis cluster. 0-256 characters long.
labels	object Custom labels for the Redis cluster as `key:value` pairs. Maximum 64 per cluster.
environment	string Deployment environment of the Redis cluster. PRODUCTION: Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance. PRESTABLE: Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.
monitoring[]	object Description of monitoring systems relevant to the Redis cluster.
monitoring[]. name	string Name of the monitoring system.
monitoring[]. description	string Description of the monitoring system.
monitoring[]. link	string Link to the monitoring system charts for the Redis cluster.
config	object Configuration of the Redis cluster.
config. version	string Version of Redis server software.
config. resources	object
config. resources. resourcePresetId	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
config. resources. diskSize	string (int64) Volume of the storage available to a host, in bytes.
config. redisConfig_5_0	object
config. redisConfig_5_0. effectiveConfig	object Effective settings for a Redis 5.0 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). Fields and structure of `RedisConfig` reflects Redis configuration file parameters.
config. redisConfig_5_0. effectiveConfig. maxmemoryPolicy	string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation. VOLATILE_LRU: Try to remove less recently used (LRU) keys with `expire set`. ALLKEYS_LRU: Remove less recently used (LRU) keys. VOLATILE_LFU: Try to remove least frequently used (LFU) keys with `expire set`. ALLKEYS_LFU: Remove least frequently used (LFU) keys. VOLATILE_RANDOM: Try to remove keys with `expire set` randomly. ALLKEYS_RANDOM: Remove keys randomly. VOLATILE_TTL: Try to remove less recently used (LRU) keys with `expire set` and shorter TTL first. NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
config. redisConfig_5_0. effectiveConfig. timeout	integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.
config. redisConfig_5_0. effectiveConfig. password	string Authentication password. Value must match the regular expression `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
config. redisConfig_5_0. userConfig	object User-defined settings for a Redis 5.0 cluster. Fields and structure of `RedisConfig` reflects Redis configuration file parameters.
config. redisConfig_5_0. userConfig. maxmemoryPolicy	string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation. VOLATILE_LRU: Try to remove less recently used (LRU) keys with `expire set`. ALLKEYS_LRU: Remove less recently used (LRU) keys. VOLATILE_LFU: Try to remove least frequently used (LFU) keys with `expire set`. ALLKEYS_LFU: Remove least frequently used (LFU) keys. VOLATILE_RANDOM: Try to remove keys with `expire set` randomly. ALLKEYS_RANDOM: Remove keys randomly. VOLATILE_TTL: Try to remove less recently used (LRU) keys with `expire set` and shorter TTL first. NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
config. redisConfig_5_0. userConfig. timeout	integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.
config. redisConfig_5_0. userConfig. password	string Authentication password. Value must match the regular expression `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
config. redisConfig_5_0. defaultConfig	object Default configuration for a Redis 5.0 cluster. Fields and structure of `RedisConfig` reflects Redis configuration file parameters.
config. redisConfig_5_0. defaultConfig. maxmemoryPolicy	string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation. VOLATILE_LRU: Try to remove less recently used (LRU) keys with `expire set`. ALLKEYS_LRU: Remove less recently used (LRU) keys. VOLATILE_LFU: Try to remove least frequently used (LFU) keys with `expire set`. ALLKEYS_LFU: Remove least frequently used (LFU) keys. VOLATILE_RANDOM: Try to remove keys with `expire set` randomly. ALLKEYS_RANDOM: Remove keys randomly. VOLATILE_TTL: Try to remove less recently used (LRU) keys with `expire set` and shorter TTL first. NOEVICTION: Return errors when memory limit was reached and commands could require more memory to be used.
config. redisConfig_5_0. defaultConfig. timeout	integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed.
config. redisConfig_5_0. defaultConfig. password	string Authentication password. Value must match the regular expression `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
networkId	string
health	string Aggregated cluster health HEALTH_UNKNOWN: Cluster is in unknown state (we have no data) ALIVE: Cluster is alive and well (all hosts are alive) DEAD: Cluster is inoperable (it cannot perform any of its essential functions) DEGRADED: Cluster is partially alive (it can perform some of its essential functions)
status	string Cluster status STATUS_UNKNOWN: Cluster status is unknown CREATING: Cluster is being created RUNNING: Cluster is running ERROR: Cluster failed UPDATING: Cluster is being updated. STOPPING: Cluster is stopping. STOPPED: Cluster stopped. STARTING: Cluster is starting.

Methods

Method	Description
addHosts	Creates new hosts for a cluster.
backup	Creates a backup for the specified Redis cluster.
create	Creates a Redis cluster in the specified folder.
delete	Deletes the specified Redis cluster.
deleteHosts	Deletes the specified hosts for a cluster.
get	Returns the specified Redis cluster.
list	Retrieves the list of Redis clusters that belong to the specified folder.
listBackups	Retrieves the list of available backups for the specified Redis cluster.
listHosts	Retrieves a list of hosts for the specified cluster.
listLogs	Retrieves logs for the specified Redis cluster.
listOperations	Retrieves the list of operations for the specified cluster.
restore	Creates a new Redis cluster using the specified backup.
start	Start the specified Redis cluster.
startFailover	Start a manual failover on the specified Redis cluster.
stop	Stop the specified Redis cluster.
update	Updates the specified Redis cluster.