Managed Service for Redis API, REST: Cluster.Update
- HTTP request
- Path parameters
- Body parameters
- ConfigSpec
- RedisConfig5_0
- ClientOutputBufferLimit
- RedisConfig6_0
- ClientOutputBufferLimit
- RedisConfig6_2
- ClientOutputBufferLimit
- RedisConfig7_0
- ClientOutputBufferLimit
- Resources
- TimeOfDay
- Access
- RedisConfig
- ClientOutputBufferLimit
- DiskSizeAutoscaling
- MaintenanceWindow
- WeeklyMaintenanceWindow
- Response
- UpdateClusterMetadata
- Status
- Cluster
- Monitoring
- ClusterConfig
- RedisConfigSet5_0
- RedisConfig5_0
- ClientOutputBufferLimit
- RedisConfigSet6_0
- RedisConfig6_0
- ClientOutputBufferLimit
- RedisConfigSet6_2
- RedisConfig6_2
- ClientOutputBufferLimit
- RedisConfigSet7_0
- RedisConfig7_0
- ClientOutputBufferLimit
- Resources
- TimeOfDay
- Access
- RedisConfigSet
- RedisConfig
- ClientOutputBufferLimit
- DiskSizeAutoscaling
- MaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Updates the specified Redis cluster.
HTTP request
PATCH https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/{clusterId}
Path parameters
Field |
Description |
clusterId |
string Required field. ID of the Redis cluster to update. |
Body parameters
{
"updateMask": "string",
"description": "string",
"labels": "string",
"configSpec": {
"version": "string",
// Includes only one of the fields `redisConfig_5_0`, `redisConfig_6_0`, `redisConfig_6_2`, `redisConfig_7_0`
"redisConfig_5_0": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
},
"redisConfig_6_0": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
},
"redisConfig_6_2": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
},
"redisConfig_7_0": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
},
// end of the list of possible fields
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": "boolean",
"webSql": "boolean"
},
"redis": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string",
"luaTimeLimit": "string",
"replBacklogSizePercent": "string",
"clusterRequireFullCoverage": "boolean",
"clusterAllowReadsWhenDown": "boolean",
"clusterAllowPubsubshardWhenDown": "boolean",
"lfuDecayTime": "string",
"lfuLogFactor": "string",
"turnBeforeSwitchover": "boolean",
"allowDataLoss": "boolean"
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
},
"name": "string",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "object",
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
}
// end of the list of possible fields
},
"securityGroupIds": [
"string"
],
"deletionProtection": "boolean",
"persistenceMode": "string",
"networkId": "string",
"announceHostnames": "boolean"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
description |
string New description of the Redis cluster. |
labels |
string Custom labels for the Redis cluster as The new set of labels will completely replace the old ones. To add a label, request the current |
configSpec |
New configuration and resources for hosts in the cluster. |
name |
string New name for the cluster. |
maintenanceWindow |
New maintenance window settings for the cluster. |
securityGroupIds[] |
string User security groups |
deletionProtection |
boolean Deletion Protection inhibits deletion of the cluster |
persistenceMode |
enum (PersistenceMode) Persistence mode
|
networkId |
string ID of the network to move the cluster to. |
announceHostnames |
boolean Enable FQDN instead of ip |
ConfigSpec
Field |
Description |
version |
string Version of Redis used in the cluster. |
redisConfig_5_0 |
Includes only one of the fields Configuration of a Redis cluster. |
redisConfig_6_0 |
Includes only one of the fields Configuration of a Redis cluster. |
redisConfig_6_2 |
Includes only one of the fields Configuration of a Redis cluster. |
redisConfig_7_0 |
Includes only one of the fields Configuration of a Redis cluster. |
resources |
Resources allocated to Redis hosts. |
backupWindowStart |
Time to start the daily backup, in the UTC timezone. |
access |
Access policy to DB |
redis |
Unified configuration of a Redis cluster |
diskSizeAutoscaling |
Disk size autoscaling settings |
RedisConfig5_0
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
RedisConfig6_0
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
RedisConfig6_2
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
maxmemoryPercent |
string (int64) Redis maxmemory percent |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
RedisConfig7_0
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
maxmemoryPercent |
string (int64) Redis maxmemory percent |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
Resources
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host.
|
TimeOfDay
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
Field |
Description |
hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
Access
Field |
Description |
dataLens |
boolean Allow access for DataLens |
webSql |
boolean Allow access for Web SQL. |
RedisConfig
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
maxmemoryPercent |
string (int64) Redis maxmemory percent |
luaTimeLimit |
string (int64) Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism |
replBacklogSizePercent |
string (int64) Replication backlog size as a percentage of flavor maxmemory |
clusterRequireFullCoverage |
boolean Controls whether all hash slots must be covered by nodes |
clusterAllowReadsWhenDown |
boolean Allows read operations when cluster is down |
clusterAllowPubsubshardWhenDown |
boolean Permits Pub/Sub shard operations when cluster is down |
lfuDecayTime |
string (int64) 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) |
lfuLogFactor |
string (int64) Determines how the frequency counter represents key hits. |
turnBeforeSwitchover |
boolean Allows to turn before switchover in RDSync |
allowDataLoss |
boolean Allows some data to be lost in favor of faster switchover/restart |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
DiskSizeAutoscaling
Field |
Description |
plannedUsageThreshold |
string (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. |
emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. |
diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
MaintenanceWindow
A maintenance window settings.
Field |
Description |
anytime |
object Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
weeklyMaintenanceWindow |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
WeeklyMaintenanceWindow
Weelky maintenance window settings.
Field |
Description |
day |
enum (WeekDay) Day of the week (in
|
hour |
string (int64) Hour of the day in UTC (in |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"clusterId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"folderId": "string",
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "string",
"environment": "string",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
// Includes only one of the fields `redisConfig_5_0`, `redisConfig_6_0`, `redisConfig_6_2`, `redisConfig_7_0`
"redisConfig_5_0": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
}
},
"redisConfig_6_0": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
}
}
},
"redisConfig_6_2": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
}
},
"redisConfig_7_0": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string"
}
},
// end of the list of possible fields
"resources": {
"resourcePresetId": "string",
"diskSize": "string",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": "boolean",
"webSql": "boolean"
},
"redis": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string",
"luaTimeLimit": "string",
"replBacklogSizePercent": "string",
"clusterRequireFullCoverage": "boolean",
"clusterAllowReadsWhenDown": "boolean",
"clusterAllowPubsubshardWhenDown": "boolean",
"lfuDecayTime": "string",
"lfuLogFactor": "string",
"turnBeforeSwitchover": "boolean",
"allowDataLoss": "boolean"
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string",
"luaTimeLimit": "string",
"replBacklogSizePercent": "string",
"clusterRequireFullCoverage": "boolean",
"clusterAllowReadsWhenDown": "boolean",
"clusterAllowPubsubshardWhenDown": "boolean",
"lfuDecayTime": "string",
"lfuLogFactor": "string",
"turnBeforeSwitchover": "boolean",
"allowDataLoss": "boolean"
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "string",
"password": "string",
"databases": "string",
"slowlogLogSlowerThan": "string",
"slowlogMaxLen": "string",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "string",
"softLimit": "string",
"softSeconds": "string"
},
"maxmemoryPercent": "string",
"luaTimeLimit": "string",
"replBacklogSizePercent": "string",
"clusterRequireFullCoverage": "boolean",
"clusterAllowReadsWhenDown": "boolean",
"clusterAllowPubsubshardWhenDown": "boolean",
"lfuDecayTime": "string",
"lfuLogFactor": "string",
"turnBeforeSwitchover": "boolean",
"allowDataLoss": "boolean"
}
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "string",
"emergencyUsageThreshold": "string",
"diskSizeLimit": "string"
}
},
"networkId": "string",
"health": "string",
"status": "string",
"sharded": "boolean",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "object",
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
}
// end of the list of possible fields
},
"plannedOperation": {
"info": "string",
"delayedUntil": "string"
},
"securityGroupIds": [
"string"
],
"tlsEnabled": "boolean",
"deletionProtection": "boolean",
"persistenceMode": "string",
"announceHostnames": "boolean"
}
// 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. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean 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. |
UpdateClusterMetadata
Field |
Description |
clusterId |
string ID of the Redis cluster that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Cluster
Description of a Redis cluster. For more information, see
the Managed Service for Redis documentation.
Field |
Description |
id |
string ID of the Redis cluster. |
folderId |
string ID of the folder that the Redis cluster belongs to. |
createdAt |
string (date-time) Creation timestamp in RFC3339 String in RFC3339 To work with values in this field, use the APIs described in the |
name |
string Name of the Redis cluster. |
description |
string Description of the Redis cluster. 0-256 characters long. |
labels |
string Custom labels for the Redis cluster as |
environment |
enum (Environment) Deployment environment of the Redis cluster.
|
monitoring[] |
Description of monitoring systems relevant to the Redis cluster. |
config |
Configuration of the Redis cluster. |
networkId |
string |
health |
enum (Health) Aggregated cluster health.
|
status |
enum (Status) Cluster status.
|
sharded |
boolean Redis cluster mode on/off. |
maintenanceWindow |
Maintenance window for the cluster. |
plannedOperation |
Planned maintenance operation to be started for the cluster within the nearest |
securityGroupIds[] |
string User security groups |
tlsEnabled |
boolean TLS port and functionality on\off |
deletionProtection |
boolean Deletion Protection inhibits deletion of the cluster |
persistenceMode |
enum (PersistenceMode) Persistence mode
|
announceHostnames |
boolean Enable FQDN instead of ip |
Monitoring
Field |
Description |
name |
string Name of the monitoring system. |
description |
string Description of the monitoring system. |
link |
string Link to the monitoring system charts for the Redis cluster. |
ClusterConfig
Field |
Description |
version |
string Version of Redis server software. |
redisConfig_5_0 |
Configuration of a Redis 5.0 server. Includes only one of the fields Configuration for Redis servers in the cluster. |
redisConfig_6_0 |
Configuration of a Redis 6.0 server. Includes only one of the fields Configuration for Redis servers in the cluster. |
redisConfig_6_2 |
Configuration of a Redis 6.2 server. Includes only one of the fields Configuration for Redis servers in the cluster. |
redisConfig_7_0 |
Configuration of a Redis 7.0 server. Includes only one of the fields Configuration for Redis servers in the cluster. |
resources |
Resources allocated to Redis hosts. |
backupWindowStart |
Time to start the daily backup, in the UTC timezone. |
access |
Access policy to DB |
redis |
Unified configuration of a Redis cluster. |
diskSizeAutoscaling |
Disk size autoscaling settings |
RedisConfigSet5_0
Field |
Description |
effectiveConfig |
Effective settings for a Redis 5.0 cluster (a combination of settings |
userConfig |
User-defined settings for a Redis 5.0 cluster. |
defaultConfig |
Default configuration for a Redis 5.0 cluster. |
RedisConfig5_0
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
RedisConfigSet6_0
Field |
Description |
effectiveConfig |
Effective settings for a Redis 6.0 cluster (a combination of settings |
userConfig |
User-defined settings for a Redis 6.0 cluster. |
defaultConfig |
Default configuration for a Redis 6.0 cluster. |
RedisConfig6_0
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
RedisConfigSet6_2
Field |
Description |
effectiveConfig |
Effective settings for a Redis 6.2 cluster (a combination of settings |
userConfig |
User-defined settings for a Redis 6.2 cluster. |
defaultConfig |
Default configuration for a Redis 6.2 cluster. |
RedisConfig6_2
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
maxmemoryPercent |
string (int64) Redis maxmemory percent |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
RedisConfigSet7_0
Field |
Description |
effectiveConfig |
Effective settings for a Redis 7.0 cluster (a combination of settings |
userConfig |
User-defined settings for a Redis 7.0 cluster. |
defaultConfig |
Default configuration for a Redis 7.0 cluster. |
RedisConfig7_0
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
maxmemoryPercent |
string (int64) Redis maxmemory percent |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
Resources
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host.
|
TimeOfDay
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
Field |
Description |
hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may |
nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
Access
Field |
Description |
dataLens |
boolean Allow access for DataLens |
webSql |
boolean Allow access for Web SQL. |
RedisConfigSet
Field |
Description |
effectiveConfig |
Effective settings for a Redis cluster (a combination of settings |
userConfig |
User-defined settings for a Redis cluster. |
defaultConfig |
Default configuration for a Redis cluster. |
RedisConfig
Fields and structure of RedisConfig
reflects Redis configuration file
parameters.
Field |
Description |
maxmemoryPolicy |
enum (MaxmemoryPolicy) Redis key eviction policy for a dataset that reaches maximum memory, All policies are described in detail in Redis documentation
|
timeout |
string (int64) Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
string (int64) Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
string (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
string (int64) Max slow requests number to log. |
notifyKeyspaceEvents |
string String setting for pub\sub functionality. |
clientOutputBufferLimitPubsub |
Redis connection output buffers limits for pubsub operations. |
clientOutputBufferLimitNormal |
Redis connection output buffers limits for clients. |
maxmemoryPercent |
string (int64) Redis maxmemory percent |
luaTimeLimit |
string (int64) Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism |
replBacklogSizePercent |
string (int64) Replication backlog size as a percentage of flavor maxmemory |
clusterRequireFullCoverage |
boolean Controls whether all hash slots must be covered by nodes |
clusterAllowReadsWhenDown |
boolean Allows read operations when cluster is down |
clusterAllowPubsubshardWhenDown |
boolean Permits Pub/Sub shard operations when cluster is down |
lfuDecayTime |
string (int64) 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) |
lfuLogFactor |
string (int64) Determines how the frequency counter represents key hits. |
turnBeforeSwitchover |
boolean Allows to turn before switchover in RDSync |
allowDataLoss |
boolean Allows some data to be lost in favor of faster switchover/restart |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
string (int64) Total limit in bytes. |
softLimit |
string (int64) Limit in bytes during certain time period. |
softSeconds |
string (int64) Seconds for soft limit. |
DiskSizeAutoscaling
Field |
Description |
plannedUsageThreshold |
string (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. |
emergencyUsageThreshold |
string (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. |
diskSizeLimit |
string (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
MaintenanceWindow
A maintenance window settings.
Field |
Description |
anytime |
object Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
weeklyMaintenanceWindow |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
WeeklyMaintenanceWindow
Weelky maintenance window settings.
Field |
Description |
day |
enum (WeekDay) Day of the week (in
|
hour |
string (int64) Hour of the day in UTC (in |
MaintenanceOperation
A planned maintenance operation.
Field |
Description |
info |
string Information about this maintenance operation. |
delayedUntil |
string (date-time) Time until which this maintenance operation is delayed. String in RFC3339 To work with values in this field, use the APIs described in the |