Method list

Retrieves the list of Redis clusters that belong to the specified folder.

HTTP request

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

Query parameters

Parameter Description
folderId Required. ID of the folder to list Redis clusters in. To get the folder ID, use a list request. The maximum string length in characters is 50.
pageSize The maximum number of results per page to return. If the number of available results is larger than pageSize, the service returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
pageToken Page token. To get the next page of results, set pageToken to the nextPageToken returned by a previous list request. The maximum string length in characters is 100.
filter A filter expression that filters clusters listed in the response. The expression must specify: 1. The field name. Currently you can only use filtering with the Cluster.name field. 2. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. 3. The value. Мust be 3-63 characters long and match the regular expression ^[a-z]([-a-z0-9]{,61}[a-z0-9])?$. The maximum string length in characters is 1000.

Response

HTTP Code: 200 - OK

{
  "clusters": [
    {
      "id": "string",
      "folderId": "string",
      "createdAt": "string",
      "name": "string",
      "description": "string",
      "labels": "object",
      "environment": "string",
      "monitoring": [
        {
          "name": "string",
          "description": "string",
          "link": "string"
        }
      ],
      "config": {
        "version": "string",
        "resources": {
          "resourcePresetId": "string",
          "diskSize": "string"
        },
        "backupWindowStart": {
          "hours": "integer",
          "minutes": "integer",
          "seconds": "integer",
          "nanos": "integer"
        },
        "access": {
          "dataLens": true
        },
        "redisConfig_5_0": {
          "effectiveConfig": {
            "maxmemoryPolicy": "string",
            "timeout": "integer",
            "password": "string"
          },
          "userConfig": {
            "maxmemoryPolicy": "string",
            "timeout": "integer",
            "password": "string"
          },
          "defaultConfig": {
            "maxmemoryPolicy": "string",
            "timeout": "integer",
            "password": "string"
          }
        }
      },
      "networkId": "string",
      "health": "string",
      "status": "string",
      "sharded": true
    }
  ],
  "nextPageToken": "string"
}
Field Description
clusters[] object

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

clusters[].
id
string

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

clusters[].
folderId
string

ID of the folder that the Redis cluster belongs to.

clusters[].
createdAt
string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

clusters[].
name
string

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

clusters[].
description
string

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

clusters[].
labels
object

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

clusters[].
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.
clusters[].
monitoring[]
object

Description of monitoring systems relevant to the Redis cluster.

clusters[].
monitoring[].
name
string

Name of the monitoring system.

clusters[].
monitoring[].
description
string

Description of the monitoring system.

clusters[].
monitoring[].
link
string

Link to the monitoring system charts for the Redis cluster.

clusters[].
config
object

Configuration of the Redis cluster.

clusters[].
config.
version
string

Version of Redis server software.

clusters[].
config.
resources
object
Resources allocated to Redis hosts.
clusters[].
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.

clusters[].
config.
resources.
diskSize
string (int64)

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

clusters[].
config.
backupWindowStart
object
Time to start the daily backup, in the UTC timezone.

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

clusters[].
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.

clusters[].
config.
backupWindowStart.
minutes
integer (int32)

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

clusters[].
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.

clusters[].
config.
backupWindowStart.
nanos
integer (int32)

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

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

Allow access for DataLens

clusters[].
config.
redisConfig_5_0
object
Configuration of a Redis 5.0 server.
clusters[].
config.
redisConfig_5_0.
effectiveConfig
object

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

Fields and structure of RedisConfig reflects Redis configuration file parameters.

clusters[].
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.
clusters[].
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.

clusters[].
config.
redisConfig_5_0.
effectiveConfig.
password
string

Authentication password.

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

clusters[].
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.

clusters[].
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.
clusters[].
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.

clusters[].
config.
redisConfig_5_0.
userConfig.
password
string

Authentication password.

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

clusters[].
config.
redisConfig_5_0.
defaultConfig
object

Default configuration for a Redis 5.0 cluster.

Fields and structure of RedisConfig reflects Redis configuration file parameters.

clusters[].
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.
clusters[].
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.

clusters[].
config.
redisConfig_5_0.
defaultConfig.
password
string

Authentication password.

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

clusters[].
networkId
string
clusters[].
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)
clusters[].
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.
clusters[].
sharded
boolean (boolean)

Redis cluster mode on/off.

nextPageToken string

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