Managed Service for Redis API, gRPC: ClusterService.Update
- gRPC request
- UpdateClusterRequest
- ConfigSpec
- RedisConfig5_0
- ClientOutputBufferLimit
- RedisConfig6_0
- ClientOutputBufferLimit
- RedisConfig6_2
- ClientOutputBufferLimit
- RedisConfig7_0
- ClientOutputBufferLimit
- Resources
- Access
- RedisConfig
- ClientOutputBufferLimit
- DiskSizeAutoscaling
- ValkeyModules
- ValkeySearch
- ValkeyJson
- ValkeyBloom
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- operation.Operation
Updates the specified Redis cluster.
gRPC request
rpc Update (UpdateClusterRequest) returns (operation.Operation)
UpdateClusterRequest
{
"cluster_id": "string",
"update_mask": "google.protobuf.FieldMask",
"description": "string",
"labels": "map<string, string>",
"config_spec": {
"version": "string",
// Includes only one of the fields `redis_config_5_0`, `redis_config_6_0`, `redis_config_6_2`, `redis_config_7_0`
"redis_config_5_0": {
"maxmemory_policy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlog_log_slower_than": "google.protobuf.Int64Value",
"slowlog_max_len": "google.protobuf.Int64Value",
"notify_keyspace_events": "string",
"client_output_buffer_limit_pubsub": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"client_output_buffer_limit_normal": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
}
},
"redis_config_6_0": {
"maxmemory_policy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlog_log_slower_than": "google.protobuf.Int64Value",
"slowlog_max_len": "google.protobuf.Int64Value",
"notify_keyspace_events": "string",
"client_output_buffer_limit_pubsub": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"client_output_buffer_limit_normal": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
}
},
"redis_config_6_2": {
"maxmemory_policy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlog_log_slower_than": "google.protobuf.Int64Value",
"slowlog_max_len": "google.protobuf.Int64Value",
"notify_keyspace_events": "string",
"client_output_buffer_limit_pubsub": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"client_output_buffer_limit_normal": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"maxmemory_percent": "google.protobuf.Int64Value"
},
"redis_config_7_0": {
"maxmemory_policy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlog_log_slower_than": "google.protobuf.Int64Value",
"slowlog_max_len": "google.protobuf.Int64Value",
"notify_keyspace_events": "string",
"client_output_buffer_limit_pubsub": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"client_output_buffer_limit_normal": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"maxmemory_percent": "google.protobuf.Int64Value"
},
// end of the list of possible fields
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"backup_window_start": "google.type.TimeOfDay",
"access": {
"data_lens": "bool",
"web_sql": "bool"
},
"redis": {
"maxmemory_policy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlog_log_slower_than": "google.protobuf.Int64Value",
"slowlog_max_len": "google.protobuf.Int64Value",
"notify_keyspace_events": "string",
"client_output_buffer_limit_pubsub": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"client_output_buffer_limit_normal": {
"hard_limit": "google.protobuf.Int64Value",
"soft_limit": "google.protobuf.Int64Value",
"soft_seconds": "google.protobuf.Int64Value"
},
"maxmemory_percent": "google.protobuf.Int64Value",
"lua_time_limit": "google.protobuf.Int64Value",
"repl_backlog_size_percent": "google.protobuf.Int64Value",
"cluster_require_full_coverage": "google.protobuf.BoolValue",
"cluster_allow_reads_when_down": "google.protobuf.BoolValue",
"cluster_allow_pubsubshard_when_down": "google.protobuf.BoolValue",
"lfu_decay_time": "google.protobuf.Int64Value",
"lfu_log_factor": "google.protobuf.Int64Value",
"turn_before_switchover": "google.protobuf.BoolValue",
"allow_data_loss": "google.protobuf.BoolValue",
"use_luajit": "google.protobuf.BoolValue",
"io_threads_allowed": "google.protobuf.BoolValue",
"zset_max_listpack_entries": "google.protobuf.Int64Value",
"aof_max_size_percent": "google.protobuf.Int64Value",
"activedefrag": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue"
},
"disk_size_autoscaling": {
"planned_usage_threshold": "google.protobuf.Int64Value",
"emergency_usage_threshold": "google.protobuf.Int64Value",
"disk_size_limit": "google.protobuf.Int64Value"
},
"backup_retain_period_days": "google.protobuf.Int64Value",
"modules": {
"valkey_search": {
"enabled": "bool",
"reader_threads": "google.protobuf.Int64Value",
"writer_threads": "google.protobuf.Int64Value",
"version": "string"
},
"valkey_json": {
"enabled": "bool",
"version": "string"
},
"valkey_bloom": {
"enabled": "bool",
"version": "string"
}
}
},
"name": "string",
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"security_group_ids": [
"string"
],
"deletion_protection": "bool",
"persistence_mode": "PersistenceMode",
"network_id": "string",
"announce_hostnames": "bool",
"auth_sentinel": "bool"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Redis cluster to update. The maximum string length in characters is 50. |
|
update_mask |
Field mask that specifies which fields of the Redis cluster should be updated. |
|
description |
string New description of the Redis cluster. The maximum string length in characters is 256. |
|
labels |
object (map<string, string>) Custom labels for the Redis cluster as The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression |
|
config_spec |
New configuration and resources for hosts in the cluster. |
|
name |
string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression |
|
maintenance_window |
New maintenance window settings for the cluster. |
|
security_group_ids[] |
string User security groups |
|
deletion_protection |
bool Deletion Protection inhibits deletion of the cluster |
|
persistence_mode |
enum PersistenceMode Persistence mode
|
|
network_id |
string ID of the network to move the cluster to. The maximum string length in characters is 150. |
|
announce_hostnames |
bool Enable FQDN instead of ip |
|
auth_sentinel |
bool Allows to use ACL users to auth in sentinel |
ConfigSpec
|
Field |
Description |
|
version |
string Version of Redis used in the cluster. |
|
redis_config_5_0 |
Configuration of a Redis 5.0 server. Includes only one of the fields Configuration of a Redis cluster. |
|
redis_config_6_0 |
Configuration of a Redis 6.0 server. Includes only one of the fields Configuration of a Redis cluster. |
|
redis_config_6_2 |
Configuration of a Redis 6.2 server. Includes only one of the fields Configuration of a Redis cluster. |
|
redis_config_7_0 |
Configuration of a Redis 7.0 server. Includes only one of the fields Configuration of a Redis cluster. |
|
resources |
Resources allocated to Redis hosts. |
|
backup_window_start |
Time to start the daily backup, in the UTC timezone. |
|
access |
Access policy to DB |
|
redis |
Unified configuration of a Redis cluster |
|
disk_size_autoscaling |
Disk size autoscaling settings |
|
backup_retain_period_days |
Retain period of automatically created backup in days Acceptable values are 7 to 60, inclusive. |
|
modules |
Valkey modules settings |
RedisConfig5_0
Fields and structure of RedisConfig reflects Redis configuration file
parameters.
|
Field |
Description |
|
maxmemory_policy |
enum MaxmemoryPolicy Redis key eviction policy for a dataset that reaches maximum memory,
|
|
timeout |
Time that Redis keeps the connection open while the client is idle. Value must be greater than 0. |
|
password |
string Authentication password. The string length in characters must be 8-128. Value must match the regular expression |
|
databases |
Number of database buckets on a single redis-server process. Value must be greater than 0. |
|
slowlog_log_slower_than |
Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
|
slowlog_max_len |
Max slow requests number to log. The minimum value is 0. |
|
notify_keyspace_events |
string String setting for pub\sub functionality. Value must match the regular expression |
|
client_output_buffer_limit_pubsub |
Redis connection output buffers limits for pubsub operations. |
|
client_output_buffer_limit_normal |
Redis connection output buffers limits for clients. |
ClientOutputBufferLimit
|
Field |
Description |
|
hard_limit |
Total limit in bytes. The minimum value is 0. |
|
soft_limit |
Limit in bytes during certain time period. The minimum value is 0. |
|
soft_seconds |
Seconds for soft limit. The minimum value is 0. |
RedisConfig6_0
Fields and structure of RedisConfig reflects Redis configuration file
parameters.
|
Field |
Description |
|
maxmemory_policy |
enum MaxmemoryPolicy Redis key eviction policy for a dataset that reaches maximum memory,
|
|
timeout |
Time that Redis keeps the connection open while the client is idle. Value must be greater than 0. |
|
password |
string Authentication password. The string length in characters must be 8-128. Value must match the regular expression |
|
databases |
Number of database buckets on a single redis-server process. Value must be greater than 0. |
|
slowlog_log_slower_than |
Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
|
slowlog_max_len |
Max slow requests number to log. The minimum value is 0. |
|
notify_keyspace_events |
string String setting for pub\sub functionality. Value must match the regular expression |
|
client_output_buffer_limit_pubsub |
Redis connection output buffers limits for pubsub operations. |
|
client_output_buffer_limit_normal |
Redis connection output buffers limits for clients. |
ClientOutputBufferLimit
|
Field |
Description |
|
hard_limit |
Total limit in bytes. The minimum value is 0. |
|
soft_limit |
Limit in bytes during certain time period. The minimum value is 0. |
|
soft_seconds |
Seconds for soft limit. The minimum value is 0. |
RedisConfig6_2
Fields and structure of RedisConfig reflects Redis configuration file
parameters.
|
Field |
Description |
|
maxmemory_policy |
enum MaxmemoryPolicy Redis key eviction policy for a dataset that reaches maximum memory,
|
|
timeout |
Time that Redis keeps the connection open while the client is idle. The minimum value is 0. |
|
password |
string Authentication password. The string length in characters must be 8-128. Value must match the regular expression |
|
databases |
Number of database buckets on a single redis-server process. Value must be greater than 0. |
|
slowlog_log_slower_than |
Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
|
slowlog_max_len |
Max slow requests number to log. The minimum value is 0. |
|
notify_keyspace_events |
string String setting for pub\sub functionality. Value must match the regular expression |
|
client_output_buffer_limit_pubsub |
Redis connection output buffers limits for pubsub operations. |
|
client_output_buffer_limit_normal |
Redis connection output buffers limits for clients. |
|
maxmemory_percent |
Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
ClientOutputBufferLimit
|
Field |
Description |
|
hard_limit |
Total limit in bytes. The minimum value is 0. |
|
soft_limit |
Limit in bytes during certain time period. The minimum value is 0. |
|
soft_seconds |
Seconds for soft limit. The minimum value is 0. |
RedisConfig7_0
Fields and structure of RedisConfig reflects Redis configuration file
parameters.
|
Field |
Description |
|
maxmemory_policy |
enum MaxmemoryPolicy Redis key eviction policy for a dataset that reaches maximum memory,
|
|
timeout |
Time that Redis keeps the connection open while the client is idle. The minimum value is 0. |
|
password |
string Authentication password. The string length in characters must be 8-128. Value must match the regular expression |
|
databases |
Number of database buckets on a single redis-server process. Value must be greater than 0. |
|
slowlog_log_slower_than |
Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
|
slowlog_max_len |
Max slow requests number to log. The minimum value is 0. |
|
notify_keyspace_events |
string String setting for pub\sub functionality. Value must match the regular expression |
|
client_output_buffer_limit_pubsub |
Redis connection output buffers limits for pubsub operations. |
|
client_output_buffer_limit_normal |
Redis connection output buffers limits for clients. |
|
maxmemory_percent |
Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
ClientOutputBufferLimit
|
Field |
Description |
|
hard_limit |
Total limit in bytes. The minimum value is 0. |
|
soft_limit |
Limit in bytes during certain time period. The minimum value is 0. |
|
soft_seconds |
Seconds for soft limit. The minimum value is 0. |
Resources
|
Field |
Description |
|
resource_preset_id |
string Required field. ID of the preset for computational resources available to a host (CPU, memory etc.). |
|
disk_size |
int64 Volume of the storage available to a host, in bytes. |
|
disk_type_id |
string Type of the storage environment for the host.
|
Access
|
Field |
Description |
|
data_lens |
bool Allow access for DataLens |
|
web_sql |
bool Allow access for Web SQL. |
RedisConfig
Fields and structure of RedisConfig reflects Redis configuration file
parameters.
|
Field |
Description |
|
maxmemory_policy |
enum MaxmemoryPolicy Redis key eviction policy for a dataset that reaches maximum memory,
|
|
timeout |
Time that Redis keeps the connection open while the client is idle. The minimum value is 0. |
|
password |
string Authentication password. |
|
databases |
Number of database buckets on a single redis-server process. Acceptable values are 1 to 1024, inclusive. |
|
slowlog_log_slower_than |
Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 10. |
|
slowlog_max_len |
Max slow requests number to log. The minimum value is 0. |
|
notify_keyspace_events |
string String setting for pub\sub functionality. |
|
client_output_buffer_limit_pubsub |
Redis connection output buffers limits for pubsub operations. |
|
client_output_buffer_limit_normal |
Redis connection output buffers limits for clients. |
|
maxmemory_percent |
Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
|
lua_time_limit |
Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism Acceptable values are 0 to 5000, inclusive. |
|
repl_backlog_size_percent |
Replication backlog size as a percentage of flavor maxmemory Acceptable values are 1 to 75, inclusive. |
|
cluster_require_full_coverage |
Controls whether all hash slots must be covered by nodes |
|
cluster_allow_reads_when_down |
Allows read operations when cluster is down |
|
cluster_allow_pubsubshard_when_down |
Permits Pub/Sub shard operations when cluster is down |
|
lfu_decay_time |
The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10) Acceptable values are 0 to 100000, inclusive. |
|
lfu_log_factor |
Determines how the frequency counter represents key hits. Acceptable values are 0 to 1000, inclusive. |
|
turn_before_switchover |
Allows to turn before switchover in RDSync |
|
allow_data_loss |
Allows some data to be lost in favor of faster switchover/restart |
|
use_luajit |
Use JIT for lua scripts and functions |
|
io_threads_allowed |
Allow redis to use io-threads |
|
zset_max_listpack_entries |
Controls max number of entries in zset before conversion from memory-efficient listpack to CPU-efficient hash table and skiplist Acceptable values are 32 to 2048, inclusive. |
|
aof_max_size_percent |
AOF maximum size as a percentage of disk available Acceptable values are 1 to 99, inclusive. |
|
activedefrag |
Enable active (online) memory defragmentation |
|
audit_log |
Enable/disable audit logs for Valkey |
ClientOutputBufferLimit
|
Field |
Description |
|
hard_limit |
Total limit in bytes. The minimum value is 0. |
|
soft_limit |
Limit in bytes during certain time period. The minimum value is 0. |
|
soft_seconds |
Seconds for soft limit. The minimum value is 0. |
DiskSizeAutoscaling
|
Field |
Description |
|
planned_usage_threshold |
Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
|
emergency_usage_threshold |
Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
|
disk_size_limit |
Limit on how large the storage for database instances can automatically grow, in bytes. |
ValkeyModules
|
Field |
Description |
|
valkey_search |
valkey-search module settings |
|
valkey_json |
valkey-json module settings |
|
valkey_bloom |
valkey-bloom module settings |
ValkeySearch
|
Field |
Description |
|
enabled |
bool Enable valkey-search module |
|
reader_threads |
Controls the amount of threads executing queries The minimum value is 0. |
|
writer_threads |
Controls the amount of threads processing index mutations The minimum value is 0. |
|
version |
string Module version |
ValkeyJson
|
Field |
Description |
|
enabled |
bool Enable valkey-json module |
|
version |
string Module version |
ValkeyBloom
|
Field |
Description |
|
enabled |
bool Enable valkey-bloom module |
|
version |
string Module version |
MaintenanceWindow
A maintenance window settings.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weekly_maintenance_window |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in Acceptable values are 1 to 24, inclusive. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |