Managed Service for Redis API, gRPC: ClusterService.Restore

Written by

Yandex Cloud

Updated at June 1, 2026

gRPC request
RestoreClusterRequest
ConfigSpec
RedisConfig5_0
ClientOutputBufferLimit
RedisConfig6_0
ClientOutputBufferLimit
RedisConfig6_2
ClientOutputBufferLimit
RedisConfig7_0
ClientOutputBufferLimit
Resources
Access
RedisConfig
ClientOutputBufferLimit
DiskSizeAutoscaling
ValkeyModules
ValkeySearch
ValkeyJson
ValkeyBloom
HostSpec
MaintenanceWindow
AnytimeMaintenanceWindow
WeeklyMaintenanceWindow
UserSpec
Permissions
operation.Operation

Creates a new Redis cluster using the specified backup.

gRPC request

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

RestoreClusterRequest

{
  "backup_id": "string",
  "name": "string",
  "description": "string",
  "labels": "map<string, string>",
  "environment": "Environment",
  "config_spec": {
    "version": "string",
    // Includes only one of the fields `redis_config_5_0`, `redis_config_6_0`, `redis_config_6_2`, `redis_config_7_0`
    "redis_config_5_0": {
      "maxmemory_policy": "MaxmemoryPolicy",
      "timeout": "google.protobuf.Int64Value",
      "password": "string",
      "databases": "google.protobuf.Int64Value",
      "slowlog_log_slower_than": "google.protobuf.Int64Value",
      "slowlog_max_len": "google.protobuf.Int64Value",
      "notify_keyspace_events": "string",
      "client_output_buffer_limit_pubsub": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "client_output_buffer_limit_normal": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      }
    },
    "redis_config_6_0": {
      "maxmemory_policy": "MaxmemoryPolicy",
      "timeout": "google.protobuf.Int64Value",
      "password": "string",
      "databases": "google.protobuf.Int64Value",
      "slowlog_log_slower_than": "google.protobuf.Int64Value",
      "slowlog_max_len": "google.protobuf.Int64Value",
      "notify_keyspace_events": "string",
      "client_output_buffer_limit_pubsub": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "client_output_buffer_limit_normal": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      }
    },
    "redis_config_6_2": {
      "maxmemory_policy": "MaxmemoryPolicy",
      "timeout": "google.protobuf.Int64Value",
      "password": "string",
      "databases": "google.protobuf.Int64Value",
      "slowlog_log_slower_than": "google.protobuf.Int64Value",
      "slowlog_max_len": "google.protobuf.Int64Value",
      "notify_keyspace_events": "string",
      "client_output_buffer_limit_pubsub": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "client_output_buffer_limit_normal": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "maxmemory_percent": "google.protobuf.Int64Value"
    },
    "redis_config_7_0": {
      "maxmemory_policy": "MaxmemoryPolicy",
      "timeout": "google.protobuf.Int64Value",
      "password": "string",
      "databases": "google.protobuf.Int64Value",
      "slowlog_log_slower_than": "google.protobuf.Int64Value",
      "slowlog_max_len": "google.protobuf.Int64Value",
      "notify_keyspace_events": "string",
      "client_output_buffer_limit_pubsub": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "client_output_buffer_limit_normal": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "maxmemory_percent": "google.protobuf.Int64Value"
    },
    // end of the list of possible fields
    "resources": {
      "resource_preset_id": "string",
      "disk_size": "int64",
      "disk_type_id": "string"
    },
    "backup_window_start": "google.type.TimeOfDay",
    "access": {
      "data_lens": "bool",
      "web_sql": "bool"
    },
    "redis": {
      "maxmemory_policy": "MaxmemoryPolicy",
      "timeout": "google.protobuf.Int64Value",
      "password": "string",
      "databases": "google.protobuf.Int64Value",
      "slowlog_log_slower_than": "google.protobuf.Int64Value",
      "slowlog_max_len": "google.protobuf.Int64Value",
      "notify_keyspace_events": "string",
      "client_output_buffer_limit_pubsub": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "client_output_buffer_limit_normal": {
        "hard_limit": "google.protobuf.Int64Value",
        "soft_limit": "google.protobuf.Int64Value",
        "soft_seconds": "google.protobuf.Int64Value"
      },
      "maxmemory_percent": "google.protobuf.Int64Value",
      "lua_time_limit": "google.protobuf.Int64Value",
      "repl_backlog_size_percent": "google.protobuf.Int64Value",
      "cluster_require_full_coverage": "google.protobuf.BoolValue",
      "cluster_allow_reads_when_down": "google.protobuf.BoolValue",
      "cluster_allow_pubsubshard_when_down": "google.protobuf.BoolValue",
      "lfu_decay_time": "google.protobuf.Int64Value",
      "lfu_log_factor": "google.protobuf.Int64Value",
      "turn_before_switchover": "google.protobuf.BoolValue",
      "allow_data_loss": "google.protobuf.BoolValue",
      "use_luajit": "google.protobuf.BoolValue",
      "io_threads_allowed": "google.protobuf.BoolValue",
      "zset_max_listpack_entries": "google.protobuf.Int64Value",
      "aof_max_size_percent": "google.protobuf.Int64Value",
      "activedefrag": "google.protobuf.BoolValue",
      "audit_log": "google.protobuf.BoolValue"
    },
    "disk_size_autoscaling": {
      "planned_usage_threshold": "google.protobuf.Int64Value",
      "emergency_usage_threshold": "google.protobuf.Int64Value",
      "disk_size_limit": "google.protobuf.Int64Value"
    },
    "backup_retain_period_days": "google.protobuf.Int64Value",
    "modules": {
      "valkey_search": {
        "enabled": "bool",
        "reader_threads": "google.protobuf.Int64Value",
        "writer_threads": "google.protobuf.Int64Value",
        "version": "string"
      },
      "valkey_json": {
        "enabled": "bool",
        "version": "string"
      },
      "valkey_bloom": {
        "enabled": "bool",
        "version": "string"
      }
    }
  },
  "host_specs": [
    {
      "zone_id": "string",
      "subnet_id": "string",
      "shard_name": "string",
      "replica_priority": "google.protobuf.Int64Value",
      "assign_public_ip": "bool"
    }
  ],
  "network_id": "string",
  "folder_id": "string",
  "security_group_ids": [
    "string"
  ],
  "tls_enabled": "google.protobuf.BoolValue",
  "persistence_mode": "PersistenceMode",
  "deletion_protection": "bool",
  "announce_hostnames": "bool",
  "maintenance_window": {
    // Includes only one of the fields `anytime`, `weekly_maintenance_window`
    "anytime": "AnytimeMaintenanceWindow",
    "weekly_maintenance_window": {
      "day": "WeekDay",
      "hour": "int64"
    }
    // end of the list of possible fields
  },
  "auth_sentinel": "bool",
  "sharded": "bool",
  "disk_encryption_key_id": "google.protobuf.StringValue",
  "user_specs": [
    {
      "name": "string",
      "passwords": [
        "string"
      ],
      "permissions": {
        "patterns": "google.protobuf.StringValue",
        "pub_sub_channels": "google.protobuf.StringValue",
        "categories": "google.protobuf.StringValue",
        "commands": "google.protobuf.StringValue",
        "sanitize_payload": "google.protobuf.StringValue",
        "databases": "google.protobuf.StringValue"
      },
      "enabled": "google.protobuf.BoolValue"
    }
  ]
}

Field	Description
backup_id	string Required field. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request.
name	string Required field. Name of the new Redis cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
description	string Description of the new Redis cluster. The maximum string length in characters is 256.
labels	object (map<string, string>) Custom labels for the Redis cluster as `key:value` pairs. Maximum 64 per cluster. For example, "project": "mvp" or "source": "dictionary". The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression `[a-z][-_./\@0-9a-z]`. Each value must match the regular expression `[-_./\@0-9a-z]`. No more than 64 per resource.
environment	enum Environment Required field. Deployment environment of the new 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.
config_spec	ConfigSpec Required field. Configuration for the Redis cluster to be created.
host_specs[]	HostSpec Configurations for Redis hosts that should be created for the cluster that is being created from the backup.
network_id	string ID of the network to create the Redis cluster in. The maximum string length in characters is 150.
folder_id	string ID of the folder to create the Redis cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups
tls_enabled	google.protobuf.BoolValue TLS port and functionality on\off
persistence_mode	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.
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
announce_hostnames	bool Enable FQDN instead of ip
maintenance_window	MaintenanceWindow Window of maintenance operations.
auth_sentinel	bool Allows to use ACL users to auth in sentinel
sharded	bool Redis cluster mode on/off.
disk_encryption_key_id	google.protobuf.StringValue ID of the key to encrypt cluster disks.
user_specs[]	UserSpec Descriptions of users to be created in the Redis cluster. The minimum number of elements is 0.

ConfigSpec

Field	Description
version	string Version of Redis used in the cluster.
redis_config_5_0	RedisConfig5_0 Configuration of a Redis 5.0 server. Includes only one of the fields `redis_config_5_0`, `redis_config_6_0`, `redis_config_6_2`, `redis_config_7_0`. Configuration of a Redis cluster.
redis_config_6_0	RedisConfig6_0 Configuration of a Redis 6.0 server. Includes only one of the fields `redis_config_5_0`, `redis_config_6_0`, `redis_config_6_2`, `redis_config_7_0`. Configuration of a Redis cluster.
redis_config_6_2	RedisConfig6_2 Configuration of a Redis 6.2 server. Includes only one of the fields `redis_config_5_0`, `redis_config_6_0`, `redis_config_6_2`, `redis_config_7_0`. Configuration of a Redis cluster.
redis_config_7_0	RedisConfig7_0 Configuration of a Redis 7.0 server. Includes only one of the fields `redis_config_5_0`, `redis_config_6_0`, `redis_config_6_2`, `redis_config_7_0`. Configuration of a Redis cluster.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB
redis	RedisConfig Unified configuration of a Redis cluster
disk_size_autoscaling	DiskSizeAutoscaling Disk size autoscaling settings
backup_retain_period_days	google.protobuf.Int64Value Retain period of automatically created backup in days Acceptable values are 7 to 60, inclusive.
modules	ValkeyModules Valkey modules settings

RedisConfig5_0

Fields and structure of RedisConfig reflects Redis configuration file
parameters.

Field	Description
maxmemory_policy	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. `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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Number of database buckets on a single redis-server process. Value must be greater than 0.
slowlog_log_slower_than	google.protobuf.Int64Value Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0.
slowlog_max_len	google.protobuf.Int64Value Max slow requests number to log. The minimum value is 0.
notify_keyspace_events	string String setting for pub\sub functionality. Value must match the regular expression `[KEg$lshzxeAtm]{0,12}`.
client_output_buffer_limit_pubsub	ClientOutputBufferLimit Redis connection output buffers limits for pubsub operations.
client_output_buffer_limit_normal	ClientOutputBufferLimit Redis connection output buffers limits for clients.

ClientOutputBufferLimit

Field	Description
hard_limit	google.protobuf.Int64Value Total limit in bytes. The minimum value is 0.
soft_limit	google.protobuf.Int64Value Limit in bytes during certain time period. The minimum value is 0.
soft_seconds	google.protobuf.Int64Value Seconds for soft limit. The minimum value is 0.

RedisConfig6_0

Fields and structure of RedisConfig reflects Redis configuration file
parameters.

Field	Description
maxmemory_policy	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. `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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Number of database buckets on a single redis-server process. Value must be greater than 0.
slowlog_log_slower_than	google.protobuf.Int64Value Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0.
slowlog_max_len	google.protobuf.Int64Value Max slow requests number to log. The minimum value is 0.
notify_keyspace_events	string String setting for pub\sub functionality. Value must match the regular expression `[KEg$lshzxeAtm]{0,13}`.
client_output_buffer_limit_pubsub	ClientOutputBufferLimit Redis connection output buffers limits for pubsub operations.
client_output_buffer_limit_normal	ClientOutputBufferLimit Redis connection output buffers limits for clients.

ClientOutputBufferLimit

Field	Description
hard_limit	google.protobuf.Int64Value Total limit in bytes. The minimum value is 0.
soft_limit	google.protobuf.Int64Value Limit in bytes during certain time period. The minimum value is 0.
soft_seconds	google.protobuf.Int64Value Seconds for soft limit. The minimum value is 0.

RedisConfig6_2

Fields and structure of RedisConfig reflects Redis configuration file
parameters.

Field	Description
maxmemory_policy	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. `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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Number of database buckets on a single redis-server process. Value must be greater than 0.
slowlog_log_slower_than	google.protobuf.Int64Value Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0.
slowlog_max_len	google.protobuf.Int64Value Max slow requests number to log. The minimum value is 0.
notify_keyspace_events	string String setting for pub\sub functionality. Value must match the regular expression `[KEg$lshzxeAtm]{0,13}`.
client_output_buffer_limit_pubsub	ClientOutputBufferLimit Redis connection output buffers limits for pubsub operations.
client_output_buffer_limit_normal	ClientOutputBufferLimit Redis connection output buffers limits for clients.
maxmemory_percent	google.protobuf.Int64Value Redis maxmemory percent Acceptable values are 1 to 75, inclusive.

ClientOutputBufferLimit

Field	Description
hard_limit	google.protobuf.Int64Value Total limit in bytes. The minimum value is 0.
soft_limit	google.protobuf.Int64Value Limit in bytes during certain time period. The minimum value is 0.
soft_seconds	google.protobuf.Int64Value Seconds for soft limit. The minimum value is 0.

RedisConfig7_0

Fields and structure of RedisConfig reflects Redis configuration file
parameters.

Field	Description
maxmemory_policy	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. `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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Number of database buckets on a single redis-server process. Value must be greater than 0.
slowlog_log_slower_than	google.protobuf.Int64Value Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0.
slowlog_max_len	google.protobuf.Int64Value Max slow requests number to log. The minimum value is 0.
notify_keyspace_events	string String setting for pub\sub functionality. Value must match the regular expression `[KEg$lshzxeAtm]{0,13}`.
client_output_buffer_limit_pubsub	ClientOutputBufferLimit Redis connection output buffers limits for pubsub operations.
client_output_buffer_limit_normal	ClientOutputBufferLimit Redis connection output buffers limits for clients.
maxmemory_percent	google.protobuf.Int64Value Redis maxmemory percent Acceptable values are 1 to 75, inclusive.

ClientOutputBufferLimit

Field	Description
hard_limit	google.protobuf.Int64Value Total limit in bytes. The minimum value is 0.
soft_limit	google.protobuf.Int64Value Limit in bytes during certain time period. The minimum value is 0.
soft_seconds	google.protobuf.Int64Value Seconds for soft limit. The minimum value is 0.

Resources

Field	Description
resource_preset_id	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.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field

Description

data_lens

bool

Allow access for DataLens

web_sql

bool

Allow access for Web SQL.

RedisConfig

Fields and structure of RedisConfig reflects Redis configuration file
parameters.

