ClusterService

A set of methods for managing Redis clusters.

Call	Description
Get	Returns the specified Redis cluster.
List	Retrieves the list of Redis clusters that belong to the specified folder.
Create	Creates a Redis cluster in the specified folder.
Update	Updates the specified Redis cluster.
Delete	Deletes the specified Redis cluster.
Start	Start the specified Redis cluster.
Stop	Stop the specified Redis cluster.
Move	Moves a Redis cluster to the specified folder.
Backup	Creates a backup for the specified Redis cluster.
Restore	Creates a new Redis cluster using the specified backup.
RescheduleMaintenance	Reschedules planned maintenance operation.
StartFailover	Start a manual failover on the specified Redis cluster.
ListLogs	Retrieves logs for the specified Redis cluster.
StreamLogs	Same as ListLogs but using server-side streaming.
ListOperations	Retrieves the list of operations for the specified cluster.
ListBackups	Retrieves the list of available backups for the specified Redis cluster.
ListHosts	Retrieves a list of hosts for the specified cluster.
AddHosts	Creates new hosts for a cluster.
DeleteHosts	Deletes the specified hosts for a cluster.
UpdateHosts	Updates the specified hosts.
GetShard	Returns the specified shard.
ListShards	Retrieves a list of shards.
AddShard	Creates a new shard.
DeleteShard	Deletes the specified shard.
Rebalance	Rebalances the cluster.

Calls ClusterService

Get

Returns the specified Redis cluster.
To get the list of available Redis clusters, make a List request.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to return. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

List

Retrieves the list of Redis clusters that belong to the specified folder.

rpc List (ListClustersRequest) returns (ListClustersResponse)

ListClustersRequest

Field	Description
folder_id	string Required. ID of the folder to list Redis clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string A filter expression that filters clusters listed in the response. The expression must specify: The field name. Currently you can only use filtering with the Cluster.name field. An = operator. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z]([-a-z0-9]{,61}[a-z0-9])?. The maximum string length in characters is 1000.

ListClustersResponse

Field	Description
clusters[]	Cluster List of Redis clusters.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Create

Creates a Redis cluster in the specified folder.

rpc Create (CreateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateClusterMetadata

    Operation.response:Cluster

CreateClusterRequest

Field	Description
folder_id	string Required. ID of the folder to create the Redis cluster in. The maximum string length in characters is 50.
name	string Required. Name of the Redis cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the Redis cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
environment	Cluster.Environment Required. Deployment environment of the Redis cluster.
config_spec	ConfigSpec Required. Configuration and resources for hosts that should be created for the Redis cluster.
host_specs[]	HostSpec Individual configurations for hosts that should be created for the Redis cluster. The number of elements must be greater than 0.
network_id	string Required. ID of the network to create the cluster in. The maximum string length in characters is 50.
sharded	bool Redis cluster mode on/off.
security_group_ids[]	string User security groups
tls_enabled	google.protobuf.BoolValue TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	Cluster.PersistenceMode Persistence mode

ConfigSpec

Field	Description
version	string Version of Redis used in the cluster.
redis_spec	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration of a Redis cluster.
redis_config_5_0	config.RedisConfig5_0 Configuration of a Redis cluster.
redis_config_6_0	config.RedisConfig6_0 Configuration of a Redis cluster.
redis_config_6_2	config.RedisConfig6_2 Configuration of a Redis cluster.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id.
shard_name	string ID of the Redis shard the host belongs to. To get the shard ID use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
replica_priority	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.
assign_public_ip	bool Whether the host should get a public IP address on creation. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

CreateClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster that is being created.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Update

Updates the specified Redis cluster.

rpc Update (UpdateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateClusterMetadata

    Operation.response:Cluster

UpdateClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to update. To get the Redis cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the Redis cluster should be updated.
description	string New description of the Redis cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
config_spec	ConfigSpec New configuration and resources for hosts in the cluster.
name	string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
maintenance_window	MaintenanceWindow New maintenance window settings for the cluster.
security_group_ids[]	string User security groups
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	Cluster.PersistenceMode Persistence mode

ConfigSpec

Field	Description
version	string Version of Redis used in the cluster.
redis_spec	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration of a Redis cluster.
redis_config_5_0	config.RedisConfig5_0 Configuration of a Redis cluster.
redis_config_6_0	config.RedisConfig6_0 Configuration of a Redis cluster.
redis_config_6_2	config.RedisConfig6_2 Configuration of a Redis cluster.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

UpdateClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster that is being updated.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Delete

Deletes the specified Redis cluster.

rpc Delete (DeleteClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to delete. To get the Redis cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster that is being deleted.

Start

Start the specified Redis cluster.

rpc Start (StartClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterMetadata

    Operation.response:Cluster

StartClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to start. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<StartClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Stop

Stop the specified Redis cluster.

rpc Stop (StopClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StopClusterMetadata

    Operation.response:Cluster

StopClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to stop. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<StopClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StopClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Move

Moves a Redis cluster to the specified folder.

rpc Move (MoveClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:MoveClusterMetadata

    Operation.response:Cluster

MoveClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to move. The maximum string length in characters is 50.
destination_folder_id	string Required. ID of the destination folder. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<MoveClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

MoveClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster being moved.
source_folder_id	string ID of the source folder.
destination_folder_id	string ID of the destination folder.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Backup

Creates a backup for the specified Redis cluster.

rpc Backup (BackupClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:BackupClusterMetadata

    Operation.response:Cluster

BackupClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to back up. To get the Redis cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<BackupClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

BackupClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster that is being backed up.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

Restore

Creates a new Redis cluster using the specified backup.

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RestoreClusterMetadata

    Operation.response:Cluster

RestoreClusterRequest

Field	Description
backup_id	string Required. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request.
name	string Required. Name of the new Redis cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the new Redis cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster. For example, "project": "mvp" or "source": "dictionary". No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The maximum string length in characters for each key is 63. Each key must match the regular expression [a-z][-_0-9a-z]*.
environment	Cluster.Environment Required. Deployment environment of the new Redis cluster.
config_spec	ConfigSpec Required. Configuration for the Redis cluster to be created.
host_specs[]	HostSpec Configurations for Redis hosts that should be created for the cluster that is being created from the backup. The number of elements must be greater than 0.
network_id	string Required. ID of the network to create the Redis cluster in. The maximum string length in characters is 50.
folder_id	string ID of the folder to create the Redis cluster in. The maximum string length in characters is 50.
security_group_ids[]	string User security groups
tls_enabled	google.protobuf.BoolValue TLS port and functionality on\off
persistence_mode	Cluster.PersistenceMode Persistence mode

ConfigSpec

Field	Description
version	string Version of Redis used in the cluster.
redis_spec	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration of a Redis cluster.
redis_config_5_0	config.RedisConfig5_0 Configuration of a Redis cluster.
redis_config_6_0	config.RedisConfig6_0 Configuration of a Redis cluster.
redis_config_6_2	config.RedisConfig6_2 Configuration of a Redis cluster.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id.
shard_name	string ID of the Redis shard the host belongs to. To get the shard ID use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
replica_priority	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.
assign_public_ip	bool Whether the host should get a public IP address on creation. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<RestoreClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

RestoreClusterMetadata

Field	Description
cluster_id	string ID of the new Redis cluster that is being created from a backup.
backup_id	string ID of the backup that is being used for creating a cluster.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

RescheduleMaintenance

Reschedules planned maintenance operation.

rpc RescheduleMaintenance (RescheduleMaintenanceRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RescheduleMaintenanceMetadata

    Operation.response:Cluster

RescheduleMaintenanceRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to reschedule the maintenance operation for. The maximum string length in characters is 50.
reschedule_type	enum RescheduleType Required. The type of reschedule request. IMMEDIATE: Start the maintenance operation immediately. NEXT_AVAILABLE_WINDOW: Start the maintenance operation within the next available maintenance window. SPECIFIC_TIME: Start the maintenance operation at the specific time.
delayed_until	google.protobuf.Timestamp The time until which this maintenance operation should be delayed. The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks. The value can also point to the past moment of time if reschedule_type.IMMEDIATE reschedule type is chosen.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<RescheduleMaintenanceMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

RescheduleMaintenanceMetadata

Field	Description
cluster_id	string Required. ID of the Redis cluster.
delayed_until	google.protobuf.Timestamp Required. The time until which this maintenance operation is to be delayed.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

StartFailover

Start a manual failover on the specified Redis cluster.

rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterFailoverMetadata

    Operation.response:Cluster

StartClusterFailoverRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to start failover on. The maximum string length in characters is 50.
host_names[]	string List of hostnames which should not be masters. Can be empty for sentinel clusters or can contain multiple hosts for sharded clusters. The maximum string length in characters for each value is 253.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<StartClusterFailoverMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterFailoverMetadata

Field	Description
cluster_id	string ID of the Redis cluster on which failover will be initiated.
host_names[]	string List of hostnames which should not be masters. Can be empty for sentinel clusters or can contain multiple hosts for sharded clusters.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.

ListLogs

Retrieves logs for the specified Redis cluster.

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to request logs for. To get the Redis cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
column_filter[]	string Columns from the logs table to request. If no columns are specified, entire log records are returned.
service_type	enum ServiceType REDIS: Logs of Redis activity.
from_time	google.protobuf.Timestamp Start timestamp for the logs request, in RFC3339 text format.
to_time	google.protobuf.Timestamp End timestamp for the logs request, in RFC3339 text format.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterLogsResponse

Field	Description
logs[]	LogRecord Requested log records.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. This value is interchangeable with next_record_token from StreamLogs method.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp in RFC3339 text format.
message	map<string,string> Contents of the log record.

StreamLogs

Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics.

rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

StreamClusterLogsRequest

Field	Description
cluster_id	string Required. Required. ID of the Redis cluster. The maximum string length in characters is 50.
column_filter[]	string Columns from logs table to get in the response.
service_type	enum ServiceType REDIS: Logs of Redis activity.
from_time	google.protobuf.Timestamp Start timestamp for the logs request.
to_time	google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs will be sent and then the new ones as they appear. In essence it has 'tail -f' semantics.
record_token	string Record token. Set record_token to the next_record_token returned by a previous StreamLogs request to start streaming from next log record. The maximum string length in characters is 100.
filter	string A filter expression that filters resources listed in the response. The expression must specify: The field name. Currently filtering can be applied to the LogRecord.logs.hostname field An = operator. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9]. Examples of a filter message.hostname='node1.db.cloud.yandex.net'. The maximum string length in characters is 1000.

StreamLogRecord

Field	Description
record	LogRecord One of the requested log records.
next_record_token	string This token allows you to continue streaming logs starting from the exact same record. To continue streaming, specify value of next_record_token as value for record_token parameter in the next StreamLogs request. This value is interchangeable with next_page_token from ListLogs method.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp in RFC3339 text format.
message	map<string,string> Contents of the log record.

ListOperations

Retrieves the list of operations for the specified cluster.

rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

ListClusterOperationsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to list operations for. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified Redis cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

ListBackups

Retrieves the list of available backups for the specified Redis cluster.

rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

ListClusterBackupsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster. To get the Redis cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterBackupsResponse

Field	Description
backups[]	Backup List of Redis backups.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Backup

Field	Description
id	string ID of the backup.
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).
source_cluster_id	string ID of the Redis cluster that the backup was created for.
started_at	google.protobuf.Timestamp Start timestamp in RFC3339 text format (i.e. when the backup operation was started).
source_shard_names[]	string Shard names used as a source for backup.

ListHosts

Retrieves a list of hosts for the specified cluster.

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster. To get the Redis cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterHostsResponse

Field	Description
hosts[]	Host List of hosts for the cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Host

Field	Description
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 existing MDB hosts in Yandex Cloud, as it defines the FQDN of the host.
cluster_id	string ID of the Redis cluster. The ID is assigned by MDB at creation time.
zone_id	string ID of the availability zone where the Redis host resides.
subnet_id	string ID of the subnet that the host belongs to.
resources	Resources Resources allocated to the Redis host.
role	enum Role Role of the host in the cluster. ROLE_UNKNOWN: Role of the host in the cluster is unknown. MASTER: Host is the master Redis server in the cluster. REPLICA: Host is a replica (standby) Redis server in the cluster.
health	enum Health Status code of the aggregated health of the host. HEALTH_UNKNOWN: Health of the host is unknown. 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.
services[]	Service Services provided by the host.
shard_name	string
replica_priority	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.
assign_public_ip	bool Flag showing public IP assignment status to this host.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Service

Field	Description
type	enum Type Type of the service provided by the host. 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	enum Health Status code of server availability. HEALTH_UNKNOWN: Health of the server is unknown. ALIVE: The server is working normally. DEAD: The server is dead or unresponsive.

AddHosts

Creates new hosts for a cluster.

rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:AddClusterHostsMetadata

    Operation.response:google.protobuf.Empty

AddClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to add hosts to. To get the Redis cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
host_specs[]	HostSpec Configurations for Redis hosts that should be added to the cluster. The number of elements must be greater than 0.

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id.
shard_name	string ID of the Redis shard the host belongs to. To get the shard ID use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
replica_priority	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.
assign_public_ip	bool Whether the host should get a public IP address on creation. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<AddClusterHostsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

AddClusterHostsMetadata

Field	Description
cluster_id	string ID of the Redis cluster to which the hosts are being added.
host_names[]	string Names of hosts that are being added to the cluster.

DeleteHosts

Deletes the specified hosts for a cluster.

rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterHostsMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to remove hosts from. To get the Redis cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
host_names[]	string Names of hosts to delete. The number of elements must be greater than 0. The maximum string length in characters for each value is 253.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteClusterHostsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterHostsMetadata

Field	Description
cluster_id	string ID of the Redis cluster to remove hosts from.
host_names[]	string Names of hosts that are being deleted.

UpdateHosts

Updates the specified hosts.

rpc UpdateHosts (UpdateClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateClusterHostsMetadata

    Operation.response:google.protobuf.Empty

UpdateClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to update hosts in. To get the Redis cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
update_host_specs[]	UpdateHostSpec New configurations to apply to hosts. The number of elements must be greater than 0.

UpdateHostSpec

Field	Description
host_name	string Required. Name of the host to update. To get the Redis host name, use a ClusterService.ListHosts request.
replica_priority	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.
assign_public_ip	bool Whether the host should get a public IP address on update.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the Redis host should be updated.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateClusterHostsMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

UpdateClusterHostsMetadata

Field	Description
cluster_id	string ID of the Redis cluster to update hosts in.
host_names[]	string Names of hosts that are being updated.

GetShard

Returns the specified shard.

rpc GetShard (GetClusterShardRequest) returns (Shard)

GetClusterShardRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster the shard belongs to. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
shard_name	string Required. Name of Redis shard to return. To get the shard name use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

Shard

Field	Description
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.
cluster_id	string ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.

ListShards

Retrieves a list of shards.

rpc ListShards (ListClusterShardsRequest) returns (ListClusterShardsResponse)

ListClusterShardsRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to list shards in. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterShardsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterShardsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterShardsResponse

Field	Description
shards[]	Shard List of Redis shards.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterShardsRequest.page_size, use the next_page_token as the value for the ListClusterShardsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Shard

Field	Description
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.
cluster_id	string ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.

AddShard

Creates a new shard.

rpc AddShard (AddClusterShardRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:AddClusterShardMetadata

    Operation.response:Shard

AddClusterShardRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to create a shard in. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
shard_name	string Required. Name of the shard. The name must be unique within the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
host_specs[]	HostSpec Configurations for Redis hosts that should be created with the shard. Must contain at least one element. The number of elements must be greater than 0.

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request.
subnet_id	string ID of the subnet that the host should belong to. This subnet should be a part of the network that the cluster belongs to. The ID of the network is set in the field Cluster.network_id.
shard_name	string ID of the Redis shard the host belongs to. To get the shard ID use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
replica_priority	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.
assign_public_ip	bool Whether the host should get a public IP address on creation. Possible values: false - don't assign a public IP to the host. true - the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<AddClusterShardMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Shard> if operation finished successfully.

AddClusterShardMetadata

Field	Description
cluster_id	string ID of the Redis cluster that a shard is being added to.
shard_name	string Name of the Redis shard that is being created.

Shard

Field	Description
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.
cluster_id	string ID of the Redis cluster the shard belongs to. The ID is assigned by MDB at creation time.

DeleteShard

Deletes the specified shard.

rpc DeleteShard (DeleteClusterShardRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterShardMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterShardRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster the shard belongs to. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.
shard_name	string Required. Name of the Redis shard to delete. To get the shard name use a ClusterService.ListShards request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteClusterShardMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterShardMetadata

Field	Description
cluster_id	string ID of the Redis cluster the shard belongs to.
shard_name	string Name of the Redis shard that is being deleted.

Rebalance

Rebalances the cluster. Evenly distributes all the hash slots between the shards.

rpc Rebalance (RebalanceClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RebalanceClusterMetadata

    Operation.response:Cluster

RebalanceClusterRequest

Field	Description
cluster_id	string Required. ID of the Redis cluster to rebalance. To get the cluster ID use a ClusterService.List request. The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<RebalanceClusterMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

RebalanceClusterMetadata

Field	Description
cluster_id	string ID of the Redis cluster that is being rebalancing.

Cluster

Field	Description
id	string ID of the Redis cluster. This ID is assigned by MDB at creation time.
folder_id	string ID of the folder that the Redis cluster belongs to.
created_at	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	map<string,string> Custom labels for the Redis cluster as key:value pairs. Maximum 64 per cluster.
environment	enum Environment Deployment environment of the Redis cluster. 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.
monitoring[]	Monitoring Description of monitoring systems relevant to the Redis cluster.
config	ClusterConfig Configuration of the Redis cluster.
network_id	string
health	enum Health Aggregated cluster 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	enum Status Cluster 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.
sharded	bool Redis cluster mode on/off.
maintenance_window	MaintenanceWindow Maintenance window for the cluster.
planned_operation	MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window.
security_group_ids[]	string User security groups
tls_enabled	bool TLS port and functionality on\off
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
persistence_mode	enum PersistenceMode Persistence mode

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.
redis_config	oneof: redis_config_5_0, redis_config_6_0 or redis_config_6_2 Configuration for Redis servers in the cluster.
redis_config_5_0	config.RedisConfigSet5_0 Configuration of a Redis 5.0 server.
redis_config_6_0	config.RedisConfigSet6_0 Configuration of a Redis 6.0 server.
redis_config_6_2	config.RedisConfigSet6_2 Configuration of a Redis 6.2 server.
resources	Resources Resources allocated to Redis hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host, in bytes.
disk_type_id	string Type of the storage environment for the host. Possible values: network-ssd - network SSD drive, local-ssd - local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

MaintenanceWindow

Field	Description
policy	oneof: anytime or weekly_maintenance_window The maintenance policy in effect.
anytime	AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime.
weekly_maintenance_window	WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis.

AnytimeMaintenanceWindow

WeeklyMaintenanceWindow

Field	Description
day	enum WeekDay Day of the week (in DDD format).
hour	int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive.

MaintenanceOperation

Field	Description
info	string Information about this maintenance operation. The maximum string length in characters is 256.
delayed_until	google.protobuf.Timestamp Time until which this maintenance operation is delayed.