Метод get

HTTP-запрос
Path-параметры
Ответ

Возвращает указанный кластер Redis.

Чтобы получить список доступных резервных копий Redis, используйте запрос list.

HTTP-запрос

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

Path-параметры

Параметр	Описание
clusterId	Обязательное поле. Идентификатор возвращаемого кластера Redis. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

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"
    },
    "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
}

Описание кластера Redis. Подробнее смотрите в документации Managed Service for Redis.

Поле	Описание
id	string Идентификатор кластера Redis. Этот идентификатор генерирует MDB при создании.
folderId	string Идентификатор каталога, которому принадлежит кластер Redis.
createdAt	string (date-time) Время создания в формате RFC3339 . Строка в формате RFC3339.
name	string Имя кластера Redis. Имя уникально в рамках каталога. Длина имени должна быть от 3 до 63 символов.
description	string Описание кластера Redis. Длина описания должна быть от 0 до 256 символов.
labels	object Пользовательские метки для кластера Redis в виде пар `key:value`. Максимум 64 на кластер.
environment	string Среда развертывания кластера Redis. PRODUCTION: Стабильная среда с осторожной политикой обновления: во время регулярного обслуживания применяются только срочные исправления. PRESTABLE: Среда с более агрессивной политикой обновления: новые версии развертываются независимо от обратной совместимости.
monitoring[]	object Описание систем мониторинга, относящихся к данному кластеру Redis.
monitoring[]. name	string Название системы мониторинга.
monitoring[]. description	string Описание системы мониторинга.
monitoring[]. link	string Ссылка на графики системы мониторинга для кластера Redis.
config	object Конфигурация кластера Redis.
config. version	string Версия серверного программного обеспечения Redis.
config. resources	object Ресурсы, выделенные хостам Redis.
config. resources. resourcePresetId	string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации.
config. resources. diskSize	string (int64) Объем хранилища, доступного хосту, в байтах.
config. backupWindowStart	object Время запуска ежедневного резервного копирования, в часовом поясе UTC. Описывает время суток. Дата и часовой пояс либо не имеют значения, либо указаны другим образом. API может разрешить високосные секунды. Связанные типы: [google.type.Date][google.type.Date] и `google.protobuf.Timestamp`.
config. backupWindowStart. hours	integer (int32) Час в 24-часовом формате. Допустимые значения — от 0 до 23. API может разрешить значение "24:00:00" для таких сценариев, как время закрытия заведения.
config. backupWindowStart. minutes	integer (int32) Минута часа. Допустимые значения — от 0 до 59.
config. backupWindowStart. seconds	integer (int32) Секунда минуты. Обычно допустимые значения — от 0 до 59. API может разрешить значение 60, если поддерживаются високосные секунды.
config. backupWindowStart. nanos	integer (int32) Доли секунды, в наносекундах. Допустимые значения — от 0 до 999 999 999.
config. access	object Политика доступа к БД
config. access. dataLens	boolean (boolean) Разрешить доступ для DataLens
config. redisConfig_5_0	object Конфигурация сервера Redis 5.0.
config. redisConfig_5_0. effectiveConfig	object Действующие параметры для кластера Redis 5.0 (сочетание параметров, определенных в userConfig и [default_config]). Поля и структура `RedisConfig` отражает параметры файла конфигурации Redis.
config. redisConfig_5_0. effectiveConfig. maxmemoryPolicy	string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis. VOLATILE_LRU: Пытаться удалять менее востребованные (LRU) ключи с `expire set`. ALLKEYS_LRU: Удалять менее востребованные (LRU) ключи. VOLATILE_LFU: Пытаться удалять наименее часто используемые (LFU) ключи с `expire set`. ALLKEYS_LFU: Удалять наименее часто используемые (LFU) ключи. VOLATILE_RANDOM: Пытаться удалять ключи с `expire set` в случайном порядке. ALLKEYS_RANDOM: Удалять ключи случайным образом. VOLATILE_TTL: Пытаться сначала удалять менее востребованные (LRU) ключи с `expire set` и более коротким сроком жизни (TTL). NOEVICTION: Возвращать ошибки, когда память заполнена, и заданные команды могут потребовать больше памяти.
config. redisConfig_5_0. effectiveConfig. timeout	integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается.
config. redisConfig_5_0. effectiveConfig. password	string Пароль для аутентификации. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
config. redisConfig_5_0. userConfig	object Пользовательские настройки для кластера Redis 5.0. Поля и структура `RedisConfig` отражает параметры файла конфигурации Redis.
config. redisConfig_5_0. userConfig. maxmemoryPolicy	string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis. VOLATILE_LRU: Пытаться удалять менее востребованные (LRU) ключи с `expire set`. ALLKEYS_LRU: Удалять менее востребованные (LRU) ключи. VOLATILE_LFU: Пытаться удалять наименее часто используемые (LFU) ключи с `expire set`. ALLKEYS_LFU: Удалять наименее часто используемые (LFU) ключи. VOLATILE_RANDOM: Пытаться удалять ключи с `expire set` в случайном порядке. ALLKEYS_RANDOM: Удалять ключи случайным образом. VOLATILE_TTL: Пытаться сначала удалять менее востребованные (LRU) ключи с `expire set` и более коротким сроком жизни (TTL). NOEVICTION: Возвращать ошибки, когда память заполнена, и заданные команды могут потребовать больше памяти.
config. redisConfig_5_0. userConfig. timeout	integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается.
config. redisConfig_5_0. userConfig. password	string Пароль для аутентификации. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
config. redisConfig_5_0. defaultConfig	object Конфигурация по умолчанию для кластера Redis 5.0. Поля и структура `RedisConfig` отражает параметры файла конфигурации Redis.
config. redisConfig_5_0. defaultConfig. maxmemoryPolicy	string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis. VOLATILE_LRU: Пытаться удалять менее востребованные (LRU) ключи с `expire set`. ALLKEYS_LRU: Удалять менее востребованные (LRU) ключи. VOLATILE_LFU: Пытаться удалять наименее часто используемые (LFU) ключи с `expire set`. ALLKEYS_LFU: Удалять наименее часто используемые (LFU) ключи. VOLATILE_RANDOM: Пытаться удалять ключи с `expire set` в случайном порядке. ALLKEYS_RANDOM: Удалять ключи случайным образом. VOLATILE_TTL: Пытаться сначала удалять менее востребованные (LRU) ключи с `expire set` и более коротким сроком жизни (TTL). NOEVICTION: Возвращать ошибки, когда память заполнена, и заданные команды могут потребовать больше памяти.
config. redisConfig_5_0. defaultConfig. timeout	integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается.
config. redisConfig_5_0. defaultConfig. password	string Пароль для аутентификации. Значение должно соответствовать регулярному выражению `[a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}`.
networkId	string
health	string Агрегированная работоспособность кластера. HEALTH_UNKNOWN: Хост находится в неизвестном состоянии (у нас нет данных) ALIVE: Кластер жив и здоров (все хосты живы) DEAD: Кластер не работает и не может выполнять свои основные функции DEGRADED: Кластер частично жив (может выполнять некоторые из своих основных функций)
status	string Состояние кластера. STATUS_UNKNOWN: Состояние кластера неизвестно CREATING: Кластер создается RUNNING: Кластер работает нормально ERROR: Кластер отказал. UPDATING: Кластер изменяется. STOPPING: Кластер останавливается. STOPPED: Кластер остановлен. STARTING: Кластер запускается.
sharded	boolean (boolean) Включение/выключение режима Redis Cluster.