Managed Service for Redis API, REST: Cluster methods
A set of methods for managing Redis clusters.
JSON Representation
{
"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",
"diskTypeId": "string"
},
"backupWindowStart": {
"hours": "integer",
"minutes": "integer",
"seconds": "integer",
"nanos": "integer"
},
"access": {
"dataLens": true,
"webSql": true
},
"redis": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
}
},
"diskSizeAutoscaling": {
"plannedUsageThreshold": "integer",
"emergencyUsageThreshold": "integer",
"diskSizeLimit": "integer"
},
// `config` 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": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
}
},
"redisConfig_6_0": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
}
}
},
"redisConfig_6_2": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
}
},
"redisConfig_7_0": {
"effectiveConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"userConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
},
"defaultConfig": {
"maxmemoryPolicy": "string",
"timeout": "integer",
"password": "string",
"databases": "integer",
"slowlogLogSlowerThan": "integer",
"slowlogMaxLen": "integer",
"notifyKeyspaceEvents": "string",
"clientOutputBufferLimitPubsub": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"clientOutputBufferLimitNormal": {
"hardLimit": "integer",
"softLimit": "integer",
"softSeconds": "integer"
},
"maxmemoryPercent": "integer"
}
},
// end of the list of possible fields`config`
},
"networkId": "string",
"health": "string",
"status": "string",
"sharded": true,
"maintenanceWindow": {
// `maintenanceWindow` includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
"anytime": {},
"weeklyMaintenanceWindow": {
"day": "string",
"hour": "string"
},
// end of the list of possible fields`maintenanceWindow`
},
"plannedOperation": {
"info": "string",
"delayedUntil": "string"
},
"securityGroupIds": [
"string"
],
"tlsEnabled": true,
"deletionProtection": true,
"persistenceMode": "string",
"announceHostnames": true
}
Field | Description |
---|---|
id | string ID of the Redis cluster. This ID is assigned by MDB at creation time. |
folderId | string ID of the folder that the Redis cluster belongs to. |
createdAt | string (date-time) Creation timestamp in RFC3339 text format. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the Redis cluster. The name is unique within the folder. 3-63 characters long. |
description | string Description of the Redis cluster. 0-256 characters long. |
labels | object Custom labels for the Redis cluster as |
environment | string Deployment environment of the Redis cluster.
|
monitoring[] | object Description of monitoring systems relevant to the Redis cluster. |
monitoring[]. name |
string Name of the monitoring system. |
monitoring[]. description |
string Description of the monitoring system. |
monitoring[]. link |
string Link to the monitoring system charts for the Redis cluster. |
config | object Configuration of the Redis cluster. |
config. version |
string Version of Redis server software. |
config. resources |
object Resources allocated to Redis hosts. |
config. resources. resourcePresetId |
string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation. |
config. resources. diskSize |
string (int64) Volume of the storage available to a host, in bytes. |
config. resources. diskTypeId |
string Type of the storage environment for the host. Possible values:
|
config. backupWindowStart |
object Time to start the daily backup, in the UTC timezone. |
config. backupWindowStart. hours |
integer (int32) Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. |
config. backupWindowStart. minutes |
integer (int32) Minutes of hour of day. Must be from 0 to 59. |
config. backupWindowStart. seconds |
integer (int32) Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. |
config. backupWindowStart. nanos |
integer (int32) Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. |
config. access |
object Access policy to DB |
config. access. dataLens |
boolean (boolean) Allow access for DataLens |
config. access. webSql |
boolean (boolean) Allow access for Web SQL. |
config. redis |
object Unified configuration of a Redis cluster. |
config. redis. effectiveConfig |
object Effective settings for a Redis cluster (a combination of settings defined in Fields and structure of |
config. redis. effectiveConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redis. effectiveConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redis. effectiveConfig. password |
string Authentication password. Value must match the regular expression |
config. redis. effectiveConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redis. effectiveConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redis. effectiveConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redis. effectiveConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redis. effectiveConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redis. effectiveConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redis. effectiveConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redis. effectiveConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redis. effectiveConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redis. effectiveConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redis. effectiveConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redis. effectiveConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redis. effectiveConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redis. userConfig |
object User-defined settings for a Redis cluster. Fields and structure of |
config. redis. userConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redis. userConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redis. userConfig. password |
string Authentication password. Value must match the regular expression |
config. redis. userConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redis. userConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redis. userConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redis. userConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redis. userConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redis. userConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redis. userConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redis. userConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redis. userConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redis. userConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redis. userConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redis. userConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redis. userConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redis. defaultConfig |
object Default configuration for a Redis cluster. Fields and structure of |
config. redis. defaultConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redis. defaultConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redis. defaultConfig. password |
string Authentication password. Value must match the regular expression |
config. redis. defaultConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redis. defaultConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redis. defaultConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redis. defaultConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redis. defaultConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redis. defaultConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redis. defaultConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redis. defaultConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redis. defaultConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redis. defaultConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redis. defaultConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redis. defaultConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redis. defaultConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. diskSizeAutoscaling |
object Disk size autoscaling settings |
config. diskSizeAutoscaling. plannedUsageThreshold |
integer (int64) Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
config. diskSizeAutoscaling. emergencyUsageThreshold |
integer (int64) Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent. Acceptable values are 0 to 100, inclusive. |
config. diskSizeAutoscaling. diskSizeLimit |
integer (int64) Limit on how large the storage for database instances can automatically grow, in bytes. |
config. redisConfig_5_0 |
object Configuration of a Redis 5.0 server. config includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 |
config. redisConfig_5_0. effectiveConfig |
object Effective settings for a Redis 5.0 cluster (a combination of settings defined in Fields and structure of |
config. redisConfig_5_0. effectiveConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_5_0. effectiveConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_5_0. effectiveConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_5_0. effectiveConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_5_0. effectiveConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_5_0. effectiveConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_5_0. userConfig |
object User-defined settings for a Redis 5.0 cluster. Fields and structure of |
config. redisConfig_5_0. userConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_5_0. userConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_5_0. userConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_5_0. userConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_5_0. userConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_5_0. userConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_5_0. userConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_5_0. userConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig |
object Default configuration for a Redis 5.0 cluster. Fields and structure of |
config. redisConfig_5_0. defaultConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_5_0. defaultConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_5_0. defaultConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_5_0. defaultConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_5_0. defaultConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_5_0. defaultConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_0 |
object Configuration of a Redis 6.0 server. config includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 |
config. redisConfig_6_0. effectiveConfig |
object Effective settings for a Redis 6.0 cluster (a combination of settings defined in Fields and structure of |
config. redisConfig_6_0. effectiveConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_6_0. effectiveConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_6_0. effectiveConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_6_0. effectiveConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_6_0. effectiveConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_0. effectiveConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_0. userConfig |
object User-defined settings for a Redis 6.0 cluster. Fields and structure of |
config. redisConfig_6_0. userConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_6_0. userConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_6_0. userConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_6_0. userConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_6_0. userConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_6_0. userConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_6_0. userConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_0. userConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig |
object Default configuration for a Redis 6.0 cluster. Fields and structure of |
config. redisConfig_6_0. defaultConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_6_0. defaultConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_6_0. defaultConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_6_0. defaultConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_6_0. defaultConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_0. defaultConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2 |
object Configuration of a Redis 6.2 server. config includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 |
config. redisConfig_6_2. effectiveConfig |
object Effective settings for a Redis 6.2 cluster (a combination of settings defined in Fields and structure of |
config. redisConfig_6_2. effectiveConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_6_2. effectiveConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_6_2. effectiveConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_6_2. effectiveConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_6_2. effectiveConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2. effectiveConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redisConfig_6_2. userConfig |
object User-defined settings for a Redis 6.2 cluster. Fields and structure of |
config. redisConfig_6_2. userConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_6_2. userConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_6_2. userConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_6_2. userConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_6_2. userConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_6_2. userConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_6_2. userConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_2. userConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2. userConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redisConfig_6_2. defaultConfig |
object Default configuration for a Redis 6.2 cluster. Fields and structure of |
config. redisConfig_6_2. defaultConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_6_2. defaultConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_6_2. defaultConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_6_2. defaultConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_6_2. defaultConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_6_2. defaultConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redisConfig_7_0 |
object Configuration of a Redis 7.0 server. config includes only one of the fields redisConfig_5_0 , redisConfig_6_0 , redisConfig_6_2 , redisConfig_7_0 |
config. redisConfig_7_0. effectiveConfig |
object Effective settings for a Redis 7.0 cluster (a combination of settings defined in Fields and structure of |
config. redisConfig_7_0. effectiveConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_7_0. effectiveConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_7_0. effectiveConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_7_0. effectiveConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_7_0. effectiveConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_7_0. effectiveConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redisConfig_7_0. userConfig |
object User-defined settings for a Redis 7.0 cluster. Fields and structure of |
config. redisConfig_7_0. userConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_7_0. userConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_7_0. userConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_7_0. userConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_7_0. userConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_7_0. userConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_7_0. userConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_7_0. userConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_7_0. userConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
config. redisConfig_7_0. defaultConfig |
object Default configuration for a Redis 7.0 cluster. Fields and structure of |
config. redisConfig_7_0. defaultConfig. maxmemoryPolicy |
string Redis key eviction policy for a dataset that reaches maximum memory, available to the host. Redis maxmemory setting depends on Managed Service for Redis host class. All policies are described in detail in Redis documentation.
|
config. redisConfig_7_0. defaultConfig. timeout |
integer (int64) Time that Redis keeps the connection open while the client is idle. If no new command is sent during that time, the connection is closed. |
config. redisConfig_7_0. defaultConfig. password |
string Authentication password. Value must match the regular expression |
config. redisConfig_7_0. defaultConfig. databases |
integer (int64) Number of database buckets on a single redis-server process. Value must be greater than 0. |
config. redisConfig_7_0. defaultConfig. slowlogLogSlowerThan |
integer (int64) Threshold for logging slow requests to server in microseconds (log only slower than it). The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. slowlogMaxLen |
integer (int64) Max slow requests number to log. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. notifyKeyspaceEvents |
string String setting for pub\sub functionality. Value must match the regular expression |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitPubsub |
object Redis connection output buffers limits for pubsub operations. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitPubsub. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitPubsub. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitPubsub. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitNormal |
object Redis connection output buffers limits for clients. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitNormal. hardLimit |
integer (int64) Total limit in bytes. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitNormal. softLimit |
integer (int64) Limit in bytes during certain time period. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. clientOutputBufferLimitNormal. softSeconds |
integer (int64) Seconds for soft limit. The minimum value is 0. |
config. redisConfig_7_0. defaultConfig. maxmemoryPercent |
integer (int64) Redis maxmemory percent Acceptable values are 1 to 75, inclusive. |
networkId | string |
health | string Aggregated cluster health.
|
status | string Cluster status.
|
sharded | boolean (boolean) Redis cluster mode on/off. |
maintenanceWindow | object Maintenance window for the cluster. A maintenance window settings. |
maintenanceWindow. anytime |
object Maintenance operation can be scheduled anytime. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow |
object Maintenance operation can be scheduled on a weekly basis. maintenanceWindow includes only one of the fields anytime , weeklyMaintenanceWindow |
maintenanceWindow. weeklyMaintenanceWindow. day |
string Day of the week (in |
maintenanceWindow. weeklyMaintenanceWindow. hour |
string (int64) Hour of the day in UTC (in Acceptable values are 1 to 24, inclusive. |
plannedOperation | object Planned maintenance operation to be started for the cluster within the nearest maintenanceWindow. A planned maintenance operation. |
plannedOperation. info |
string Information about this maintenance operation. The maximum string length in characters is 256. |
plannedOperation. delayedUntil |
string (date-time) Time until which this maintenance operation is delayed. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
securityGroupIds[] | string User security groups |
tlsEnabled | boolean (boolean) TLS port and functionality on\off |
deletionProtection | boolean (boolean) Deletion Protection inhibits deletion of the cluster |
persistenceMode | string Persistence mode |
announceHostnames | boolean (boolean) Enable FQDN instead of ip |
Methods
Method | Description |
---|---|
addHosts | Creates new hosts for a cluster. |
addShard | Creates a new shard. |
backup | Creates a backup for the specified Redis cluster. |
create | Creates a Redis cluster in the specified folder. |
delete | Deletes the specified Redis cluster. |
deleteHosts | Deletes the specified hosts for a cluster. |
deleteShard | Deletes the specified shard. |
enableSharding | Enable Sharding on non sharded cluster |
get | Returns the specified Redis cluster. |
getShard | Returns the specified shard. |
list | Retrieves the list of Redis clusters that belong to the specified folder. |
listBackups | Retrieves the list of available backups for the specified Redis cluster. |
listHosts | Retrieves a list of hosts for the specified cluster. |
listLogs | Retrieves logs for the specified Redis cluster. |
listOperations | Retrieves the list of operations for the specified cluster. |
listShards | Retrieves a list of shards. |
move | Moves a Redis cluster to the specified folder. |
rebalance | Rebalances the cluster. Evenly distributes all the hash slots between the shards. |
rescheduleMaintenance | Reschedules planned maintenance operation. |
restore | Creates a new Redis cluster using the specified backup. |
start | Start the specified Redis cluster. |
startFailover | Start a manual failover on the specified Redis cluster. |
stop | Stop the specified Redis cluster. |
streamLogs | Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics. |
update | Updates the specified Redis cluster. |
updateHosts | Updates the specified hosts. |