Managed Service for Redis API, gRPC: ClusterService.StartFailover
- gRPC request
- StartClusterFailoverRequest
- operation.Operation
- StartClusterFailoverMetadata
- Cluster
- Monitoring
- ClusterConfig
- RedisConfigSet5_0
- RedisConfig5_0
- ClientOutputBufferLimit
- RedisConfigSet6_0
- RedisConfig6_0
- ClientOutputBufferLimit
- RedisConfigSet6_2
- RedisConfig6_2
- ClientOutputBufferLimit
- RedisConfigSet7_0
- RedisConfig7_0
- ClientOutputBufferLimit
- Resources
- Access
- RedisConfigSet
- RedisConfig
- ClientOutputBufferLimit
- DiskSizeAutoscaling
- MaintenanceWindow
- AnytimeMaintenanceWindow
- WeeklyMaintenanceWindow
- MaintenanceOperation
Start a manual failover on the specified Redis cluster.
gRPC request
rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)
StartClusterFailoverRequest
{
"clusterId": "string",
"hostNames": [
"string"
]
}
Field |
Description |
clusterId |
string Required field. ID of the Redis cluster to start failover on. |
hostNames[] |
string List of hostnames which should not be masters. Can be empty for sentinel clusters or can contain multiple hosts for sharded clusters. |
operation.Operation
{
"id": "string",
"description": "string",
"createdAt": "google.protobuf.Timestamp",
"createdBy": "string",
"modifiedAt": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"clusterId": "string",
"hostNames": [
"string"
]
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folderId": "string",
"createdAt": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "string",
"environment": "Environment",
"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": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
}
},
"userConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
}
},
"defaultConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
}
}
},
"redisConfig_6_0": {
"effectiveConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
}
},
"userConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
}
},
"defaultConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
}
}
},
"redisConfig_6_2": {
"effectiveConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value"
},
"userConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value"
},
"defaultConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value"
}
},
"redisConfig_7_0": {
"effectiveConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value"
},
"userConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value"
},
"defaultConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value"
}
},
// end of the list of possible fields
"resources": {
"resourcePresetId": "string",
"diskSize": "int64",
"diskTypeId": "string"
},
"backupWindowStart": "google.type.TimeOfDay",
"access": {
"dataLens": "bool",
"webSql": "bool"
},
"redis": {
"effectiveConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value",
"luaTimeLimit": "google.protobuf.Int64Value",
"replBacklogSizePercent": "google.protobuf.Int64Value",
"clusterRequireFullCoverage": "google.protobuf.BoolValue",
"clusterAllowReadsWhenDown": "google.protobuf.BoolValue",
"clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue",
"lfuDecayTime": "google.protobuf.Int64Value",
"lfuLogFactor": "google.protobuf.Int64Value",
"turnBeforeSwitchover": "google.protobuf.BoolValue",
"allowDataLoss": "google.protobuf.BoolValue"
},
"userConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value",
"luaTimeLimit": "google.protobuf.Int64Value",
"replBacklogSizePercent": "google.protobuf.Int64Value",
"clusterRequireFullCoverage": "google.protobuf.BoolValue",
"clusterAllowReadsWhenDown": "google.protobuf.BoolValue",
"clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue",
"lfuDecayTime": "google.protobuf.Int64Value",
"lfuLogFactor": "google.protobuf.Int64Value",
"turnBeforeSwitchover": "google.protobuf.BoolValue",
"allowDataLoss": "google.protobuf.BoolValue"
},
"defaultConfig": {
"maxmemoryPolicy": "MaxmemoryPolicy",
"timeout": "google.protobuf.Int64Value",
"password": "string",
"databases": "google.protobuf.Int64Value",
"slowlogLogSlowerThan": "google.protobuf.Int64Value",
"slowlogMaxLen": "google.protobuf.Int64Value",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "google.protobuf.Int64Value",
"softLimit": "google.protobuf.Int64Value",
"softSeconds": "google.protobuf.Int64Value"
},
"maxmemoryPercent": "google.protobuf.Int64Value",
"luaTimeLimit": "google.protobuf.Int64Value",
"replBacklogSizePercent": "google.protobuf.Int64Value",
"clusterRequireFullCoverage": "google.protobuf.BoolValue",
"clusterAllowReadsWhenDown": "google.protobuf.BoolValue",
"clusterAllowPubsubshardWhenDown": "google.protobuf.BoolValue",
"lfuDecayTime": "google.protobuf.Int64Value",
"lfuLogFactor": "google.protobuf.Int64Value",
"turnBeforeSwitchover": "google.protobuf.BoolValue",
"allowDataLoss": "google.protobuf.BoolValue"
}
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "google.protobuf.Int64Value",
"emergencyUsageThreshold": "google.protobuf.Int64Value",
"diskSizeLimit": "google.protobuf.Int64Value"
}
},
"networkId": "string",
"health": "Health",
"status": "Status",
"sharded": "bool",
"maintenanceWindow": {
// Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": "AnytimeMaintenanceWindow",
"weeklyMaintenanceWindow": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"plannedOperation": {
"info": "string",
"delayedUntil": "google.protobuf.Timestamp"
},
"securityGroupIds": [
"string"
],
"tlsEnabled": "bool",
"deletionProtection": "bool",
"persistenceMode": "PersistenceMode",
"announceHostnames": "bool"
}
// 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 |
Creation timestamp. |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
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. |
StartClusterFailoverMetadata
Field |
Description |
clusterId |
string ID of the Redis cluster on which failover will be initiated. |
hostNames[] |
string List of hostnames which should not be masters. Can be empty for sentinel clusters or can contain multiple hosts for sharded clusters. |
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 |
Creation timestamp in RFC3339 |
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 |
bool 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 |
bool TLS port and functionality on\off |
deletionProtection |
bool Deletion Protection inhibits deletion of the cluster |
persistenceMode |
enum PersistenceMode Persistence mode
|
announceHostnames |
bool 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 |
Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
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 |
Total limit in bytes. |
softLimit |
Limit in bytes during certain time period. |
softSeconds |
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 |
Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
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 |
Total limit in bytes. |
softLimit |
Limit in bytes during certain time period. |
softSeconds |
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 |
Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
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 |
Redis maxmemory percent |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
Total limit in bytes. |
softLimit |
Limit in bytes during certain time period. |
softSeconds |
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 |
Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
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 |
Redis maxmemory percent |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
Total limit in bytes. |
softLimit |
Limit in bytes during certain time period. |
softSeconds |
Seconds for soft limit. |
Resources
Field |
Description |
resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). |
diskSize |
int64 Volume of the storage available to a host, in bytes. |
diskTypeId |
string Type of the storage environment for the host.
|
Access
Field |
Description |
dataLens |
bool Allow access for DataLens |
webSql |
bool 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 |
Time that Redis keeps the connection open while the client is idle. |
password |
string Authentication password. |
databases |
Number of database buckets on a single redis-server process. |
slowlogLogSlowerThan |
Threshold for logging slow requests to server in microseconds (log only slower than it). |
slowlogMaxLen |
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 |
Redis maxmemory percent |
luaTimeLimit |
Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism |
replBacklogSizePercent |
Replication backlog size as a percentage of flavor maxmemory |
clusterRequireFullCoverage |
Controls whether all hash slots must be covered by nodes |
clusterAllowReadsWhenDown |
Allows read operations when cluster is down |
clusterAllowPubsubshardWhenDown |
Permits Pub/Sub shard operations when cluster is down |
lfuDecayTime |
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 |
Determines how the frequency counter represents key hits. |
turnBeforeSwitchover |
Allows to turn before switchover in RDSync |
allowDataLoss |
Allows some data to be lost in favor of faster switchover/restart |
ClientOutputBufferLimit
Field |
Description |
hardLimit |
Total limit in bytes. |
softLimit |
Limit in bytes during certain time period. |
softSeconds |
Seconds for soft limit. |
DiskSizeAutoscaling
Field |
Description |
plannedUsageThreshold |
Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. |
emergencyUsageThreshold |
Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. |
diskSizeLimit |
Limit on how large the storage for database instances can automatically grow, in bytes. |
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. |
weeklyMaintenanceWindow |
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 |
MaintenanceOperation
A planned maintenance operation.
Field |
Description |
info |
string Information about this maintenance operation. |
delayedUntil |
Time until which this maintenance operation is delayed. |