Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex Managed Service for Redis
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Information about existing clusters
    • Creating clusters
    • Changing cluster and database settings
    • Connecting to a database
      • Preparing for connecting
      • Connecting to a non-sharded cluster
      • Connecting to a sharded cluster
    • Stopping and starting clusters
    • Updating a Redis version
    • Managing hosts in a cluster
    • Managing shards
    • Managing backups
    • Switching the master
    • Monitoring the state of clusters and hosts
    • Viewing cluster logs
    • Deleting clusters
  • Tutorials
    • All use cases
    • Storing PHP sessions in Managed Service for Redis
    • Migrating databases to Managed Service for Redis
  • Concepts
    • Relationships between service resources
    • Host classes
    • Network in Managed Service for Redis
    • Sharding
    • Backups
    • Replication and fault tolerance
    • Supported clients
    • Managing memory in Yandex Managed Service for Redis
    • Supported commands in Yandex Managed Service for Redis
    • Quotas and limits
    • Disk types
    • Maintenance
    • Redis settings
  • Access management
  • Pricing policy
    • Current pricing policy
    • Archive
      • Before February 1, 2020
  • API reference
    • Authentication in the API
    • gRPC
      • Overview
      • BackupService
      • ClusterService
      • ResourcePresetService
      • OperationService
    • REST
      • Overview
      • Backup
        • Overview
        • get
        • list
      • Cluster
        • Overview
        • addHosts
        • addShard
        • backup
        • create
        • delete
        • deleteHosts
        • deleteShard
        • get
        • getShard
        • list
        • listBackups
        • listHosts
        • listLogs
        • listOperations
        • listShards
        • move
        • rebalance
        • rescheduleMaintenance
        • restore
        • start
        • startFailover
        • stop
        • streamLogs
        • update
        • updateHosts
      • ResourcePreset
        • Overview
        • get
        • list
      • Operation
        • Overview
        • get
  • Revision history
  • Questions and answers
    • General questions
  1. API reference
  2. REST
  3. Cluster
  4. get

Managed Service for Redis API, REST: Cluster.get

Written by
Yandex Cloud
,
improved by
amatol
  • HTTP request
  • Path parameters
  • Response

Returns the specified Redis cluster.

To get the list of available Redis clusters, make a list request.

HTTP request

GET https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}

Path parameters

Parameter Description
clusterId

Required. ID of the Redis cluster to return. To get the cluster ID use a list request.

The maximum string length in characters is 50.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `config` 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": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      }
    },
    "redisConfig_6_0": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      }
    },
    "redisConfig_6_2": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      }
    },
    "redisConfig_7_0": {
      "effectiveConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "userConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      },
      "defaultConfig": {
        "maxmemoryPolicy": "string",
        "timeout": "integer",
        "password": "string",
        "databases": "integer",
        "slowlogLogSlowerThan": "integer",
        "slowlogMaxLen": "integer",
        "notifyKeyspaceEvents": "string",
        "clientOutputBufferLimitPubsub": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        },
        "clientOutputBufferLimitNormal": {
          "hardLimit": "integer",
          "softLimit": "integer",
          "softSeconds": "integer"
        }
      }
    },
    // end of the list of possible fields`config`

  },
  "networkId": "string",
  "health": "string",
  "status": "string",
  "sharded": true,
  "maintenanceWindow": {

    // `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": {},
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    },
    // end of the list of possible fields`maintenanceWindow`

  },
  "plannedOperation": {
    "info": "string",
    "delayedUntil": "string"
  },
  "securityGroupIds": [
    "string"
  ],
  "tlsEnabled": true,
  "deletionProtection": true,
  "persistenceMode": "string"
}

Description of a Redis cluster. For more information, see
the Managed Service for Redis documentation.

Field Description
id string

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

folderId string

ID of the folder that the Redis cluster belongs to.

createdAt string (date-time)

Creation timestamp in RFC3339 text format.

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

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

name string

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

description string

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

labels object

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

environment string

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[] object

Description of monitoring systems relevant to the Redis cluster.

monitoring[].
name
string

Name of the monitoring system.

monitoring[].
description
string

Description of the monitoring system.

monitoring[].
link
string

Link to the monitoring system charts for the Redis cluster.

config object

Configuration of the Redis cluster.

config.
version
string

Version of Redis server software.

config.
resources
object
Resources allocated to Redis hosts.
config.
resources.
resourcePresetId
string

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

config.
resources.
diskSize
string (int64)

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

config.
resources.
diskTypeId
string

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

  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.
config.
backupWindowStart
object
Time to start the daily backup, in the UTC timezone.
config.
backupWindowStart.
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.

config.
backupWindowStart.
minutes
integer (int32)

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

config.
backupWindowStart.
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.

config.
backupWindowStart.
nanos
integer (int32)

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

config.
access
object
Access policy to DB
config.
access.
dataLens
boolean (boolean)

Allow access for DataLens

