Managed Service for Redis API, REST: Cluster.List

Field

Description

folderId

string

Required field. ID of the folder to list Valkey clusters in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

The maximum string length in characters is 50.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListClustersResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

Acceptable values are 0 to 1000, inclusive.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListClustersResponse.nextPageToken
returned by the 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:

1. The field name. Currently you can only use filtering with the Cluster.name field.
2. An = operator.
3. 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.

Field

Description

clusters[]

Cluster

List of Valkey clusters.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListClustersRequest.pageSize, use the nextPageToken as the value
for the ListClustersRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the results.

Field

Description

id

string

ID of the Valkey cluster.
This ID is assigned by MDB at creation time.

folderId

string

ID of the folder that the Valkey cluster belongs to.

createdAt

string (date-time)

Creation timestamp in RFC3339 text format.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the Valkey cluster.
The name is unique within the folder. 1-63 characters long.

description

string

Description of the Valkey cluster. 0-256 characters long.

labels

object (map<string, string>)

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

environment

enum (Environment)

Deployment environment of the Valkey 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 Valkey cluster.

config

ClusterConfig

Configuration of the Valkey cluster.

networkId

string

ID of the network that the cluster belongs to.

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

boolean

Valkey cluster mode on/off.

maintenanceWindow

MaintenanceWindow

Deprecated. Use maintenance_windows instead.
Maintenance window for the cluster.

plannedOperation

MaintenanceOperation

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

securityGroupIds[]

string

User security groups

tlsEnabled

boolean

TLS port and functionality on\off

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster

persistenceMode

enum (PersistenceMode)

Persistence mode

• ON: Persistence is enabled on every host of the cluster: the append-only file
  (AOF) is written on masters and replicas alike.
• OFF: Persistence is disabled: neither the append-only file (AOF) nor RDB
  snapshots are written, all data is kept in memory only.
• ON_REPLICAS: The append-only file (AOF) is written on replicas only, masters do not
  persist data to disk.

announceHostnames

boolean

Enable FQDN instead of ip

authSentinel

boolean

Allows to use ACL users to auth in sentinel

diskEncryptionKeyId

string

ID of the key to encrypt cluster disks.

isHa

boolean

Indicates whether the cluster topology is highly available as defined by the Yandex Cloud SLA for managed databases.

maintenanceWindows

MaintenanceWindows

Maintenance windows.

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 Valkey cluster.

Field

Description

version

string

Version of Valkey server software.

redisConfig_5_0

RedisConfigSet5_0

Configuration of a Valkey 5.0 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Valkey servers in the cluster.

redisConfig_6_0

RedisConfigSet6_0

Configuration of a Valkey 6.0 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Valkey servers in the cluster.

redisConfig_6_2

RedisConfigSet6_2

Configuration of a Valkey 6.2 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Valkey servers in the cluster.

redisConfig_7_0

RedisConfigSet7_0

Configuration of a Valkey 7.0 server.

Includes only one of the fields redisConfig_5_0, redisConfig_6_0, redisConfig_6_2, redisConfig_7_0.

Configuration for Valkey servers in the cluster.

resources

Resources

Resources allocated to Valkey hosts.

backupWindowStart

TimeOfDay

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

access

Access

Access policy to DB

redis

RedisConfigSet

Unified configuration of a Valkey cluster. Use this field for all currently
available versions.

diskSizeAutoscaling

DiskSizeAutoscaling

Disk size autoscaling settings

backupRetainPeriodDays

string (int64)

Retain period of automatically created backup in days

modules

ValkeyModules

Valkey modules settings

fullVersion

string

Full version of the server software, including the minor version.

tieredStorageEnabled

boolean

Enables tiered storage (disk + NVMe hot tier). Requires the tiered storage
edition: when the flag is set on creation, the cluster version is switched
to that edition.

shardAutoscalingSettings

ShardAutoscalingSettings

Shard autoscaling settings. When enabled, the cluster can automatically
add or delete shards based on resource utilization metrics.

Field

Description

effectiveConfig

RedisConfig5_0

Effective settings for a Valkey 5.0 cluster (a combination of settings
defined in userConfig and defaultConfig).

userConfig

RedisConfig5_0

User-defined settings for a Valkey 5.0 cluster.

defaultConfig

RedisConfig5_0

Default configuration for a Valkey 5.0 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

Valkey key eviction policy for a dataset that reaches maximum memory,
available to the host. Valkey maxmemory setting depends on Managed
Service for Valkey host class.
All policies are described in detail in Redis documentation.

• VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
• ALLKEYS_LRU: Remove less recently used (LRU) keys.
• VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
• ALLKEYS_LFU: Remove least frequently used (LFU) keys.
• VOLATILE_RANDOM: Try to remove keys with expire set randomly.
• ALLKEYS_RANDOM: Remove keys randomly.
• VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set
  and shorter TTL first.
• NOEVICTION: Return errors when memory limit was reached and commands could require
  more memory to be used.

timeout

string (int64)

Time that Valkey keeps the connection open while the client is idle.
If no new command is sent during that time, the connection is closed.

Value must be greater than 0.

password

string

Authentication password.

The string length in characters must be 8-128. Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

databases

string (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

slowlogLogSlowerThan

string (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

slowlogMaxLen

string (int64)

Max slow requests number to log.

The minimum value is 0.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

Value must match the regular expression [KEg$lshzxeAtm]{0,12}.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Valkey connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Valkey connection output buffers limits for clients.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

The minimum value is 0.

softLimit

string (int64)

Limit in bytes during certain time period.

The minimum value is 0.

softSeconds

string (int64)

Seconds for soft limit.

The minimum value is 0.

Field

Description

effectiveConfig

RedisConfig6_0

Effective settings for a Valkey 6.0 cluster (a combination of settings
defined in userConfig and defaultConfig).

userConfig

RedisConfig6_0

User-defined settings for a Valkey 6.0 cluster.

defaultConfig

RedisConfig6_0

Default configuration for a Valkey 6.0 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

Valkey key eviction policy for a dataset that reaches maximum memory,
available to the host. Valkey maxmemory setting depends on Managed
Service for Valkey host class.
All policies are described in detail in Redis documentation.

• VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
• ALLKEYS_LRU: Remove less recently used (LRU) keys.
• VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
• ALLKEYS_LFU: Remove least frequently used (LFU) keys.
• VOLATILE_RANDOM: Try to remove keys with expire set randomly.
• ALLKEYS_RANDOM: Remove keys randomly.
• VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set
  and shorter TTL first.
• NOEVICTION: Return errors when memory limit was reached and commands could require
  more memory to be used.

timeout

string (int64)

Time that Valkey keeps the connection open while the client is idle.
If no new command is sent during that time, the connection is closed.

Value must be greater than 0.

password

string

Authentication password.

The string length in characters must be 8-128. Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

databases

string (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

slowlogLogSlowerThan

string (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

slowlogMaxLen

string (int64)

Max slow requests number to log.

The minimum value is 0.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Valkey connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Valkey connection output buffers limits for clients.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

The minimum value is 0.

softLimit

string (int64)

Limit in bytes during certain time period.

The minimum value is 0.

softSeconds

string (int64)

Seconds for soft limit.

The minimum value is 0.

Field

Description

effectiveConfig

RedisConfig6_2

Effective settings for a Valkey 6.2 cluster (a combination of settings
defined in userConfig and defaultConfig).

userConfig

RedisConfig6_2

User-defined settings for a Valkey 6.2 cluster.

defaultConfig

RedisConfig6_2

Default configuration for a Valkey 6.2 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

Valkey key eviction policy for a dataset that reaches maximum memory,
available to the host. Valkey maxmemory setting depends on Managed
Service for Valkey host class.
All policies are described in detail in Redis documentation.

• VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
• ALLKEYS_LRU: Remove less recently used (LRU) keys.
• VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
• ALLKEYS_LFU: Remove least frequently used (LFU) keys.
• VOLATILE_RANDOM: Try to remove keys with expire set randomly.
• ALLKEYS_RANDOM: Remove keys randomly.
• VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set
  and shorter TTL first.
• NOEVICTION: Return errors when memory limit was reached and commands could require
  more memory to be used.

timeout

string (int64)

Time that Valkey keeps the connection open while the client is idle.
If no new command is sent during that time, the connection is closed.

The minimum value is 0.

password

string

Authentication password.

The string length in characters must be 8-128. Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

databases

string (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

slowlogLogSlowerThan

string (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

slowlogMaxLen

string (int64)

Max slow requests number to log.

The minimum value is 0.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Valkey connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Valkey connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Valkey maxmemory percent

Acceptable values are 1 to 75, inclusive.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

The minimum value is 0.

softLimit

string (int64)

Limit in bytes during certain time period.

The minimum value is 0.

softSeconds

string (int64)

Seconds for soft limit.

The minimum value is 0.

Field

Description

effectiveConfig

RedisConfig7_0

Effective settings for a Valkey 7.0 cluster (a combination of settings
defined in userConfig and defaultConfig).

userConfig

RedisConfig7_0

User-defined settings for a Valkey 7.0 cluster.

defaultConfig

RedisConfig7_0

Default configuration for a Valkey 7.0 cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

Valkey key eviction policy for a dataset that reaches maximum memory,
available to the host. Valkey maxmemory setting depends on Managed
Service for Valkey host class.
All policies are described in detail in Redis documentation.

• VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
• ALLKEYS_LRU: Remove less recently used (LRU) keys.
• VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
• ALLKEYS_LFU: Remove least frequently used (LFU) keys.
• VOLATILE_RANDOM: Try to remove keys with expire set randomly.
• ALLKEYS_RANDOM: Remove keys randomly.
• VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set
  and shorter TTL first.
• NOEVICTION: Return errors when memory limit was reached and commands could require
  more memory to be used.

timeout

string (int64)

Time that Valkey keeps the connection open while the client is idle.
If no new command is sent during that time, the connection is closed.

The minimum value is 0.

password

string

Authentication password.

The string length in characters must be 8-128. Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_-]{8,128}.

databases

string (int64)

Number of database buckets on a single redis-server process.

Value must be greater than 0.

slowlogLogSlowerThan

string (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 0.

slowlogMaxLen

string (int64)

Max slow requests number to log.

The minimum value is 0.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

Value must match the regular expression [KEg$lshzxeAtm]{0,13}.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Valkey connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Valkey connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Valkey maxmemory percent

Acceptable values are 1 to 75, inclusive.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

The minimum value is 0.

softLimit

string (int64)

Limit in bytes during certain time period.

The minimum value is 0.

softSeconds

string (int64)

Seconds for soft limit.

The minimum value is 0.

Field

Description

resourcePresetId

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
To get the list of available presets, use a ResourcePresetService.List request;
presets are also listed in the documentation.

diskSize

string (int64)

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

diskTypeId

string

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

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

Field

Description

hours

integer (int32)

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
to allow the value "24:00:00" for scenarios like business closing time.

minutes

integer (int32)

Minutes of hour of day. Must be from 0 to 59.

seconds

integer (int32)

Seconds of minutes of the time. Must normally be from 0 to 59. An API may
allow the value 60 if it allows leap-seconds.

nanos

integer (int32)

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Field

Description

dataLens

boolean

Allow access for DataLens

webSql

boolean

Allow access for Web SQL.

Field

Description

effectiveConfig

RedisConfig

Effective settings for a Valkey cluster (a combination of settings
defined in userConfig and defaultConfig).

userConfig

RedisConfig

User-defined settings for a Valkey cluster.

defaultConfig

RedisConfig

Default configuration for a Valkey cluster.

Field

Description

maxmemoryPolicy

enum (MaxmemoryPolicy)

Valkey key eviction policy for a dataset that reaches maximum memory,
available to the host. Valkey maxmemory setting depends on Managed
Service for Valkey host class.
All policies are described in detail in Redis documentation.

• VOLATILE_LRU: Try to remove less recently used (LRU) keys with expire set.
• ALLKEYS_LRU: Remove less recently used (LRU) keys.
• VOLATILE_LFU: Try to remove least frequently used (LFU) keys with expire set.
• ALLKEYS_LFU: Remove least frequently used (LFU) keys.
• VOLATILE_RANDOM: Try to remove keys with expire set randomly.
• ALLKEYS_RANDOM: Remove keys randomly.
• VOLATILE_TTL: Try to remove less recently used (LRU) keys with expire set
  and shorter TTL first.
• NOEVICTION: Return errors when memory limit was reached and commands could require
  more memory to be used.

timeout

string (int64)

Time that Valkey keeps the connection open while the client is idle.
If no new command is sent during that time, the connection is closed.

password

string

Authentication password.

Value must match the regular expression [a-zA-Z0-9@=+?*.,!&#$^<>_%-]{0,128}.

databases

string (int64)

Number of database buckets on a single redis-server process.

Acceptable values are 1 to 2147483647, inclusive.

slowlogLogSlowerThan

string (int64)

Threshold for logging slow requests to server in microseconds (log only slower than it).

The minimum value is 10.

slowlogMaxLen

string (int64)

Max slow requests number to log.

The minimum value is 0.

notifyKeyspaceEvents

string

String setting for pub\sub functionality.

Value must match the regular expression [KEg$lshzxeAtmdn]{0,15}.

clientOutputBufferLimitPubsub

ClientOutputBufferLimit

Valkey connection output buffers limits for pubsub operations.

clientOutputBufferLimitNormal

ClientOutputBufferLimit

Valkey connection output buffers limits for clients.

maxmemoryPercent

string (int64)

Share of the host RAM used as the Valkey maxmemory limit, in percent.

Acceptable values are 1 to 75, inclusive.

luaTimeLimit

string (int64)

Maximum time in milliseconds for Lua scripts, 0 - disabled mechanism

Acceptable values are 0 to 5000, inclusive.

replBacklogSizePercent

string (int64)

Replication backlog size as a percentage of the host RAM.

Acceptable values are 1 to 75, inclusive.

clusterRequireFullCoverage

boolean

Controls whether all hash slots must be covered by nodes.

clusterAllowReadsWhenDown

boolean

Allows read operations when cluster is down.

clusterAllowPubsubshardWhenDown

boolean

Permits Pub/Sub shard operations when cluster is down.

lfuDecayTime

string (int64)

The time, in minutes, that must elapse in order for the key counter to be divided by two (or decremented if it has a value less <= 10).

Acceptable values are 0 to 100000, inclusive.

lfuLogFactor

string (int64)

Determines how the frequency counter represents key hits.

Acceptable values are 0 to 1000, inclusive.

turnBeforeSwitchover

boolean

Allows to turn before switchover in RDSync

allowDataLoss

boolean

Allows some data to be lost in favor of faster switchover/restart

useLuajit

boolean

Use JIT for lua scripts and functions

ioThreadsAllowed

boolean

Allow valkey to use io-threads. When enabled, the number of threads is
derived from the host class; when disabled, a single thread is used.

zsetMaxListpackEntries

string (int64)

Controls max number of entries in zset before conversion from memory-efficient listpack to CPU-efficient hash table and skiplist.

Acceptable values are 32 to 2048, inclusive.

aofMaxSizePercent

string (int64)

AOF maximum size as a percentage of the host disk size.

Acceptable values are 1 to 99, inclusive.

activedefrag

boolean

Enable active (online) memory defragmentation

auditLog

boolean

Enable/disable audit logs for Valkey

rebalanceEnabled

boolean

Enables automatic slot rebalancing when shards are added or deleted.

Field

Description

hardLimit

string (int64)

Total limit in bytes.

The minimum value is 0.

softLimit

string (int64)

Limit in bytes during certain time period.

The minimum value is 0.

softSeconds

string (int64)

Seconds for soft limit.

The minimum value is 0.

Field

Description

plannedUsageThreshold

string (int64)

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

Acceptable values are 0 to 100, inclusive.

emergencyUsageThreshold

string (int64)

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

Acceptable values are 0 to 100, inclusive.

diskSizeLimit

string (int64)

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

Field

Description

valkeySearch

ValkeySearch

valkey-search module settings: vector and full-text search.

valkeyJson

ValkeyJson

valkey-json module settings: the JSON data type and commands.

valkeyBloom

ValkeyBloom

valkey-bloom module settings: probabilistic data structures.

Field

Description

enabled

boolean

Enable valkey-search module

readerThreads

string (int64)

Controls the amount of threads executing queries.

The minimum value is 0.

writerThreads

string (int64)

Controls the amount of threads processing index mutations.

The minimum value is 0.

version

string

Module version

Field

Description

enabled

boolean

Enable valkey-json module

version

string

Module version

Field

Description

enabled

boolean

Enable valkey-bloom module

version

string

Module version

Field

Description

enabled

boolean

Whether shard autoscaling is enabled for the cluster.
When enabled, at least one of the thresholds must have a non-zero
ShardAutoscalingThreshold.upThreshold.

minShards

string (int64)

Minimum number of shards the cluster can scale down to.

The minimum value is 1.

maxShards

string (int64)

Maximum number of shards the cluster can scale up to.
Must be greater than or equal to minShards and must not exceed
the maximum number of shards allowed for the cluster.

The minimum value is 1.

cpuThreshold

ShardAutoscalingThreshold

CPU utilization threshold.

memoryThreshold

ShardAutoscalingThreshold

Memory utilization threshold.

networkThreshold

ShardAutoscalingThreshold

Network utilization threshold.

Field

Description

downThreshold

string (int64)

Threshold for downscaling, in percent. Must be lower than upThreshold.

Acceptable values are 0 to 100, inclusive.

upThreshold

string (int64)

Threshold for upscaling

Acceptable values are 0 to 100, inclusive.

Field

Description

anytime

object

Maintenance operation can be scheduled anytime.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Maintenance operation can be scheduled on a weekly basis.

Includes only one of the fields anytime, weeklyMaintenanceWindow.

The maintenance policy in effect.

Field

Description

day

enum (WeekDay)

Day of the week (in DDD format).

• MON: Monday.
• TUE: Tuesday.
• WED: Wednesday.
• THU: Thursday.
• FRI: Friday.
• SAT: Saturday.
• SUN: Sunday.

hour

string (int64)

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

Acceptable values are 1 to 24, inclusive.

Field

Description

info

string

Information about this maintenance operation.

The maximum string length in characters is 256.

delayedUntil

string (date-time)

Time until which this maintenance operation is delayed.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Field

Description

anytime

object

Maintenance operations can be scheduled anytime.

Includes only one of the fields anytime, weeklyMaintenanceSchedule.

weeklyMaintenanceSchedule

WeeklyMaintenanceSchedule

Maintenance operations can be scheduled during the specified weekly slots.

Includes only one of the fields anytime, weeklyMaintenanceSchedule.

Field

Description

slots[]

MaintenanceWindowSlot

Weekly time slots during which maintenance operations can be scheduled.
At least one slot is required.

The number of elements must be greater than 0.

Field

Description

day

enum (DayOfWeek)

Day of the week.

• MONDAY: The day-of-week of Monday.
• TUESDAY: The day-of-week of Tuesday.
• WEDNESDAY: The day-of-week of Wednesday.
• THURSDAY: The day-of-week of Thursday.
• FRIDAY: The day-of-week of Friday.
• SATURDAY: The day-of-week of Saturday.
• SUNDAY: The day-of-week of Sunday.

startTime

TimeOfDay

Required field. Start time in UTC.

duration

string (duration)

Required field. Slot duration.

allowTemporaryUnavailability

boolean

Allows maintenance operations that may cause temporary write unavailability.