Managed Service for Redis API, REST: Cluster.Restore

Field

Description

backupId

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.

configSpec

ConfigSpec

Required field. Configuration for the Redis cluster to be created.

hostSpecs[]

HostSpec

Configurations for Redis hosts that should be created for
the cluster that is being created from the backup.

networkId

string

ID of the network to create the Redis cluster in.

The maximum string length in characters is 150.

folderId

string

ID of the folder to create the Redis cluster in.

The maximum string length in characters is 50.

securityGroupIds[]

string

User security groups

tlsEnabled

boolean

TLS port and functionality on\off

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.

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster

announceHostnames

boolean

Enable FQDN instead of ip

maintenanceWindow

MaintenanceWindow

Window of maintenance operations.

authSentinel

boolean

Allows to use ACL users to auth in sentinel

sharded

boolean

Redis cluster mode on/off.

diskEncryptionKeyId

string

ID of the key to encrypt cluster disks.

userSpecs[]

UserSpec

Descriptions of users to be created in the Redis cluster.

The minimum number of elements is 0.

Field

Description

version

string

Version of Redis used in the cluster.

redisConfig_5_0

RedisConfig5_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 of a Redis cluster.

redisConfig_6_0

RedisConfig6_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 of a Redis cluster.

redisConfig_6_2

RedisConfig6_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 of a Redis cluster.

redisConfig_7_0

RedisConfig7_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 of a Redis 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

RedisConfig

Unified configuration of a Redis cluster

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

backupRetainPeriodDays

string (int64)

Retain period of automatically created backup in days

Acceptable values are 7 to 60, inclusive.

modules

ValkeyModules

Valkey modules settings

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.

• 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

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.

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.

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.

• 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

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.

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.

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.

• 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

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Redis maxmemory percent

Acceptable values are 1 to 75, inclusive.

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.

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.

• 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

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Redis connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Redis maxmemory percent

Acceptable values are 1 to 75, inclusive.

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.

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.

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

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.

• 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

Redis connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

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

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.

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.

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

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

Field

Description

enabled

boolean

Enable valkey-json module

version

string

Module version

Field

Description

enabled

boolean

Enable valkey-bloom module

version

string

Module version

Field

Description

zoneId

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.

subnetId

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.networkId.

The maximum string length in characters is 50.

shardName

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_-]*.

replicaPriority

string (int64)

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.

assignPublicIp

boolean

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.

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).

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

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

boolean

Is Redis user enabled

Field

Description

patterns

string

Keys patterns user has permission to.

pubSubChannels

string

Channel patterns user has permissions to.

categories

string

Command categories user has permissions to.

commands

string

Commands user can execute.

sanitizePayload

string

SanitizePayload parameter.

databases

string

Databases parameter.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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).

done

boolean

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

object

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

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

object

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.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.