config.
redisConfig_5_0
object
Configuration of a Redis 5.0 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0
config.
redisConfig_5_0.
effectiveConfig
object

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

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_5_0.
effectiveConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_5_0.
effectiveConfig.
timeout
integer (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.

config.
redisConfig_5_0.
effectiveConfig.
password
string

Authentication password.

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

config.
redisConfig_5_0.
effectiveConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_5_0.
effectiveConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_5_0.
effectiveConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig
object

User-defined settings for a Redis 5.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_5_0.
userConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_5_0.
userConfig.
timeout
integer (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.

config.
redisConfig_5_0.
userConfig.
password
string

Authentication password.

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

config.
redisConfig_5_0.
userConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_5_0.
userConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_5_0.
userConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig
object

Default configuration for a Redis 5.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_5_0.
defaultConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_5_0.
defaultConfig.
timeout
integer (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.

config.
redisConfig_5_0.
defaultConfig.
password
string

Authentication password.

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

config.
redisConfig_5_0.
defaultConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_5_0.
defaultConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_5_0.
defaultConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_0
object
Configuration of a Redis 6.0 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0
config.
redisConfig_6_0.
effectiveConfig
object

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

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_6_0.
effectiveConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_6_0.
effectiveConfig.
timeout
integer (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.

config.
redisConfig_6_0.
effectiveConfig.
password
string

Authentication password.

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

config.
redisConfig_6_0.
effectiveConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_6_0.
effectiveConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_0.
effectiveConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig
object

User-defined settings for a Redis 6.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_6_0.
userConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_6_0.
userConfig.
timeout
integer (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.

config.
redisConfig_6_0.
userConfig.
password
string

Authentication password.

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

config.
redisConfig_6_0.
userConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_6_0.
userConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_0.
userConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig
object

Default configuration for a Redis 6.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_6_0.
defaultConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_6_0.
defaultConfig.
timeout
integer (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.

config.
redisConfig_6_0.
defaultConfig.
password
string

Authentication password.

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

config.
redisConfig_6_0.
defaultConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_6_0.
defaultConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_0.
defaultConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_2
object
Configuration of a Redis 6.2 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0
config.
redisConfig_6_2.
effectiveConfig
object

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

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_6_2.
effectiveConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_6_2.
effectiveConfig.
timeout
integer (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.

config.
redisConfig_6_2.
effectiveConfig.
password
string

Authentication password.

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

config.
redisConfig_6_2.
effectiveConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_6_2.
effectiveConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_2.
effectiveConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig
object

User-defined settings for a Redis 6.2 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_6_2.
userConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_6_2.
userConfig.
timeout
integer (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.

config.
redisConfig_6_2.
userConfig.
password
string

Authentication password.

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

config.
redisConfig_6_2.
userConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_6_2.
userConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_2.
userConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig
object

Default configuration for a Redis 6.2 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_6_2.
defaultConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_6_2.
defaultConfig.
timeout
integer (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.

config.
redisConfig_6_2.
defaultConfig.
password
string

Authentication password.

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

config.
redisConfig_6_2.
defaultConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_6_2.
defaultConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_6_2.
defaultConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_7_0
object
Configuration of a Redis 7.0 server.
config includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0
config.
redisConfig_7_0.
effectiveConfig
object

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

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_7_0.
effectiveConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_7_0.
effectiveConfig.
timeout
integer (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.

config.
redisConfig_7_0.
effectiveConfig.
password
string

Authentication password.

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

config.
redisConfig_7_0.
effectiveConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_7_0.
effectiveConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_7_0.
effectiveConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig
object

User-defined settings for a Redis 7.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_7_0.
userConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_7_0.
userConfig.
timeout
integer (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.

config.
redisConfig_7_0.
userConfig.
password
string

Authentication password.

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

config.
redisConfig_7_0.
userConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_7_0.
userConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_7_0.
userConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig
object

Default configuration for a Redis 7.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

config.
redisConfig_7_0.
defaultConfig.
maxmemoryPolicy
string

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.
config.
redisConfig_7_0.
defaultConfig.
timeout
integer (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.

config.
redisConfig_7_0.
defaultConfig.
password
string

Authentication password.

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

config.
redisConfig_7_0.
defaultConfig.
databases
integer (int64)

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

Value must be greater than 0.

config.
redisConfig_7_0.
defaultConfig.
slowlogLogSlowerThan
integer (int64)

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

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
slowlogMaxLen
integer (int64)

Max slow requests number to log.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
notifyKeyspaceEvents
string

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

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

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitPubsub
object

Redis connection output buffers limits for pubsub operations.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitPubsub.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitPubsub.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitPubsub.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitNormal
object

Redis connection output buffers limits for clients.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitNormal.
hardLimit
integer (int64)

Total limit in bytes.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitNormal.
softLimit
integer (int64)

Limit in bytes during certain time period.

The minimum value is 0.

config.
redisConfig_7_0.
defaultConfig.
clientOutputBufferLimitNormal.
softSeconds
integer (int64)

Seconds for soft limit.

The minimum value is 0.

networkId string
health string

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 string

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 (boolean)

Redis cluster mode on/off.

maintenanceWindow object

Maintenance window for the cluster.

A maintenance window settings.

maintenanceWindow.
anytime
object
Maintenance operation can be scheduled anytime.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow
object
Maintenance operation can be scheduled on a weekly basis.
maintenanceWindow includes only one of the fields anytime, weeklyMaintenanceWindow
maintenanceWindow.
weeklyMaintenanceWindow.
day
string

Day of the week (in DDD format).

maintenanceWindow.
weeklyMaintenanceWindow.
hour
string (int64)

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

Acceptable values are 1 to 24, inclusive.

plannedOperation object

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

A planned maintenance operation.

plannedOperation.
info
string

Information about this maintenance operation.

The maximum string length in characters is 256.

plannedOperation.
delayedUntil
string (date-time)

Time until which this maintenance operation is delayed.

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

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

securityGroupIds[] string

User security groups

tlsEnabled boolean (boolean)

TLS port and functionality on\off

deletionProtection boolean (boolean)

Deletion Protection inhibits deletion of the cluster

persistenceMode string

Persistence mode

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • HTTP request
  • Path parameters
  • Response