Method get

ID of the Redis cluster. This ID is assigned by MDB at creation time.

ID of the folder that the Redis cluster belongs to.

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

Name of the Redis cluster. The name is unique within the folder. 3-63 characters long.

Description of the Redis cluster. 0-256 characters long.

Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.

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.

Description of monitoring systems relevant to the Redis cluster.

Name of the monitoring system.

Description of the monitoring system.

Link to the monitoring system charts for the Redis cluster.

Configuration of the Redis cluster.

Version of Redis server software.

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

Volume of the storage available to a host, in bytes.

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

• network-ssd - network SSD drive,
• local-ssd - local SSD storage.

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.

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.

Minutes of hour of day. Must be from 0 to 59.

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.

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Allow access for DataLens

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.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

Value must match the regular expression [KEg$lshzxeAt]{0,12}.

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

User-defined settings for a Redis 5.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

Value must match the regular expression [KEg$lshzxeAt]{0,12}.

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Default configuration for a Redis 5.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

Value must match the regular expression [KEg$lshzxeAt]{0,12}.

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

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.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

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

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

User-defined settings for a Redis 6.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

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

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Default configuration for a Redis 6.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

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

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

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.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

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

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

User-defined settings for a Redis 6.2 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

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

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Default configuration for a Redis 6.2 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

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.

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.

Authentication password.

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

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

Value must be greater than 0.

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

The minimum value is 0.

Max slow requests number to log.

The minimum value is 0.

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

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

Redis connection output buffers limits for pubsub operations.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

Redis connection output buffers limits for clients.

Total limit in bytes.

The minimum value is 0.

Limit in bytes during certain time period.

The minimum value is 0.

Seconds for soft limit.

The minimum value is 0.

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)

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.

Redis cluster mode on/off.

Maintenance window for the cluster.

A maintenance window settings.

Weelky maintenance window settings.

Day of the week (in DDD format).

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

Acceptable values are 1 to 24, inclusive.

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

A planned maintenance operation.

Information about this maintenance operation.

The maximum string length in characters is 256.

Time until which this maintenance operation is delayed.

String in RFC3339 text format.

User security groups

TLS port and functionality on\off

Deletion Protection inhibits deletion of the cluster

Persistence mode