Managed Service for MySQL API, REST: Cluster.Backup

Field

Description

clusterId

string

Required field. ID of the cluster to back up.

To get this ID, make a ClusterService.List request.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

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).

done

boolean

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

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.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

Cluster

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.

Includes only one of the fields error, 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.

Field

Description

clusterId

string

ID of the cluster that is being backed up.

backupId

string

ID of the MySQL backup that is created.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Field

Description

id

string

ID of the cluster.

This ID is assigned by the platform at the time of creation.

folderId

string

ID of the folder that the cluster belongs to.

createdAt

string (date-time)

Creation timestamp of the cluster.

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

description

string

Description of the cluster.

labels

string

Custom labels for the cluster as key:value pairs.

environment

enum (Environment)

Deployment environment of the MySQL cluster.

• ENVIRONMENT_UNSPECIFIED
• PRODUCTION: Environment for stable versions of your apps.
  A conservative update policy is in effect: only bug fixes are applied during regular maintenance.
• PRESTABLE: Environment for testing, including the Managed Service for MySQL itself.
  This environment gets new features, improvements, and bug fixes in the first place, compared to the production environment.
  However, not every update ensures backward compatibility.

monitoring[]

Monitoring

Monitoring systems data that is relevant to the cluster.

config

ClusterConfig

Configuration of the cluster.

networkId

string

ID of the network that the cluster belongs to.

health

enum (Health)

Aggregated health of the cluster.

• HEALTH_UNKNOWN: Health of the cluster is unknown (Host.health for every host in the cluster is UNKNOWN).
• ALIVE: Cluster is alive and well (Host.health for every host in the cluster is ALIVE).
• DEAD: Cluster is inoperable (Host.health for every host in the cluster is DEAD).
• DEGRADED: Cluster is degraded (Host.health for at least one host in the cluster is not ALIVE).

status

enum (Status)

Current state of the cluster.

• STATUS_UNKNOWN: Cluster state is unknown.
• CREATING: Cluster is being created.
• RUNNING: Cluster is running normally.
• ERROR: Cluster encountered a problem and cannot operate.
• UPDATING: Cluster is being updated.
• STOPPING: Cluster is stopping.
• STOPPED: Cluster is stopped.
• STARTING: Cluster is starting.

maintenanceWindow

MaintenanceWindow

Maintenance window settings for the cluster.

plannedOperation

MaintenanceOperation

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

securityGroupIds[]

string

Effective list of security group IDs applied to the cluster.

deletionProtection

boolean

This option prevents unintended deletion of the cluster.

hostGroupIds[]

string

Host groups hosting VMs of the cluster.

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

Field

Description

version

string

Version of MySQL used in the cluster.

mysqlConfig_5_7

MysqlConfigSet5_7

Configuration of a MySQL 5.7 server.

Includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0.

Cluster-wide MySQL configuration.

mysqlConfig_8_0

MysqlConfigSet8_0

Configuration of a MySQL 8.0 server.

Includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0.

Cluster-wide MySQL configuration.

resources

Resources

Resource preset for the cluster hosts.

backupWindowStart

TimeOfDay

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

access

Access

Access policy for external services.

performanceDiagnostics

PerformanceDiagnostics

Configuration of the performance diagnostics service.

backupRetainPeriodDays

string (int64)

Retention policy of automated backups.

Field

Description

effectiveConfig

MysqlConfig5_7

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

userConfig

MysqlConfig5_7

User-defined settings for a MySQL 5.7 cluster.

defaultConfig

MysqlConfig5_7

Default configuration for a MySQL 5.7 cluster.

Field

Description

innodbBufferPoolSize

string (int64)

Size of the InnoDB buffer pool used for caching table and index data.

See MySQL documentation for details.

maxConnections

string (int64)

The maximum permitted number of simultaneous client connections.

See MySQL documentation for details.

longQueryTime

number (double)

Time that it takes to process a query before it is considered slow.

See MySQL documentation for details.

generalLog

boolean

Enable writing of general query log of MySQL.

See MySQL documentation for details.

auditLog

boolean

Enable writing of audit log of MySQL.

