Get started
Yandex Managed Service for Redis

Method get

Written by
,
improved by

Returns the specified Redis cluster.

To get the list of available Redis clusters, make a list request.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}

Path parameters

Parameter Description
clusterId Required. ID of the Redis cluster to return. To get the cluster ID use a list request. The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "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",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `config` includes only one of the fields `redisConfig_5_0`, `redisConfig_6_0`, `redisConfig_6_2`
    "redisConfig_5_0": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      }
    },
    "redisConfig_6_0": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      }
    },
    "redisConfig_6_2": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string"
      }
    },
    // end of the list of possible fields`config`

  },
  "networkId": "string",
  "health": "string",
  "status": "string",
  "sharded": true,
  "maintenanceWindow": {

    // `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": {},
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    },
    // end of the list of possible fields`maintenanceWindow`

  },
  "plannedOperation": {
    "info": "string",
    "delayedUntil": "string"
  },
  "securityGroupIds": [
    "string"
  ],
  "tlsEnabled": true
}

Description of a Redis cluster. For more information, see
the Managed Service for Redis documentation.

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
Resources allocated to Redis hosts.
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.
resources.
diskTypeId		 string

Type of the storage environment for the host. Possible values:

  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
config.
backupWindowStart		 object
Time to start the daily backup, in the UTC timezone.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.
config.
backupWindowStart.
hours		 integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
config.
backupWindowStart.
minutes		 integer (int32)

Minutes of hour of day. Must be from 0 to 59.
config.
backupWindowStart.
seconds		 integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
config.
backupWindowStart.
nanos		 integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
config.
access		 object
Access policy to DB
config.
access.
dataLens		 boolean (boolean)

Allow access for DataLens
config.
redisConfig_5_0		 object
Configuration of a Redis 5.0 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2
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.
effectiveConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_5_0.
effectiveConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_5_0.
effectiveConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_5_0.
effectiveConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAt.

Value must match the regular expression [KEg$lshzxeAt]{0,12}.
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.
userConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_5_0.
userConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_5_0.
userConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_5_0.
userConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAt.

Value must match the regular expression [KEg$lshzxeAt]{0,12}.
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}.
config.
redisConfig_5_0.
defaultConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_5_0.
defaultConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_5_0.
defaultConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_5_0.
defaultConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAt.

Value must match the regular expression [KEg$lshzxeAt]{0,12}.
config.
redisConfig_6_0		 object
Configuration of a Redis 6.0 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2
config.
redisConfig_6_0.
effectiveConfig		 object

Effective settings for a Redis 6.0 cluster (a combination of settings defined in userConfig and defaultConfig).

Fields and structure of RedisConfig reflects Redis configuration file parameters.
config.
redisConfig_6_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_6_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_6_0.
effectiveConfig.
password		 string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.
config.
redisConfig_6_0.
effectiveConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_6_0.
effectiveConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_6_0.
effectiveConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_6_0.
effectiveConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.
config.
redisConfig_6_0.
userConfig		 object

User-defined settings for a Redis 6.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.
config.
redisConfig_6_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_6_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_6_0.
userConfig.
password		 string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.
config.
redisConfig_6_0.
userConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_6_0.
userConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_6_0.
userConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_6_0.
userConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.
config.
redisConfig_6_0.
defaultConfig		 object

Default configuration for a Redis 6.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.
config.
redisConfig_6_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_6_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_6_0.
defaultConfig.
password		 string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.
config.
redisConfig_6_0.
defaultConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_6_0.
defaultConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_6_0.
defaultConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_6_0.
defaultConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.
config.
redisConfig_6_2		 object
Configuration of a Redis 6.2 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2
config.
redisConfig_6_2.
effectiveConfig		 object

Effective settings for a Redis 6.2 cluster (a combination of settings defined in userConfig and defaultConfig).

Fields and structure of RedisConfig reflects Redis configuration file parameters.
config.
redisConfig_6_2.
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_6_2.
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_6_2.
effectiveConfig.
password		 string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.
config.
redisConfig_6_2.
effectiveConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_6_2.
effectiveConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_6_2.
effectiveConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_6_2.
effectiveConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.
config.
redisConfig_6_2.
userConfig		 object

User-defined settings for a Redis 6.2 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.
config.
redisConfig_6_2.
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_6_2.
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_6_2.
userConfig.
password		 string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.
config.
redisConfig_6_2.
userConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_6_2.
userConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_6_2.
userConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_6_2.
userConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.
config.
redisConfig_6_2.
defaultConfig		 object

Default configuration for a Redis 6.2 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.
config.
redisConfig_6_2.
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_6_2.
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_6_2.
defaultConfig.
password		 string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.
config.
redisConfig_6_2.
defaultConfig.
databases		 integer (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.
config.
redisConfig_6_2.
defaultConfig.
slowlogLogSlowerThan		 integer (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.
config.
redisConfig_6_2.
defaultConfig.
slowlogMaxLen		 integer (int64)

Max slow requests number to log.

The minimum value is 0.
config.
redisConfig_6_2.
defaultConfig.
notifyKeyspaceEvents		 string

String setting for pub\sub functionality; subset of KEg$lshzxeAtm.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.
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.
sharded boolean (boolean)

Redis cluster mode on/off.
maintenanceWindow object

Maintenance window for the cluster.

A maintenance window settings.
maintenanceWindow.
anytime		 object
Maintenance operation can be scheduled anytime.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow		 object
Maintenance operation can be scheduled on a weekly basis.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow

Weelky maintenance window settings.
maintenanceWindow.
weeklyMaintenanceWindow.
day		 string

Day of the week (in DDD format).
maintenanceWindow.
weeklyMaintenanceWindow.
hour		 string (int64)

Hour of the day in UTC (in HH format).

Acceptable values are 1 to 24, inclusive.
plannedOperation object

Planned maintenance operation to be started for the cluster within the nearest maintenanceWindow.

A planned maintenance operation.
plannedOperation.
info		 string

Information about this maintenance operation.

The maximum string length in characters is 256.
plannedOperation.
delayedUntil		 string (date-time)

Time until which this maintenance operation is delayed.

String in RFC3339 text format.
securityGroupIds[] string

User security groups
tlsEnabled boolean (boolean)

TLS port and functionality on\off
In this article: