Managed Service for Redis API, REST: Cluster.List

Field

Description

folderId

string

Required field. ID of the folder to list Redis clusters in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClustersResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClustersResponse.nextPageToken
returned by the previous list request.

filter

string

A filter expression that filters clusters listed in the response.
The expression must specify:

1. The field name. Currently you can only use filtering with the Cluster.name field.
2. An = operator.
3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z]([-a-z0-9]{,61}[a-z0-9])?.

Field

Description

clusters[]

Cluster

List of Redis clusters.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClustersRequest.pageSize, use the nextPageToken as the value
for the ListClustersRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

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. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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 (map<string, string>)

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

environment

enum (Environment)

Deployment environment of the Redis cluster.

• ENVIRONMENT_UNSPECIFIED
• 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[]

Monitoring

Description of monitoring systems relevant to the Redis cluster.

config

ClusterConfig

Configuration of the Redis cluster.

networkId

string

health

enum (Health)

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

enum (Status)

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

Redis cluster mode on/off.

maintenanceWindow

MaintenanceWindow

Maintenance window for the cluster.

plannedOperation

MaintenanceOperation

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

securityGroupIds[]

string

User security groups

tlsEnabled

boolean

TLS port and functionality on\off

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster

persistenceMode

enum (PersistenceMode)

Persistence mode

• ON: cluster persistence mode on
• OFF: cluster persistence mode off
• ON_REPLICAS: cluster persistence on replicas only

announceHostnames

boolean

Enable FQDN instead of ip

authSentinel

boolean

Allows to use ACL users to auth in sentinel

diskEncryptionKeyId

string

ID of the key to encrypt cluster disks.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system charts for the Redis cluster.

Field

Description

version

string

Version of Redis server software.

redisConfig_5_0

RedisConfigSet5_0

Configuration of a Redis 5.0 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Redis servers in the cluster.

redisConfig_6_0

RedisConfigSet6_0

Configuration of a Redis 6.0 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Redis servers in the cluster.

redisConfig_6_2

RedisConfigSet6_2

Configuration of a Redis 6.2 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Redis servers in the cluster.

redisConfig_7_0

RedisConfigSet7_0

Configuration of a Redis 7.0 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Redis servers in the cluster.

resources

Resources

Resources allocated to Redis hosts.

backupWindowStart

TimeOfDay

Time to start the daily backup, in the UTC timezone.

access

Access

Access policy to DB

redis

RedisConfigSet

Unified configuration of a Redis cluster.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

backupRetainPeriodDays

string (int64)

Retain period of automatically created backup in days

modules

ValkeyModules

Valkey modules settings

Field

Description

effectiveConfig

RedisConfig5_0

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

userConfig

RedisConfig5_0

User-defined settings for a Redis 5.0 cluster.

defaultConfig

RedisConfig5_0

Default configuration for a Redis 5.0 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

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.

• MAXMEMORY_POLICY_UNSPECIFIED
• 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.

timeout

string (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.

password

string

Authentication password.

databases

string (int64)

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

slowlogLogSlowerThan

string (int64)

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

slowlogMaxLen

string (int64)

Max slow requests number to log.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

softLimit

string (int64)

Limit in bytes during certain time period.

softSeconds

string (int64)

Seconds for soft limit.

Field

Description

effectiveConfig

RedisConfig6_0

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

userConfig

RedisConfig6_0

User-defined settings for a Redis 6.0 cluster.

defaultConfig

RedisConfig6_0

Default configuration for a Redis 6.0 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

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.

• MAXMEMORY_POLICY_UNSPECIFIED
• 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.

timeout

string (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.

password

string

Authentication password.

databases

string (int64)

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

slowlogLogSlowerThan

string (int64)

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

slowlogMaxLen

string (int64)

Max slow requests number to log.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

softLimit

string (int64)

Limit in bytes during certain time period.

softSeconds

string (int64)

Seconds for soft limit.

Field

Description

effectiveConfig

RedisConfig6_2

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

userConfig

RedisConfig6_2

User-defined settings for a Redis 6.2 cluster.

defaultConfig

RedisConfig6_2

Default configuration for a Redis 6.2 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

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.

• MAXMEMORY_POLICY_UNSPECIFIED
• 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.

timeout

string (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.

password

string

Authentication password.

databases

string (int64)

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

slowlogLogSlowerThan

string (int64)

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

slowlogMaxLen

string (int64)

Max slow requests number to log.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Redis maxmemory percent

Field

Description

hardLimit

string (int64)

Total limit in bytes.

softLimit

string (int64)

Limit in bytes during certain time period.

softSeconds

string (int64)

Seconds for soft limit.

Field

Description

effectiveConfig

RedisConfig7_0

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

userConfig

RedisConfig7_0

User-defined settings for a Redis 7.0 cluster.

defaultConfig

RedisConfig7_0

Default configuration for a Redis 7.0 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

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.

• MAXMEMORY_POLICY_UNSPECIFIED
• 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.

timeout

string (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.

password

string

Authentication password.

databases

string (int64)

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

slowlogLogSlowerThan

string (int64)

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

slowlogMaxLen

string (int64)

Max slow requests number to log.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Redis maxmemory percent

Field

Description

hardLimit

string (int64)

Total limit in bytes.

softLimit

string (int64)

Limit in bytes during certain time period.

softSeconds

string (int64)

Seconds for soft limit.

Field

Description

resourcePresetId

string

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

diskSize

string (int64)

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

diskTypeId

string

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

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

Field

Description

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.

minutes

integer (int32)

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

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.

nanos

integer (int32)

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

Field

Description

dataLens

boolean

Allow access for DataLens

webSql

boolean

Allow access for Web SQL.

Field

Description

effectiveConfig

RedisConfig

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

userConfig

RedisConfig

User-defined settings for a Redis cluster.

defaultConfig

RedisConfig

Default configuration for a Redis cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

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.

• MAXMEMORY_POLICY_UNSPECIFIED
• 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.

timeout

string (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.

password

string

Authentication password.

databases

string (int64)

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

slowlogLogSlowerThan

string (int64)

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

slowlogMaxLen

string (int64)

Max slow requests number to log.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Redis maxmemory percent

luaTimeLimit

string (int64)

Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism

replBacklogSizePercent

string (int64)

Replication backlog size as a percentage of flavor maxmemory

clusterRequireFullCoverage

boolean

Controls whether all hash slots must be covered by nodes

clusterAllowReadsWhenDown

boolean

Allows read operations when cluster is down

clusterAllowPubsubshardWhenDown

boolean

Permits Pub/Sub shard operations when cluster is down

lfuDecayTime

string (int64)

The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10)

lfuLogFactor

string (int64)

Determines how the frequency counter represents key hits.

turnBeforeSwitchover

boolean

Allows to turn before switchover in RDSync

allowDataLoss

boolean

Allows some data to be lost in favor of faster switchover/restart

useLuajit

boolean

Use JIT for lua scripts and functions

ioThreadsAllowed

boolean

Allow redis to use io-threads

zsetMaxListpackEntries

string (int64)

Controls max number of entries in zset before conversion from memory-efficient listpack to CPU-efficient hash table and skiplist

aofMaxSizePercent

string (int64)

AOF maximum size as a percentage of disk available

activedefrag

boolean

Enable active (online) memory defragmentation

Field

Description

hardLimit

string (int64)

Total limit in bytes.

softLimit

string (int64)

Limit in bytes during certain time period.

softSeconds

string (int64)

Seconds for soft limit.

Field

Description

plannedUsageThreshold

string (int64)

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold

string (int64)

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit

string (int64)

Limit on how large the storage for database instances can automatically grow, in bytes.

Field

Description

valkeySearch

ValkeySearch

valkey-search module settings

valkeyJson

ValkeyJson

valkey-json module settings

valkeyBloom

ValkeyBloom

valkey-bloom module settings

Field

Description

enabled

boolean

Enable valkey-search module

readerThreads

string (int64)

Controls the amount of threads executing queries

writerThreads

string (int64)

Controls the amount of threads processing index mutations

Field

Description

enabled

boolean

Enable valkey-json module

Field

Description

enabled

boolean

Enable valkey-bloom module

Field

Description

anytime

object

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

Field

Description

day

enum (WeekDay)

Day of the week (in DDD format).

• WEEK_DAY_UNSPECIFIED
• MON
• TUE
• WED
• THU
• FRI
• SAT
• SUN

hour

string (int64)

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

Field

Description

info

string

Information about this maintenance operation.

delayedUntil

string (date-time)

Time until which this maintenance operation is delayed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).