See MySQL documentation for details.

sqlMode[]

enum (SQLMode)

Server SQL mode of MySQL.

See MySQL documentation for details.

• SQLMODE_UNSPECIFIED
• ALLOW_INVALID_DATES
• ANSI_QUOTES
• ERROR_FOR_DIVISION_BY_ZERO
• HIGH_NOT_PRECEDENCE
• IGNORE_SPACE
• NO_AUTO_VALUE_ON_ZERO
• NO_BACKSLASH_ESCAPES
• NO_ENGINE_SUBSTITUTION
• NO_UNSIGNED_SUBTRACTION
• NO_ZERO_DATE
• NO_ZERO_IN_DATE
• NO_FIELD_OPTIONS
• NO_KEY_OPTIONS
• NO_TABLE_OPTIONS
• ONLY_FULL_GROUP_BY
• PAD_CHAR_TO_FULL_LENGTH
• PIPES_AS_CONCAT
• REAL_AS_FLOAT
• STRICT_ALL_TABLES
• STRICT_TRANS_TABLES
• ANSI
• TRADITIONAL
• DB2
• MAXDB
• MSSQL
• MYSQL323
• MYSQL40
• ORACLE
• POSTGRESQL
• NO_AUTO_CREATE_USER
• NO_DIR_IN_CREATE

maxAllowedPacket

string (int64)

The maximum size in bytes of one packet.

See MySQL documentation for details.

defaultAuthenticationPlugin

enum (AuthPlugin)

Authentication plugin used in the managed MySQL cluster.

See MySQL documentation for details.

• AUTH_PLUGIN_UNSPECIFIED
• MYSQL_NATIVE_PASSWORD: Using Native Pluggable Authentication.
• CACHING_SHA2_PASSWORD
• SHA256_PASSWORD: Using SHA-256 Pluggable Authentication.

innodbFlushLogAtTrxCommit

string (int64)

Transaction log flush behaviour.

See MySQL documentation for details.

innodbLockWaitTimeout

string (int64)

Max time in seconds for a transaction to wait for a row lock.

See MySQL documentation for details.

transactionIsolation

enum (TransactionIsolation)

Default transaction isolation level.

See MySQL documentation for details.

• TRANSACTION_ISOLATION_UNSPECIFIED
• READ_COMMITTED
• REPEATABLE_READ
• SERIALIZABLE

innodbPrintAllDeadlocks

boolean

Print information about deadlocks in error log.

See MySQL documentation for details.

netReadTimeout

string (int64)

The number of seconds to wait for more data from a connection before aborting the read.

See MySQL documentation for details.

netWriteTimeout

