Метод get
Возвращает указанный кластер Redis.
Чтобы получить список доступных резервных копий Redis, используйте запрос list.
HTTP-запрос
GET https://mdb.api.cloud.yandex.net/managed-redis/v1alpha/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"
},
"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"
}
Описание кластера 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 в виде пар |
environment | string Среда развертывания кластера Redis.
|
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. redisConfig_5_0 |
object Конфигурация сервера Redis 5.0. |
config. redisConfig_5_0. effectiveConfig |
object Действующие параметры для кластера Redis 5.0 (сочетание параметров, определенных в Поля и структура |
config. redisConfig_5_0. effectiveConfig. maxmemoryPolicy |
string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis.
|
config. redisConfig_5_0. effectiveConfig. timeout |
integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается. |
config. redisConfig_5_0. effectiveConfig. password |
string Пароль для аутентификации. Значение должно соответствовать регулярному выражению |
config. redisConfig_5_0. userConfig |
object Пользовательские настройки для кластера Redis 5.0. Поля и структура |
config. redisConfig_5_0. userConfig. maxmemoryPolicy |
string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis.
|
config. redisConfig_5_0. userConfig. timeout |
integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается. |
config. redisConfig_5_0. userConfig. password |
string Пароль для аутентификации. Значение должно соответствовать регулярному выражению |
config. redisConfig_5_0. defaultConfig |
object Конфигурация по умолчанию для кластера Redis 5.0. Поля и структура |
config. redisConfig_5_0. defaultConfig. maxmemoryPolicy |
string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis.
|
config. redisConfig_5_0. defaultConfig. timeout |
integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается. |
config. redisConfig_5_0. defaultConfig. password |
string Пароль для аутентификации. Значение должно соответствовать регулярному выражению |
networkId | string |
health | string Агрегированная работоспособность кластера.
|
status | string Состояние кластера
|