Field	Description
maxmemory_policy	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. `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	google.protobuf.Int64Value 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	google.protobuf.Int64Value Number of database buckets on a single redis-server process. Acceptable values are 1 to 1024, inclusive.
slowlog_log_slower_than	google.protobuf.Int64Value Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 10.
slowlog_max_len	google.protobuf.Int64Value Max slow requests number to log. The minimum value is 0.
notify_keyspace_events	string String setting for pub\sub functionality.
client_output_buffer_limit_pubsub	ClientOutputBufferLimit Redis connection output buffers limits for pubsub operations.
client_output_buffer_limit_normal	ClientOutputBufferLimit Redis connection output buffers limits for clients.
maxmemory_percent	google.protobuf.Int64Value Redis maxmemory percent Acceptable values are 1 to 75, inclusive.
lua_time_limit	google.protobuf.Int64Value Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism Acceptable values are 0 to 5000, inclusive.
repl_backlog_size_percent	google.protobuf.Int64Value Replication backlog size as a percentage of flavor maxmemory Acceptable values are 1 to 75, inclusive.
cluster_require_full_coverage	google.protobuf.BoolValue Controls whether all hash slots must be covered by nodes
cluster_allow_reads_when_down	google.protobuf.BoolValue Allows read operations when cluster is down
cluster_allow_pubsubshard_when_down	google.protobuf.BoolValue Permits Pub/Sub shard operations when cluster is down
lfu_decay_time	google.protobuf.Int64Value 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.
lfu_log_factor	google.protobuf.Int64Value Determines how the frequency counter represents key hits. Acceptable values are 0 to 1000, inclusive.
turn_before_switchover	google.protobuf.BoolValue Allows to turn before switchover in RDSync
allow_data_loss	google.protobuf.BoolValue Allows some data to be lost in favor of faster switchover/restart
use_luajit	google.protobuf.BoolValue Use JIT for lua scripts and functions
io_threads_allowed	google.protobuf.BoolValue Allow redis to use io-threads
zset_max_listpack_entries	google.protobuf.Int64Value 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.
aof_max_size_percent	google.protobuf.Int64Value AOF maximum size as a percentage of disk available Acceptable values are 1 to 99, inclusive.
activedefrag	google.protobuf.BoolValue Enable active (online) memory defragmentation
audit_log	google.protobuf.BoolValue Enable/disable audit logs for Valkey

ClientOutputBufferLimit

Field	Description
hard_limit	google.protobuf.Int64Value Total limit in bytes. The minimum value is 0.
soft_limit	google.protobuf.Int64Value Limit in bytes during certain time period. The minimum value is 0.
soft_seconds	google.protobuf.Int64Value Seconds for soft limit. The minimum value is 0.

DiskSizeAutoscaling

Field	Description
planned_usage_threshold	google.protobuf.Int64Value Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive.
emergency_usage_threshold	google.protobuf.Int64Value Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive.
disk_size_limit	google.protobuf.Int64Value Limit on how large the storage for database instances can automatically grow, in bytes.

ValkeyModules

Field	Description
valkey_search	ValkeySearch valkey-search module settings
valkey_json	ValkeyJson valkey-json module settings
valkey_bloom	ValkeyBloom valkey-bloom module settings

ValkeySearch

Field	Description
enabled	bool Enable valkey-search module
reader_threads	google.protobuf.Int64Value Controls the amount of threads executing queries The minimum value is 0.
writer_threads	google.protobuf.Int64Value Controls the amount of threads processing index mutations The minimum value is 0.
version	string Module version

ValkeyJson

Field

Description

enabled

bool

Enable valkey-json module

version

string

Module version

ValkeyBloom

Field

Description

enabled

bool

Enable valkey-bloom module

version

string

Module version

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id. The maximum string length in characters is 50.
shard_name	string ID of the Redis shard the host belongs to. To get the shard ID use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.
replica_priority	google.protobuf.Int64Value A replica with a low priority number is considered better for promotion. A replica with priority of 0 will never be selected by Redis Sentinel for promotion. Works only for non-sharded clusters. Default value is 100.
assign_public_ip	bool Whether the host should get a public IP address on creation. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.

MaintenanceWindow

A maintenance window settings.

Field

Description

anytime

AnytimeMaintenanceWindow

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

weekly_maintenance_window

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weekly_maintenance_window.

The maintenance policy in effect.

AnytimeMaintenanceWindow

Field	Description
Empty

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

int64

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

Acceptable values are 1 to 24, inclusive.

UserSpec

Field	Description
name	string Required field. Name of the Redis user. The maximum string length in characters is 32. Value must match the regular expression `^[a-zA-Z0-9_][a-zA-Z0-9_@.-]*$`.
passwords[]	string Password of the Redis user. The maximum number of elements is 1.
permissions	Permissions Set of permissions to grant to the user.
enabled	google.protobuf.BoolValue Is Redis user enabled

Permissions

Field	Description
patterns	google.protobuf.StringValue Keys patterns user has permission to.
pub_sub_channels	google.protobuf.StringValue Channel patterns user has permissions to.
categories	google.protobuf.StringValue Command categories user has permissions to.
commands	google.protobuf.StringValue Commands user can execute.
sanitize_payload	google.protobuf.StringValue SanitizePayload parameter.
databases	google.protobuf.StringValue Databases parameter.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

Managed Service for Redis API, gRPC: ClusterService.Restore

gRPC requestgRPC request

RestoreClusterRequestRestoreClusterRequest

ConfigSpecConfigSpec

RedisConfig5_0RedisConfig5_0

ClientOutputBufferLimitClientOutputBufferLimit

RedisConfig6_0RedisConfig6_0

ClientOutputBufferLimitClientOutputBufferLimit

RedisConfig6_2RedisConfig6_2

ClientOutputBufferLimitClientOutputBufferLimit

RedisConfig7_0RedisConfig7_0

ClientOutputBufferLimitClientOutputBufferLimit

ResourcesResources

AccessAccess

RedisConfigRedisConfig

ClientOutputBufferLimitClientOutputBufferLimit

DiskSizeAutoscalingDiskSizeAutoscaling

ValkeyModulesValkeyModules

ValkeySearchValkeySearch

ValkeyJsonValkeyJson

ValkeyBloomValkeyBloom

HostSpecHostSpec

MaintenanceWindowMaintenanceWindow

AnytimeMaintenanceWindowAnytimeMaintenanceWindow

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

UserSpecUserSpec

PermissionsPermissions

operation.Operationoperation.Operation

Was the article helpful?

gRPC request

RestoreClusterRequest

ConfigSpec

RedisConfig5_0

ClientOutputBufferLimit

RedisConfig6_0

ClientOutputBufferLimit

RedisConfig6_2

ClientOutputBufferLimit

RedisConfig7_0

ClientOutputBufferLimit

Resources

Access

RedisConfig

ClientOutputBufferLimit

DiskSizeAutoscaling

ValkeyModules

ValkeySearch

ValkeyJson

ValkeyBloom

HostSpec

MaintenanceWindow

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

UserSpec

Permissions

operation.Operation