string (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.

See MySQL documentation for details.

groupConcatMaxLen

string (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

See MySQL documentation for details.

tmpTableSize

string (int64)

The maximum size of internal in-memory temporary tables.

See MySQL documentation for details.

maxHeapTableSize

string (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.

See MySQL documentation for details.

defaultTimeZone

string

The servers default time zone.

See MySQL documentation for details.

characterSetServer

string

The servers default character set.

See MySQL documentation for details.

collationServer

string

The server default collation.

See MySQL documentation for details.

innodbAdaptiveHashIndex

boolean

Enables InnoDB adaptive hash index.

See MySQL documentation for details.

innodbNumaInterleave

boolean

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.

See MySQL documentation for details.

innodbLogBufferSize

string (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

See MySQL documentation for details.

innodbLogFileSize

string (int64)

The size in bytes of the single InnoDB Redo log file.

See MySQL documentation for details.

innodbIoCapacity

string (int64)

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbIoCapacityMax

string (int64)

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbReadIoThreads

string (int64)

The number of I/O threads for read operations in InnoDB.

See MySQL documentation for details.

innodbWriteIoThreads

string (int64)

The number of I/O threads for write operations in InnoDB.

See MySQL documentation for details.

innodbPurgeThreads

string (int64)

The number of background threads devoted to the InnoDB purge operation.

See MySQL documentation for details.

innodbThreadConcurrency

string (int64)

Defines the maximum number of threads permitted inside of InnoDB.

See MySQL documentation for details.

innodbTempDataFileMaxSize

string (int64)

Limits the max size of InnoDB temp tablespace.

See MySQL documentation for details.

threadCacheSize

string (int64)

A number of threads the server should cache for reuse.

See MySQL documentation for details.

threadStack

string (int64)

The stack size for each thread. The default is large enough for normal operation.

See MySQL documentation for details.

joinBufferSize

string (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans.

See MySQL documentation for details.

sortBufferSize

string (int64)

Each session that must perform a sort allocates a buffer of this size.

See MySQL documentation for details.

tableDefinitionCache

string (int64)

The number of table definitions that can be stored in the definition cache.

See MySQL documentation for details.

tableOpenCache

string (int64)

The number of open tables for all threads.

See MySQL documentation for details.

tableOpenCacheInstances

string (int64)

The number of open tables cache instances.

See MySQL documentation for details.

explicitDefaultsForTimestamp

boolean

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.

See MySQL documentation for details.

autoIncrementIncrement

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

autoIncrementOffset

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

syncBinlog

string (int64)

Controls how often the MySQL server synchronizes the binary log to disk.

See MySQL documentation for details.

binlogCacheSize

string (int64)

The size of the cache to hold changes to the binary log during a transaction.

See MySQL documentation for details.

binlogGroupCommitSyncDelay

string (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.

See MySQL documentation for the variable for details.

binlogRowImage

enum (BinlogRowImage)

For MySQL row-based replication, this variable determines how row images are written to the binary log.

See MySQL documentation for details.

• BINLOG_ROW_IMAGE_UNSPECIFIED
• FULL
• MINIMAL
• NOBLOB

binlogRowsQueryLogEvents

boolean

When enabled, it causes the server to write informational log events such as row query log events into its binary log.

See MySQL documentation for details.

rplSemiSyncMasterWaitForSlaveCount

string (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.

See MySQL documentation for details.

slaveParallelType

enum (SlaveParallelType)

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.

See MySQL documentation for details.

• SLAVE_PARALLEL_TYPE_UNSPECIFIED
• DATABASE
• LOGICAL_CLOCK

slaveParallelWorkers

string (int64)

Sets the number of applier threads for executing replication transactions in parallel.

See MySQL documentation for details.

mdbPreserveBinlogBytes

string (int64)

The size of the binary log to hold.

interactiveTimeout

string (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.

See MySQL documentation for details.

waitTimeout

string (int64)

The number of seconds the server waits for activity on a noninteractive connection before closing it.

See MySQL documentation for details.

mdbOfflineModeEnableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

mdbOfflineModeDisableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag value.

rangeOptimizerMaxMemSize

string (int64)

The limit on memory consumption for the range optimizer.

See MySQL documentation for details.

slowQueryLog

boolean

Manages slow query log.

See MySQL documentation for details.

slowQueryLogAlwaysWriteTime

number (double)

Query execution time, after which query to be logged unconditionally, that is, `log_slow_rate_limit`` will not apply to it.

See Percona documentation for details.

logSlowRateType

enum (LogSlowRateType)

Specifies slow log granularity for log_slow_rate_limit values QUERY or SESSION.

See Percona documentation for details.

• LOG_SLOW_RATE_TYPE_UNSPECIFIED
• SESSION
• QUERY

logSlowRateLimit

string (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.

See Percona documentation for details.

logSlowSpStatements

boolean

When TRUE, statements executed by stored procedures are logged to the slow log.

See Percona documentation for details.

logSlowFilter[]

enum (LogSlowFilterType)

Filters the slow log by the query's execution plan.

See Percona documentation for details.

• LOG_SLOW_FILTER_TYPE_UNSPECIFIED
• FULL_SCAN
• FULL_JOIN
• TMP_TABLE
• TMP_TABLE_ON_DISK
• FILESORT
• FILESORT_ON_DISK

mdbPriorityChoiceMaxLag

string (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

innodbPageSize

string (int64)

Specifies the page size for InnoDB tablespaces.

For details, see MySQL documentation for the variable.

innodbOnlineAlterLogMaxSize

string (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations

For details, see MySQL documentation for the variable.

innodbFtMinTokenSize

string (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index

For details, see MySQL documentation for the variable.

innodbFtMaxTokenSize

string (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index

For details, see MySQL documentation for the variable.

lowerCaseTableNames

string (int64)

Table names storage and comparison strategy

For details, see MySQL documentation for the variable.

showCompatibility_56

boolean

Manages MySQL 5.6 compatibility

For details, see MySQL documentation for the variable.

maxSpRecursionDepth

string (int64)

The number of times that any given stored procedure may be called recursively.

For details, see MySQL documentation for the variable.

innodbCompressionLevel

string (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.

For details, see MySQL documentation for the variable.

binlogTransactionDependencyTracking

enum (BinlogTransactionDependencyTracking)

Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel.

For details, see MySQL documentation for the variable.

• BINLOG_TRANSACTION_DEPENDENCY_TRACKING_UNSPECIFIED
• COMMIT_ORDER
• WRITESET
• WRITESET_SESSION

autocommit

boolean

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.

For details, see MySQL documentation for the variable.

innodbStatusOutput

boolean

Enables or disables periodic output for the standard InnoDB Monitor.

For details, see MySQL documentation for the variable.

innodbStrictMode

boolean

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.

For details, see MySQL documentation for the variable.

innodbPrintLockWaitTimeoutInfo

boolean

Makes InnoDB to write information about all lock wait timeout errors into the log file.

For details, see Percona documentation for the variable.

logErrorVerbosity

string (int64)

System variable specifies the verbosity for handling events intended for the error log

For details, see MySQL documentation for the variable.

maxDigestLength

string (int64)

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.

For details, see MySQL documentation for the variable.

queryCacheLimit

string (int64)

Do not cache results that are larger than this number of bytes.

For details, see MySQL documentation for the variable.

queryCacheSize

string (int64)

The amount of memory allocated for caching query results.

For details, see MySQL documentation for the variable.

queryCacheType

string (int64)

Set the query cache type.

For details, see MySQL documentation for the variable.

lockWaitTimeout

string (int64)

This variable specifies the timeout in seconds for attempts to acquire metadata locks

For details, see MySQL documentation for the variable.

maxPreparedStmtCount

string (int64)

This variable limits the total number of prepared statements in the server.

For details, see MySQL documentation for the variable.

optimizerSwitch

string

The system variable enables control over optimizer behavior.

For details, see MySQL documentation for the variable
https://dev.mysql.com/doc/refman/5.7/en/switchable-optimizations.html

optimizerSearchDepth

string (int64)

The maximum depth of search performed by the query optimizer

For details, see MySQL documentation for the variable

queryResponseTimeStats

boolean

Enables and disables collection of query times

For details, see Percona documentation for the variable.

userstat

boolean

Enables or disables collection of statistics

For details, see Percona documentation for the variable.

maxExecutionTime

string (int64)

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.

For details, see MySQL documentation for the variable

Field

Description

effectiveConfig

MysqlConfig8_0

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

userConfig

MysqlConfig8_0

User-defined settings for a MySQL 8.0 cluster.

defaultConfig

MysqlConfig8_0

Default configuration for a MySQL 8.0 cluster.

Field

Description

innodbBufferPoolSize

string (int64)

Size of the InnoDB buffer pool used for caching table and index data.

See MySQL documentation for details.

maxConnections

string (int64)

The maximum permitted number of simultaneous client connections.

See MySQL documentation for details.

longQueryTime

number (double)

Time that it takes to process a query before it is considered slow.

See MySQL documentation for details.

generalLog

boolean

Enable writing of general query log of MySQL.

See MySQL documentation for details.

auditLog

boolean

Enable writing of audit log of MySQL.

See MySQL documentation for details.

sqlMode[]

enum (SQLMode)

Server SQL mode of MySQL.

See MySQL documentation for details.

• SQLMODE_UNSPECIFIED
• ALLOW_INVALID_DATES
• ANSI_QUOTES
• ERROR_FOR_DIVISION_BY_ZERO
• HIGH_NOT_PRECEDENCE
• IGNORE_SPACE
• NO_AUTO_VALUE_ON_ZERO
• NO_BACKSLASH_ESCAPES
• NO_ENGINE_SUBSTITUTION
• NO_UNSIGNED_SUBTRACTION
• NO_ZERO_DATE
• NO_ZERO_IN_DATE
• ONLY_FULL_GROUP_BY
• PAD_CHAR_TO_FULL_LENGTH
• PIPES_AS_CONCAT
• REAL_AS_FLOAT
• STRICT_ALL_TABLES
• STRICT_TRANS_TABLES
• TIME_TRUNCATE_FRACTIONAL
• ANSI
• TRADITIONAL
• NO_DIR_IN_CREATE

maxAllowedPacket

string (int64)

The maximum size in bytes of one packet.

See MySQL documentation for details.

defaultAuthenticationPlugin

enum (AuthPlugin)

Authentication plugin used in the managed MySQL cluster.

See MySQL documentation for details.

• AUTH_PLUGIN_UNSPECIFIED
• MYSQL_NATIVE_PASSWORD: Using Native Pluggable Authentication.
• CACHING_SHA2_PASSWORD: Using Caching SHA-2 Pluggable Authentication.
• SHA256_PASSWORD: Using SHA-256 Pluggable Authentication.

innodbFlushLogAtTrxCommit

string (int64)

Transaction log flush behaviour.

See MySQL documentation for details.

innodbLockWaitTimeout

string (int64)

Max time in seconds for a transaction to wait for a row lock.

See MySQL documentation for details.

transactionIsolation

enum (TransactionIsolation)

Default transaction isolation level.

See MySQL documentation for details.

• TRANSACTION_ISOLATION_UNSPECIFIED
• READ_COMMITTED
• REPEATABLE_READ
• SERIALIZABLE

innodbPrintAllDeadlocks

boolean

Print information about deadlocks in error log.

See MySQL documentation for details.

netReadTimeout

string (int64)

The number of seconds to wait for more data from a connection before aborting the read.

See MySQL documentation for details.

netWriteTimeout

string (int64)

The number of seconds to wait for a block to be written to a connection before aborting the write.

See MySQL documentation for details.

groupConcatMaxLen

string (int64)

The maximum permitted result length in bytes for the GROUP_CONCAT() function.

See MySQL documentation for details.

tmpTableSize

string (int64)

The maximum size of internal in-memory temporary tables.

See MySQL documentation for details.

maxHeapTableSize

string (int64)

This variable sets the maximum size to which user-created MEMORY tables are permitted to grow.

See MySQL documentation for details.

defaultTimeZone

string

The servers default time zone.

See MySQL documentation for details.

characterSetServer

string

The servers default character set.

See MySQL documentation for details.

collationServer

string

The server default collation.

See MySQL documentation for details.

innodbAdaptiveHashIndex

boolean

Enables InnoDB adaptive hash index.

See MySQL documentation for details.

innodbNumaInterleave

boolean

Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool.

See MySQL documentation for details.

innodbLogBufferSize

string (int64)

The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

See MySQL documentation for details.

innodbLogFileSize

string (int64)

The size in bytes of the single InnoDB Redo log file.

See MySQL documentation for details.

innodbIoCapacity

string (int64)

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbIoCapacityMax

string (int64)

Limits IO available for InnoDB background tasks.

See MySQL documentation for details.

innodbReadIoThreads

string (int64)

The number of I/O threads for read operations in InnoDB.

See MySQL documentation for details.

innodbWriteIoThreads

string (int64)

The number of I/O threads for write operations in InnoDB.

See MySQL documentation for details.

innodbPurgeThreads

string (int64)

The number of background threads devoted to the InnoDB purge operation.

See MySQL documentation for details.

innodbThreadConcurrency

string (int64)

Defines the maximum number of threads permitted inside of InnoDB.

See MySQL documentation for details.

innodbTempDataFileMaxSize

string (int64)

Limits the max size of InnoDB temp tablespace.

See MySQL documentation for details.

threadCacheSize

string (int64)

How many threads the server should cache for reuse.

See MySQL documentation for details.

threadStack

string (int64)

The stack size for each thread. The default is large enough for normal operation.

See MySQL documentation for details.

joinBufferSize

string (int64)

The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans.

See MySQL documentation for details.

sortBufferSize

string (int64)

Each session that must perform a sort allocates a buffer of this size.

See MySQL documentation for details.

tableDefinitionCache

string (int64)

The number of table definitions that can be stored in the definition cache.

See MySQL documentation for details.

tableOpenCache

string (int64)

The number of open tables for all threads.

See MySQL documentation for details.

tableOpenCacheInstances

string (int64)

The number of open tables cache instances.

See MySQL documentation for details.

explicitDefaultsForTimestamp

boolean

Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.

See MySQL documentation for details.

autoIncrementIncrement

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

autoIncrementOffset

string (int64)

Can be used to control the operation of AUTO_INCREMENT columns.

See MySQL documentation for details.

syncBinlog

string (int64)

Controls how often the MySQL server synchronizes the binary log to disk.

See MySQL documentation for details.

binlogCacheSize

string (int64)

The size of the cache to hold changes to the binary log during a transaction.

See MySQL documentation for details.

binlogGroupCommitSyncDelay

string (int64)

Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk.

See MySQL documentation for details.

binlogRowImage

enum (BinlogRowImage)

For MySQL row-based replication, this variable determines how row images are written to the binary log.

See MySQL documentation for details.

• BINLOG_ROW_IMAGE_UNSPECIFIED
• FULL
• MINIMAL
• NOBLOB

binlogRowsQueryLogEvents

boolean

When enabled, it causes the server to write informational log events such as row query log events into its binary log.

See MySQL documentation for details.

rplSemiSyncMasterWaitForSlaveCount

string (int64)

The number of replica acknowledgments the source must receive per transaction before proceeding.

See MySQL documentation for details.

slaveParallelType

enum (SlaveParallelType)

When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica.

See MySQL documentation for details.

• SLAVE_PARALLEL_TYPE_UNSPECIFIED
• DATABASE
• LOGICAL_CLOCK

slaveParallelWorkers

string (int64)

Sets the number of applier threads for executing replication transactions in parallel.

See MySQL documentation for details.

regexpTimeLimit

string (int64)

The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions.

See MySQL documentation for details.

mdbPreserveBinlogBytes

string (int64)

The size of the binary log to hold.

interactiveTimeout

string (int64)

The number of seconds the server waits for activity on an interactive connection before closing it.

See MySQL documentation for details.

waitTimeout

string (int64)

The number of seconds the server waits for activity on a noninteractive connection before closing it.

See MySQL documentation for details.

mdbOfflineModeEnableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data.

mdbOfflineModeDisableLag

string (int64)

Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'.
Should be less than mdb_offline_mode_enable_lag.

rangeOptimizerMaxMemSize

string (int64)

The limit on memory consumption for the range optimizer.

See MySQL documentation for details.

slowQueryLog

boolean

Manages slow query log.

See MySQL documentation for details.

slowQueryLogAlwaysWriteTime

number (double)

Query execution time, after which query to be logged unconditionally, that is, log_slow_rate_limit will not apply to it.

See Percona documentation for details.

logSlowRateType

enum (LogSlowRateType)

Specifies slow log granularity for log_slow_rate_limit QUERY or SESSION value.

See Percona documentation for details.

• LOG_SLOW_RATE_TYPE_UNSPECIFIED
• SESSION
• QUERY

logSlowRateLimit

string (int64)

Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query.

See Percona documentation for details.

logSlowSpStatements

boolean

When TRUE, statements executed by stored procedures are logged to the slow log.

See Percona documentation for details.

logSlowFilter[]

enum (LogSlowFilterType)

Filters the slow log by the query's execution plan.

See Percona documentation for details.

• LOG_SLOW_FILTER_TYPE_UNSPECIFIED
• FULL_SCAN
• FULL_JOIN
• TMP_TABLE
• TMP_TABLE_ON_DISK
• FILESORT
• FILESORT_ON_DISK

mdbPriorityChoiceMaxLag

string (int64)

Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from".
Should be less than mdb_offline_mode_disable_lag.

innodbPageSize

string (int64)

Specifies the page size for InnoDB tablespaces.

For details, see MySQL documentation for the variable.

innodbOnlineAlterLogMaxSize

string (int64)

The limit in bytes on the size of the temporary log files used during online DDL operations

See MySQL documentation for the variable for details.

innodbFtMinTokenSize

string (int64)

Minimum length of words that are stored in an InnoDB FULLTEXT index

See MySQL documentation for the variable for details.

innodbFtMaxTokenSize

string (int64)

Maximum length of words that are stored in an InnoDB FULLTEXT index

See MySQL documentation for the variable for details.

lowerCaseTableNames

string (int64)

Table names storage and comparison strategy

See MySQL documentation for the variable for details.

maxSpRecursionDepth

string (int64)

The number of times that any given stored procedure may be called recursively.

For details, see MySQL documentation for the variable.

innodbCompressionLevel

string (int64)

The level of zlib compression to use for InnoDB compressed tables and indexes.

For details, see MySQL documentation for the variable.

binlogTransactionDependencyTracking

enum (BinlogTransactionDependencyTracking)

Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel.

For details, see MySQL documentation for the variable.

• BINLOG_TRANSACTION_DEPENDENCY_TRACKING_UNSPECIFIED
• COMMIT_ORDER
• WRITESET
• WRITESET_SESSION

autocommit

boolean

Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it.

For details, see MySQL documentation for the variable.

innodbStatusOutput

boolean

Enables or disables periodic output for the standard InnoDB Monitor.

For details, see MySQL documentation for the variable.

innodbStrictMode

boolean

When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options.

For details, see MySQL documentation for the variable.

innodbPrintLockWaitTimeoutInfo

boolean

Makes InnoDB to write information about all lock wait timeout errors into the log file.

For details, see Percona documentation for the variable.

logErrorVerbosity

string (int64)

System variable specifies the verbosity for handling events intended for the error log

For details, see MySQL documentation for the variable.

maxDigestLength

string (int64)

The maximum number of bytes of memory reserved per session for computation of normalized statement digests.

For details, see MySQL documentation for the variable.

lockWaitTimeout

string (int64)

This variable specifies the timeout in seconds for attempts to acquire metadata locks

For details, see MySQL documentation for the variable.

maxPreparedStmtCount

string (int64)

This variable limits the total number of prepared statements in the server.

For details, see MySQL documentation for the variable.

optimizerSwitch

string

The system variable enables control over optimizer behavior.

For details, see MySQL documentation for the variable
https://dev.mysql.com/doc/refman/8.0/en/switchable-optimizations.html

optimizerSearchDepth

string (int64)

The maximum depth of search performed by the query optimizer

For details, see MySQL documentation for the variable

userstat

boolean

Enables or disables collection of statistics

For details, see Percona documentation for the variable.

maxExecutionTime

string (int64)

The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled.

For details, see MySQL documentation for the variable

Field

Description

resourcePresetId

string

ID of the resource preset that defines available computational resources (vCPU, RAM, etc.) for a cluster host.

All available presets are listed in the documentation.

diskSize

string (int64)

Volume of the storage (for each cluster host, in bytes).

diskTypeId

string

Type of the storage.

Possible values:

• network-hdd - standard network storage
• network-ssd - fast network storage
• network-ssd-nonreplicated - fast network nonreplicated storage
• local-ssd - fast local storage.

See the documentation for details.

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

Allows access from DataLens.

See the documentation for details.

webSql

boolean

Allows SQL queries to the cluster databases from management console.

See the documentation for details.

dataTransfer

boolean

Allow access for DataTransfer.

Field

Description

enabled

boolean

Flag that shows if performance statistics gathering is enabled for the cluster.

sessionsSamplingInterval

string (int64)

Interval (in seconds) for my_session sampling.

statementsSamplingInterval

string (int64)

Interval (in seconds) for my_statements sampling.

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).

• WEEK_DAY_UNSPECIFIED
• MON
• TUE
• WED
• THU
• FRI
• SAT
• SUN

hour

string (int64)

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

Field

Description

info

string

Information about this maintenance operation.

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).