[Yandex Cloud documentation](../../../index.md) > [Yandex Managed Service for Valkey™](../../index.md) > API reference > [REST](../index.md) > [Cluster](index.md) > List # Managed Service for Redis API, REST: Cluster.List Retrieves the list of Redis clusters that belong to the specified folder. ## HTTP request ``` GET https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters ``` ## Query parameters {#yandex.cloud.mdb.redis.v1.ListClustersRequest} #| ||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](../../../resource-manager/api-ref/Folder/list.md#List) request. The maximum string length in characters is 50. || || 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](#yandex.cloud.mdb.redis.v1.ListClustersResponse) that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive. || || pageToken | **string** Page token. To get the next page of results, set `pageToken` to the [ListClustersResponse.nextPageToken](#yandex.cloud.mdb.redis.v1.ListClustersResponse) returned by the previous list request. The maximum string length in characters is 100. || || 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](#yandex.cloud.mdb.redis.v1.Cluster) 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])?`. The maximum string length in characters is 1000. || |# ## Response {#yandex.cloud.mdb.redis.v1.ListClustersResponse} **HTTP Code: 200 - OK** ```json { "clusters": [ { "id": "string", "folderId": "string", "createdAt": "string", "name": "string", "description": "string", "labels": "object", "environment": "string", "monitoring": [ { "name": "string", "description": "string", "link": "string" } ], "config": { "version": "string", // Includes only one of the fields `redisConfig_5_0`, `redisConfig_6_0`, `redisConfig_6_2`, `redisConfig_7_0` "redisConfig_5_0": { "effectiveConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" } }, "userConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" } }, "defaultConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" } } }, "redisConfig_6_0": { "effectiveConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" } }, "userConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" } }, "defaultConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" } } }, "redisConfig_6_2": { "effectiveConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string" }, "userConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string" }, "defaultConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string" } }, "redisConfig_7_0": { "effectiveConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string" }, "userConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string" }, "defaultConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string" } }, // end of the list of possible fields "resources": { "resourcePresetId": "string", "diskSize": "string", "diskTypeId": "string" }, "backupWindowStart": { "hours": "integer", "minutes": "integer", "seconds": "integer", "nanos": "integer" }, "access": { "dataLens": "boolean", "webSql": "boolean" }, "redis": { "effectiveConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string", "luaTimeLimit": "string", "replBacklogSizePercent": "string", "clusterRequireFullCoverage": "boolean", "clusterAllowReadsWhenDown": "boolean", "clusterAllowPubsubshardWhenDown": "boolean", "lfuDecayTime": "string", "lfuLogFactor": "string", "turnBeforeSwitchover": "boolean", "allowDataLoss": "boolean", "useLuajit": "boolean", "ioThreadsAllowed": "boolean", "zsetMaxListpackEntries": "string", "aofMaxSizePercent": "string", "activedefrag": "boolean", "auditLog": "boolean" }, "userConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string", "luaTimeLimit": "string", "replBacklogSizePercent": "string", "clusterRequireFullCoverage": "boolean", "clusterAllowReadsWhenDown": "boolean", "clusterAllowPubsubshardWhenDown": "boolean", "lfuDecayTime": "string", "lfuLogFactor": "string", "turnBeforeSwitchover": "boolean", "allowDataLoss": "boolean", "useLuajit": "boolean", "ioThreadsAllowed": "boolean", "zsetMaxListpackEntries": "string", "aofMaxSizePercent": "string", "activedefrag": "boolean", "auditLog": "boolean" }, "defaultConfig": { "maxmemoryPolicy": "string", "timeout": "string", "password": "string", "databases": "string", "slowlogLogSlowerThan": "string", "slowlogMaxLen": "string", "notifyKeyspaceEvents": "string", "clientOutputBufferLimitPubsub": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "clientOutputBufferLimitNormal": { "hardLimit": "string", "softLimit": "string", "softSeconds": "string" }, "maxmemoryPercent": "string", "luaTimeLimit": "string", "replBacklogSizePercent": "string", "clusterRequireFullCoverage": "boolean", "clusterAllowReadsWhenDown": "boolean", "clusterAllowPubsubshardWhenDown": "boolean", "lfuDecayTime": "string", "lfuLogFactor": "string", "turnBeforeSwitchover": "boolean", "allowDataLoss": "boolean", "useLuajit": "boolean", "ioThreadsAllowed": "boolean", "zsetMaxListpackEntries": "string", "aofMaxSizePercent": "string", "activedefrag": "boolean", "auditLog": "boolean" } }, "diskSizeAutoscaling": { "plannedUsageThreshold": "string", "emergencyUsageThreshold": "string", "diskSizeLimit": "string" }, "backupRetainPeriodDays": "string", "modules": { "valkeySearch": { "enabled": "boolean", "readerThreads": "string", "writerThreads": "string", "version": "string" }, "valkeyJson": { "enabled": "boolean", "version": "string" }, "valkeyBloom": { "enabled": "boolean", "version": "string" } }, "fullVersion": "string" }, "networkId": "string", "health": "string", "status": "string", "sharded": "boolean", "maintenanceWindow": { // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow` "anytime": "object", "weeklyMaintenanceWindow": { "day": "string", "hour": "string" } // end of the list of possible fields }, "plannedOperation": { "info": "string", "delayedUntil": "string" }, "securityGroupIds": [ "string" ], "tlsEnabled": "boolean", "deletionProtection": "boolean", "persistenceMode": "string", "announceHostnames": "boolean", "authSentinel": "boolean", "diskEncryptionKeyId": "string" } ], "nextPageToken": "string" } ``` #| ||Field | Description || || clusters[] | **[Cluster](#yandex.cloud.mdb.redis.v1.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](#yandex.cloud.mdb.redis.v1.ListClustersRequest), use the `nextPageToken` as the value for the [ListClustersRequest.pageToken](#yandex.cloud.mdb.redis.v1.ListClustersRequest) parameter in the next list request. Each subsequent list request will have its own `nextPageToken` to continue paging through the results. || |# ## Cluster {#yandex.cloud.mdb.redis.v1.Cluster} Description of a Redis cluster. For more information, see the Managed Service for Redis [documentation](../../concepts/index.md). #| ||Field | Description || || id | **string** Required field. ID of the Redis cluster. This ID is assigned by MDB at creation time. || || folderId | **string** Required field. ID of the folder that the Redis cluster belongs to. || || createdAt | **string** (date-time) Required field. Creation timestamp in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || name | **string** Required field. 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) Required field. 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[] | **[Monitoring](#yandex.cloud.mdb.redis.v1.Monitoring)** Description of monitoring systems relevant to the Redis cluster. || || config | **[ClusterConfig](#yandex.cloud.mdb.redis.v1.ClusterConfig)** Required field. Configuration of the Redis cluster. || || networkId | **string** Required field. ID of the network that the cluster belongs to. || || health | **enum** (Health) Required field. 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) Required field. 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](#yandex.cloud.mdb.redis.v1.MaintenanceWindow)** Required field. Maintenance window for the cluster. || || plannedOperation | **[MaintenanceOperation](#yandex.cloud.mdb.redis.v1.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 is on. - `OFF`: Cluster persistence mode is off. - `ON_REPLICAS`: Cluster persistence is on for 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. || |# ## Monitoring {#yandex.cloud.mdb.redis.v1.Monitoring} #| ||Field | Description || || name | **string** Required field. Name of the monitoring system. || || description | **string** Description of the monitoring system. || || link | **string** Required field. Link to the monitoring system charts for the Redis cluster. || |# ## ClusterConfig {#yandex.cloud.mdb.redis.v1.ClusterConfig} #| ||Field | Description || || version | **string** Version of Redis server software. || || redisConfig_5_0 | **[RedisConfigSet5_0](#yandex.cloud.mdb.redis.v1.config.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](#yandex.cloud.mdb.redis.v1.config.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](#yandex.cloud.mdb.redis.v1.config.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](#yandex.cloud.mdb.redis.v1.config.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](#yandex.cloud.mdb.redis.v1.Resources)** Required field. Resources allocated to Redis hosts. || || backupWindowStart | **[TimeOfDay](#google.type.TimeOfDay)** Required field. Time to start the daily backup, in the UTC timezone. || || access | **[Access](#yandex.cloud.mdb.redis.v1.Access)** Required field. Access policy to DB || || redis | **[RedisConfigSet](#yandex.cloud.mdb.redis.v1.config.RedisConfigSet)** Required field. Unified configuration of a Redis cluster. || || diskSizeAutoscaling | **[DiskSizeAutoscaling](#yandex.cloud.mdb.redis.v1.DiskSizeAutoscaling)** Disk size autoscaling settings || || backupRetainPeriodDays | **string** (int64) Retain period of automatically created backup in days || || modules | **[ValkeyModules](#yandex.cloud.mdb.redis.v1.ValkeyModules)** Valkey modules settings || || fullVersion | **string** Full version || |# ## RedisConfigSet5_0 {#yandex.cloud.mdb.redis.v1.config.RedisConfigSet5_0} #| ||Field | Description || || effectiveConfig | **[RedisConfig5_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0)** Effective settings for a Redis 5.0 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || || userConfig | **[RedisConfig5_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0)** User-defined settings for a Redis 5.0 cluster. || || defaultConfig | **[RedisConfig5_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0)** Default configuration for a Redis 5.0 cluster. || |# ## RedisConfig5_0 {#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0} Fields and structure of `RedisConfig` reflects Redis configuration file parameters. #| ||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](../../concepts/instance-types.md). All policies are described in detail in [Redis documentation](https://redis.io/topics/lru-cache). - `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. Value must be greater than 0. || || password | **string** Authentication password. The string length in characters must be 8-128. Value must match the regular expression ` [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128} `. || || databases | **string** (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. || || slowlogLogSlowerThan | **string** (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. || || slowlogMaxLen | **string** (int64) Max slow requests number to log. The minimum value is 0. || || notifyKeyspaceEvents | **string** String setting for pub\sub functionality. Value must match the regular expression ` [KEg$lshzxeAtm]{0,12} `. || || clientOutputBufferLimitPubsub | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0.ClientOutputBufferLimit)** Redis connection output buffers limits for pubsub operations. || || clientOutputBufferLimitNormal | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0.ClientOutputBufferLimit)** Redis connection output buffers limits for clients. || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig5_0.ClientOutputBufferLimit} #| ||Field | Description || || hardLimit | **string** (int64) Total limit in bytes. The minimum value is 0. || || softLimit | **string** (int64) Limit in bytes during certain time period. The minimum value is 0. || || softSeconds | **string** (int64) Seconds for soft limit. The minimum value is 0. || |# ## RedisConfigSet6_0 {#yandex.cloud.mdb.redis.v1.config.RedisConfigSet6_0} #| ||Field | Description || || effectiveConfig | **[RedisConfig6_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0)** Effective settings for a Redis 6.0 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || || userConfig | **[RedisConfig6_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0)** User-defined settings for a Redis 6.0 cluster. || || defaultConfig | **[RedisConfig6_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0)** Default configuration for a Redis 6.0 cluster. || |# ## RedisConfig6_0 {#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0} Fields and structure of `RedisConfig` reflects Redis configuration file parameters. #| ||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](../../concepts/instance-types.md). All policies are described in detail in [Redis documentation](https://redis.io/topics/lru-cache). - `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. Value must be greater than 0. || || password | **string** Authentication password. The string length in characters must be 8-128. Value must match the regular expression ` [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128} `. || || databases | **string** (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. || || slowlogLogSlowerThan | **string** (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. || || slowlogMaxLen | **string** (int64) Max slow requests number to log. The minimum value is 0. || || notifyKeyspaceEvents | **string** String setting for pub\sub functionality. Value must match the regular expression ` [KEg$lshzxeAtm]{0,13} `. || || clientOutputBufferLimitPubsub | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0.ClientOutputBufferLimit)** Redis connection output buffers limits for pubsub operations. || || clientOutputBufferLimitNormal | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0.ClientOutputBufferLimit)** Redis connection output buffers limits for clients. || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig6_0.ClientOutputBufferLimit} #| ||Field | Description || || hardLimit | **string** (int64) Total limit in bytes. The minimum value is 0. || || softLimit | **string** (int64) Limit in bytes during certain time period. The minimum value is 0. || || softSeconds | **string** (int64) Seconds for soft limit. The minimum value is 0. || |# ## RedisConfigSet6_2 {#yandex.cloud.mdb.redis.v1.config.RedisConfigSet6_2} #| ||Field | Description || || effectiveConfig | **[RedisConfig6_2](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2)** Effective settings for a Redis 6.2 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || || userConfig | **[RedisConfig6_2](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2)** User-defined settings for a Redis 6.2 cluster. || || defaultConfig | **[RedisConfig6_2](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2)** Default configuration for a Redis 6.2 cluster. || |# ## RedisConfig6_2 {#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2} Fields and structure of `RedisConfig` reflects Redis configuration file parameters. #| ||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](../../concepts/instance-types.md). All policies are described in detail in [Redis documentation](https://redis.io/topics/lru-cache). - `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. The minimum value is 0. || || password | **string** Authentication password. The string length in characters must be 8-128. Value must match the regular expression ` [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128} `. || || databases | **string** (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. || || slowlogLogSlowerThan | **string** (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. || || slowlogMaxLen | **string** (int64) Max slow requests number to log. The minimum value is 0. || || notifyKeyspaceEvents | **string** String setting for pub\sub functionality. Value must match the regular expression ` [KEg$lshzxeAtm]{0,13} `. || || clientOutputBufferLimitPubsub | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2.ClientOutputBufferLimit)** Redis connection output buffers limits for pubsub operations. || || clientOutputBufferLimitNormal | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2.ClientOutputBufferLimit)** Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig6_2.ClientOutputBufferLimit} #| ||Field | Description || || hardLimit | **string** (int64) Total limit in bytes. The minimum value is 0. || || softLimit | **string** (int64) Limit in bytes during certain time period. The minimum value is 0. || || softSeconds | **string** (int64) Seconds for soft limit. The minimum value is 0. || |# ## RedisConfigSet7_0 {#yandex.cloud.mdb.redis.v1.config.RedisConfigSet7_0} #| ||Field | Description || || effectiveConfig | **[RedisConfig7_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0)** Effective settings for a Redis 7.0 cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || || userConfig | **[RedisConfig7_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0)** User-defined settings for a Redis 7.0 cluster. || || defaultConfig | **[RedisConfig7_0](#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0)** Default configuration for a Redis 7.0 cluster. || |# ## RedisConfig7_0 {#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0} Fields and structure of `RedisConfig` reflects Redis configuration file parameters. #| ||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](../../concepts/instance-types.md). All policies are described in detail in [Redis documentation](https://redis.io/topics/lru-cache). - `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. The minimum value is 0. || || password | **string** Authentication password. The string length in characters must be 8-128. Value must match the regular expression ` [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128} `. || || databases | **string** (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. || || slowlogLogSlowerThan | **string** (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. || || slowlogMaxLen | **string** (int64) Max slow requests number to log. The minimum value is 0. || || notifyKeyspaceEvents | **string** String setting for pub\sub functionality. Value must match the regular expression ` [KEg$lshzxeAtm]{0,13} `. || || clientOutputBufferLimitPubsub | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0.ClientOutputBufferLimit)** Redis connection output buffers limits for pubsub operations. || || clientOutputBufferLimitNormal | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0.ClientOutputBufferLimit)** Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig7_0.ClientOutputBufferLimit} #| ||Field | Description || || hardLimit | **string** (int64) Total limit in bytes. The minimum value is 0. || || softLimit | **string** (int64) Limit in bytes during certain time period. The minimum value is 0. || || softSeconds | **string** (int64) Seconds for soft limit. The minimum value is 0. || |# ## Resources {#yandex.cloud.mdb.redis.v1.Resources} #| ||Field | Description || || resourcePresetId | **string** Required field. ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the [documentation](../../concepts/instance-types.md). || || 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. || |# ## TimeOfDay {#google.type.TimeOfDay} 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](https://github.com/googleapis/googleapis/blob/master/google/type/date.proto) and [google.protobuf.Timestamp](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/timestamp.proto). #| ||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. || |# ## Access {#yandex.cloud.mdb.redis.v1.Access} #| ||Field | Description || || dataLens | **boolean** Allow access for DataLens || || webSql | **boolean** Allow access for Web SQL. || |# ## RedisConfigSet {#yandex.cloud.mdb.redis.v1.config.RedisConfigSet} #| ||Field | Description || || effectiveConfig | **[RedisConfig](#yandex.cloud.mdb.redis.v1.config.RedisConfig)** Effective settings for a Redis cluster (a combination of settings defined in `userConfig` and `defaultConfig`). || || userConfig | **[RedisConfig](#yandex.cloud.mdb.redis.v1.config.RedisConfig)** User-defined settings for a Redis cluster. || || defaultConfig | **[RedisConfig](#yandex.cloud.mdb.redis.v1.config.RedisConfig)** Default configuration for a Redis cluster. || |# ## RedisConfig {#yandex.cloud.mdb.redis.v1.config.RedisConfig} Fields and structure of `RedisConfig` reflects Redis configuration file parameters. #| ||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](../../concepts/instance-types.md). All policies are described in detail in [Redis documentation](https://redis.io/topics/lru-cache). - `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. The minimum value is 0. || || password | **string** Authentication password. || || databases | **string** (int64) Number of database buckets on a single redis-server process. Acceptable values are 1 to 1024, inclusive. || || slowlogLogSlowerThan | **string** (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 10. || || slowlogMaxLen | **string** (int64) Max slow requests number to log. The minimum value is 0. || || notifyKeyspaceEvents | **string** String setting for pub\sub functionality. || || clientOutputBufferLimitPubsub | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit)** Redis connection output buffers limits for pubsub operations. || || clientOutputBufferLimitNormal | **[ClientOutputBufferLimit](#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit)** Redis connection output buffers limits for clients. || || maxmemoryPercent | **string** (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. || || luaTimeLimit | **string** (int64) Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism Acceptable values are 0 to 5000, inclusive. || || replBacklogSizePercent | **string** (int64) Replication backlog size as a percentage of flavor maxmemory Acceptable values are 1 to 75, inclusive. || || 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) Acceptable values are 0 to 100000, inclusive. || || lfuLogFactor | **string** (int64) Determines how the frequency counter represents key hits. Acceptable values are 0 to 1000, inclusive. || || 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 Acceptable values are 32 to 2048, inclusive. || || aofMaxSizePercent | **string** (int64) AOF maximum size as a percentage of disk available Acceptable values are 1 to 99, inclusive. || || activedefrag | **boolean** Enable active (online) memory defragmentation || || auditLog | **boolean** Enable/disable audit logs for Valkey || |# ## ClientOutputBufferLimit {#yandex.cloud.mdb.redis.v1.config.RedisConfig.ClientOutputBufferLimit} #| ||Field | Description || || hardLimit | **string** (int64) Total limit in bytes. The minimum value is 0. || || softLimit | **string** (int64) Limit in bytes during certain time period. The minimum value is 0. || || softSeconds | **string** (int64) Seconds for soft limit. The minimum value is 0. || |# ## DiskSizeAutoscaling {#yandex.cloud.mdb.redis.v1.DiskSizeAutoscaling} #| ||Field | Description || || plannedUsageThreshold | **string** (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. || || emergencyUsageThreshold | **string** (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. || || diskSizeLimit | **string** (int64) Limit on how large the storage for database instances can automatically grow, in bytes. || |# ## ValkeyModules {#yandex.cloud.mdb.redis.v1.ValkeyModules} #| ||Field | Description || || valkeySearch | **[ValkeySearch](#yandex.cloud.mdb.redis.v1.ValkeySearch)** valkey-search module settings || || valkeyJson | **[ValkeyJson](#yandex.cloud.mdb.redis.v1.ValkeyJson)** valkey-json module settings || || valkeyBloom | **[ValkeyBloom](#yandex.cloud.mdb.redis.v1.ValkeyBloom)** valkey-bloom module settings || |# ## ValkeySearch {#yandex.cloud.mdb.redis.v1.ValkeySearch} #| ||Field | Description || || enabled | **boolean** Enable valkey-search module || || readerThreads | **string** (int64) Controls the amount of threads executing queries The minimum value is 0. || || writerThreads | **string** (int64) Controls the amount of threads processing index mutations The minimum value is 0. || || version | **string** Module version || |# ## ValkeyJson {#yandex.cloud.mdb.redis.v1.ValkeyJson} #| ||Field | Description || || enabled | **boolean** Enable valkey-json module || || version | **string** Module version || |# ## ValkeyBloom {#yandex.cloud.mdb.redis.v1.ValkeyBloom} #| ||Field | Description || || enabled | **boolean** Enable valkey-bloom module || || version | **string** Module version || |# ## MaintenanceWindow {#yandex.cloud.mdb.redis.v1.MaintenanceWindow} A maintenance window settings. #| ||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](#yandex.cloud.mdb.redis.v1.WeeklyMaintenanceWindow)** Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`. The maintenance policy in effect. || |# ## WeeklyMaintenanceWindow {#yandex.cloud.mdb.redis.v1.WeeklyMaintenanceWindow} Weelky maintenance window settings. #| ||Field | Description || || day | **enum** (WeekDay) Day of the week (in `DDD` format). - `MON`: Monday. - `TUE`: Tuesday. - `WED`: Wednesday. - `THU`: Thursday. - `FRI`: Friday. - `SAT`: Saturday. - `SUN`: Sunday. || || hour | **string** (int64) Hour of the day in UTC (in `HH` format). Acceptable values are 1 to 24, inclusive. || |# ## MaintenanceOperation {#yandex.cloud.mdb.redis.v1.MaintenanceOperation} A planned maintenance operation. #| ||Field | Description || || info | **string** Information about this maintenance operation. The maximum string length in characters is 256. || || delayedUntil | **string** (date-time) Time until which this maintenance operation is delayed. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) 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](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || |#