Метод update
Изменяет указанный кластер Redis.
HTTP-запрос
PATCH https://mdb.api.cloud.yandex.net/managed-redis/v1alpha/clusters/{clusterId}
Path-параметры
Параметр | Описание |
---|---|
clusterId | Обязательное поле. Идентификатор кластера Redis, который следует обновить. Чтобы получить идентификатор кластера, используйте запрос list. Максимальная длина строки в символах — 50. |
Параметры в теле запроса
{
"updateMask": "string",
"description": "string",
"labels": "object",
"configSpec": {
"version": "string",
"resources": {
"resourcePresetId": "string",
"diskSize": "string"
},
"redisConfig_5_0": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string"
}
},
"name": "string"
}
Поле | Описание |
---|---|
updateMask | string Маска, которая указывает, какие поля кластера Redis должны быть изменены. Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре Если в запросе не передается |
description | string Новое описание кластера Redis. Максимальная длина строки в символах — 256. |
labels | object Пользовательские метки для кластера Redis как Новый набор меток полностью заменит старый. Чтобы добавить метку, запросите текущий набор меток с помощью метода get, затем отправьте запрос update, добавив новую метку в этот набор. Не более 64 на ресурс. Максимальная длина строки в символах для каждого ключа — 63. Каждый ключ должен соответствовать регулярному выражению |
configSpec | object Новая конфигурация и ресурсы для хостов кластера. |
configSpec. version |
string Версия Redis, используемая в кластере. Единственное возможное значение — |
configSpec. resources |
object Ресурсы, выделенные хостам Redis. |
configSpec. resources. resourcePresetId |
string Идентификатор набора вычислительных ресурсов, доступных хосту (процессор, память и т. д.). Все доступные наборы ресурсов перечислены в документации. |
configSpec. resources. diskSize |
string (int64) Объем хранилища, доступного хосту, в байтах. |
configSpec. redisConfig_5_0 |
object Поля и структура |
configSpec. redisConfig_5_0. maxmemoryPolicy |
string Политика Redis для отбрасывания ключей из набора данных, который достиг максимального объема памяти, доступного на хосте. Параметр maxmemory зависит от host class Managed Service for Redis. Все политики подробно описаны в документации Redis.
|
configSpec. redisConfig_5_0. timeout |
integer (int64) Время, в течение которого Redis сохраняет подключение открытым, пока клиент бездействует. Если в течение этого времени не получена команда, соединение закрывается. |
configSpec. redisConfig_5_0. password |
string Пароль для аутентификации. Значение должно соответствовать регулярному выражению |
name | string Новое имя кластера. Максимальная длина строки в символах — 63. Значение должно соответствовать регулярному выражению |
Ответ
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"metadata": "object",
// включает только одно из полей `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": "object",
// конец списка возможных полей
}
Ресурс Operation. Дополнительные сведения см. в разделе
Объект Operation.
Поле | Описание |
---|---|
id | string Идентификатор операции. |
description | string Описание операции. Длина описания должна быть от 0 до 256 символов. |
createdAt | string (date-time) Время создания ресурса в формате в RFC3339. Строка в формате RFC3339. |
createdBy | string Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию. |
modifiedAt | string (date-time) Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339. Строка в формате RFC3339. |
done | boolean (boolean) Если значение равно |
metadata | object Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |
error | object Описание ошибки в случае сбоя или отмены операции. включает только одно из полей error , response Описание ошибки в случае сбоя или отмены операции. |
error. code |
integer (int32) Код ошибки. Значение из списка google.rpc.Code. |
error. message |
string Текст ошибки. |
error. details[] |
object Список сообщений с подробными сведениями об ошибке. |
response | object включает только одно из полей error , response Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля |