Skip to main content

types

Access​

dataLens : bool​

Allow access for DataLens

webSql : bool​

Allow access for Web SQL.

AnytimeMaintenanceWindow​

Backup​

Description of a Redis backup. For more information, see the Managed Service for Redis documentation.

id : string​

ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).

sourceClusterId : string​

ID of the Redis cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Start timestamp in RFC3339 text format (i.e. when the backup operation was started).

sourceShardNames : string​

Shard names used as a source for backup.

Cluster​

Description of a Redis cluster. For more information, see the Managed Service for Redis documentation.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    Cluster is in unknown state (we have no data)

  • ALIVE

    Cluster is alive and well (all hosts are alive)

  • DEAD

    Cluster is inoperable (it cannot perform any of its essential functions)

  • DEGRADED

    Cluster is partially alive (it can perform some of its essential functions)

Status​

  • STATUS_UNKNOWN

    Cluster status is unknown

  • CREATING

    Cluster is being created

  • RUNNING

    Cluster is running

  • ERROR

    Cluster failed

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

PersistenceMode​

  • ON

    cluster persistence mode on

  • OFF

    cluster persistence mode off

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 : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

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 : string​

Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.

environment : Environment​

Deployment environment of the Redis cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the Redis cluster.

config : ClusterConfig​

Configuration of the Redis cluster.

networkId : string​
health : Health​

Aggregated cluster health.

status : Status​

Cluster status.

sharded : bool​

Redis cluster mode on/off.

maintenanceWindow : MaintenanceWindow​

Maintenance window for the cluster.

plannedOperation : MaintenanceOperation​

Planned maintenance operation to be started for the cluster within the nearest maintenance_window.

securityGroupIds : string​

User security groups

tlsEnabled : bool​

TLS port and functionality on\off

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

persistenceMode : PersistenceMode​

Persistence mode

announceHostnames : bool​

Enable FQDN instead of ip

ClusterConfig​

version : string​

Version of Redis server software.

One of redisConfig​

Configuration for Redis servers in the cluster.

  • redisConfig_5_0 : config.RedisConfigSet5_0​

    Configuration of a Redis 5.0 server.

  • redisConfig_6_0 : config.RedisConfigSet6_0​

    Configuration of a Redis 6.0 server.

  • redisConfig_6_2 : config.RedisConfigSet6_2​

    Configuration of a Redis 6.2 server.

  • redisConfig_7_0 : config.RedisConfigSet7_0​

    Configuration of a Redis 7.0 server.

resources : Resources​

Resources allocated to Redis hosts.

backupWindowStart : google.type.TimeOfDay​

Time to start the daily backup, in the UTC timezone.

access : Access​

Access policy to DB

redis : config.RedisConfigSet​

Unified configuration of a Redis cluster.

diskSizeAutoscaling : DiskSizeAutoscaling​

Disk size autoscaling settings

DiskSizeAutoscaling​

plannedUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergencyUsageThreshold : google.protobuf.Int64Value​

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

diskSizeLimit : google.protobuf.Int64Value​

Limit on how large the storage for database instances can automatically grow, in bytes.

Host​

Role​

  • ROLE_UNKNOWN

    Role of the host in the cluster is unknown. Default value.

  • MASTER

    Host is the master Redis server in the cluster.

  • REPLICA

    Host is a replica (standby) Redis server in the cluster.

Health​

  • HEALTH_UNKNOWN

    Health of the host is unknown. Default value.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable, and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded, and can perform only some of its essential functions.

name : string​

Name of the Redis host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

ID of the Redis cluster. The ID is assigned by MDB at creation time.

zoneId : string​

ID of the availability zone where the Redis host resides.

subnetId : string​

ID of the subnet that the host belongs to.

resources : Resources​

Resources allocated to the Redis host.

role : Role​

Role of the host in the cluster. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

services : Service​

Services provided by the host.

shardName : string​
replicaPriority : google.protobuf.Int64Value​

A replica with a low priority number is considered better for promotion. A replica with priority of 0 will never be selected by Redis Sentinel for promotion. Works only for non-sharded clusters. Default value is 100.

assignPublicIp : bool​

Flag showing public IP assignment status to this host.

MaintenanceOperation​

A planned maintenance operation.

info : string​

Information about this maintenance operation.

delayedUntil : google.protobuf.Timestamp​

Time until which this maintenance operation is delayed.

MaintenanceWindow​

A maintenance window settings.

One of policy​

The maintenance policy in effect.

  • anytime : AnytimeMaintenanceWindow​

    Maintenance operation can be scheduled anytime.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    Maintenance operation can be scheduled on a weekly basis.

Monitoring​

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the Redis cluster.

ResourcePreset​

A resource preset that describes hardware configuration for a host.

id : string​

ID of the resource preset.

zoneIds : string​

IDs of availability zones where the resource preset is available.

memory : int64​

RAM volume for a Redis host created with the preset, in bytes.

cores : int64​

Number of CPU cores for a Redis host created with the preset.

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.

diskSize : int64​

Volume of the storage available to a host, in bytes.

diskTypeId : string​

Type of the storage environment for the host. Possible values:

  • network-ssd - network SSD drive,
  • local-ssd - local SSD storage.

Service​

Type​

  • TYPE_UNSPECIFIED

    Service type of the host is unspecified. Default value.

  • REDIS

    The host is a Redis server.

  • ARBITER

    The host provides a Sentinel-only service (a quorum node).

  • REDIS_CLUSTER

    The host is a Redis Cluster node.

Health​

  • HEALTH_UNKNOWN

    Health of the server is unknown. Default value.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the service. If the field has default value, it is not returned in the response.

Shard​

name : string​

Name of the Redis shard. The shard name is assigned by user at creation time, and cannot be changed. 1-63 characters long.

clusterId : string​

ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.

WeeklyMaintenanceWindow​

Weelky maintenance window settings.

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​

Day of the week (in DDD format).

hour : int64​

Hour of the day in UTC (in HH format).