Method create

Required. ID of the folder to create the MySQL cluster in.

The maximum string length in characters is 50.

Required. Name of the MySQL 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 of the MySQL cluster.

The maximum string length in characters is 256.

Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary".

No more than 64 per resource. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*.

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

Configuration and resources for hosts that should be created for the MySQL cluster.

Version of MySQL used in the cluster. Possible values:

• 5.7
• 8.0

ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.

Volume of the storage available to a host.

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

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

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

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 of hour of day. Must be from 0 to 59.

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.

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

Allow access for DataLens

Allow SQL queries to the cluster databases from the Yandex.Cloud management console.

See SQL queries in the management console for more details.

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

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

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 16384, inclusive.

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

For details, see MySQL documentation for the variable.

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1073741824, inclusive.

Authentication plugin used in the managed MySQL cluster.

For details, see MySQL documentation for the variable

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

Transaction log flush behaviour.

For details, see MySQL documentation for the variable

Acceptable values are 1 to 2, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 28800, inclusive.

Default transaction isolation level.

For details, see MySQL documentation for the variable

Print information about deadlocks in error log

For details, see MySQL documentation for the variable

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 4 to 33554432, inclusive.

The maximum size of internal in-memory temporary tables.

For details, see MySQL documentation for the variable

Acceptable values are 1024 to 536870912, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 16384 to 536870912, inclusive.

The servers default time zone.

For details, see MySQL documentation for the variable

The servers default character set.

For details, see MySQL documentation for the variable

The server default collation.

For details, see MySQL documentation for the variable

Enables Innodb adaptive hash index

For details, see MySQL documentation for the variable

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

For details, see MySQL documentation for the variable

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

For details, see MySQL documentation for the variable

Acceptable values are 1048576 to 268435456, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 268435456 to 4294967296, inclusive.

Limits IO available for InnoDB background tasks

For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

Limits IO available for InnoDB background tasks

For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

Defines the maximum number of threads permitted inside of InnoDB.

For details, see MySQL documentation for the variable

Acceptable values are 0 to 1000, inclusive.

Limits the max size of InnoDB temp tablespace

For details, see MySQL documentation for the variable

Acceptable values are 0 to 107374182400, inclusive.

How many threads the server should cache for reuse.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 131072 to 16777216, inclusive.

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.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

The number of open tables for all threads.

For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

The number of open tables cache instances.

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 32, inclusive.

This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.

For details, see MySQL documentation for the variable.

Can be used to control the operation of AUTO_INCREMENT columns.

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

Can be used to control the operation of AUTO_INCREMENT columns.

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4096, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 67108864, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 50000, inclusive.

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

For details, see MySQL documentation for the variable.

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

For details, see MySQL documentation for the variable.

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

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 2, inclusive.

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

For details, see MySQL documentation for the variable.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 64, inclusive.

The size of the binary log to hold.

Acceptable values are 1073741824 to 107374182400, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

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

Acceptable values are 600 to 432000, inclusive.

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

Acceptable values are 60 to 86400, inclusive.

The limit on memory consumption for the range optimizer.

For details, see MySQL documentation for the variable.

Acceptable values are 1048576 to 268435456, inclusive.

Manages slow query log

For details, see MySQL documentation for the variable.

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

For details, see Percona documentation for the variable.

Specifies slow log granularity for log_slow_rate_limit: QUERY or SESSION

For details, see Percona documentation for the variable.

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

For details, see Percona documentation for the variable.

Acceptable values are 1 to 1000, inclusive.

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

For details, see Percona documentation for the variable.

Filters the slow log by the query's execution plan

For details, see Percona documentation for the variable.

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

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

For details, see MySQL documentation for the parameter.

The minimum value is 5242880.

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 16384, inclusive.

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

For details, see MySQL documentation for the variable.

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 1073741824, inclusive.

Authentication plugin used in the managed MySQL cluster.

For details, see MySQL documentation for the variable

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

Transaction log flush behaviour.

For details, see MySQL documentation for the variable

Acceptable values are 1 to 2, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 28800, inclusive.

Default transaction isolation level.

For details, see MySQL documentation for the variable

Print information about deadlocks in error log

For details, see MySQL documentation for the variable

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 1200, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 4 to 33554432, inclusive.

The maximum size of internal in-memory temporary tables.

For details, see MySQL documentation for the variable

Acceptable values are 1024 to 536870912, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 16384 to 536870912, inclusive.

The servers default time zone.

For details, see MySQL documentation for the variable

The servers default character set.

For details, see MySQL documentation for the variable

The server default collation.

For details, see MySQL documentation for the variable

Enables Innodb adaptive hash index

For details, see MySQL documentation for the variable

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

For details, see MySQL documentation for the variable

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

For details, see MySQL documentation for the variable

Acceptable values are 1048576 to 268435456, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 268435456 to 4294967296, inclusive.

Limits IO available for InnoDB background tasks

For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

Limits IO available for InnoDB background tasks

For details, see MySQL documentation for the variable

Acceptable values are 100 to 100000, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

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

For details, see MySQL documentation for the variable

Acceptable values are 1 to 16, inclusive.

Defines the maximum number of threads permitted inside of InnoDB.

For details, see MySQL documentation for the variable

Acceptable values are 0 to 1000, inclusive.

Limits the max size of InnoDB temp tablespace

For details, see MySQL documentation for the variable

Acceptable values are 0 to 107374182400, inclusive.

How many threads the server should cache for reuse.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 131072 to 16777216, inclusive.

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.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 16777216, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

The number of open tables for all threads.

For details, see MySQL documentation for the variable.

Acceptable values are 400 to 524288, inclusive.

The number of open tables cache instances.

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 32, inclusive.

This system variable determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns.

For details, see MySQL documentation for the variable.

Can be used to control the operation of AUTO_INCREMENT columns.

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

Can be used to control the operation of AUTO_INCREMENT columns.

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 65535, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 4096, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 4096 to 67108864, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 50000, inclusive.

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

For details, see MySQL documentation for the variable.

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

For details, see MySQL documentation for the variable.

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

For details, see MySQL documentation for the variable.

Acceptable values are 1 to 2, inclusive.

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

For details, see MySQL documentation for the variable.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 64, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 0 to 1048576, inclusive.

The size of the binary log to hold.

Acceptable values are 1073741824 to 107374182400, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

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

For details, see MySQL documentation for the variable.

Acceptable values are 600 to 86400, inclusive.

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

Acceptable values are 600 to 432000, inclusive.

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

Acceptable values are 60 to 86400, inclusive.

The limit on memory consumption for the range optimizer.

For details, see MySQL documentation for the variable.

Acceptable values are 1048576 to 268435456, inclusive.

Manages slow query log

For details, see MySQL documentation for the variable.

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

For details, see Percona documentation for the variable.

Specifies slow log granularity for log_slow_rate_limit: QUERY or SESSION

For details, see Percona documentation for the variable.

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

For details, see Percona documentation for the variable.

Acceptable values are 1 to 1000, inclusive.

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

For details, see Percona documentation for the variable.

Filters the slow log by the query's execution plan

For details, see Percona documentation for the variable.

Descriptions of databases to be created in the MySQL cluster.

Required. Name of the MySQL database.

The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

Descriptions of database users to be created in the MySQL cluster.

Required. Name of the MySQL user.

The maximum string length in characters is 32. Value must match the regular expression [a-zA-Z0-9_]*.

Required. Password of the MySQL user.

The string length in characters must be 8-128.

Set of permissions to grant to the user.

Name of the database that the permission grants access to.

• ALL_PRIVILEGES: All privileges that can be made available to the user.
• ALTER: Altering tables.
• ALTER_ROUTINE: Altering stored routines (stored procedures and functions).
• CREATE: Creating tables or indexes.
• CREATE_ROUTINE: Creating stored routines.
• CREATE_TEMPORARY_TABLES: Creating temporary tables.
• CREATE_VIEW: Creating views.
• DELETE: Deleting tables.
• DROP: Removing tables or views.
• EVENT: Creating, altering, dropping, or displaying events for the Event Scheduler.
• EXECUTE: Executing stored routines.
• INDEX: Creating and removing indexes.
• INSERT: Inserting rows into the database.
• LOCK_TABLES: Using LOCK TABLES statement for tables available with SELECT privilege.
• SELECT: Selecting rows from tables.

Some SELECT statements can be allowed without the SELECT privilege. All statements that read column values require the SELECT privilege. See details in MySQL documentation.

• SHOW_VIEW: Using the SHOW CREATE VIEW statement. Also needed for views used with EXPLAIN.
• TRIGGER: Creating, removing, executing, or displaying triggers for a table.
• UPDATE: Updating rows in the database.
• REFERENCES: Creation of a foreign key constraint for the parent table.

• REPLICATION_CLIENT: Enables use of the SHOW MASTER STATUS, SHOW SLAVE STATUS, and SHOW BINARY LOGS statements.
• REPLICATION_SLAVE: Enables the account to request updates that have been made to databases on the master server, using the SHOW SLAVE HOSTS, SHOW RELAYLOG EVENTS, and SHOW BINLOG EVENTS statements.
• PROCESS: Enables display of information about the threads executing within the server (that is, information about the statements being executed by sessions). The privilege enables use of SHOW PROCESSLIST or mysqladmin processlist to see threads belonging to other accounts; you can always see your own threads. The PROCESS privilege also enables use of SHOW ENGINE.

Set of user connection limits.

The maximum permitted number of user questions per hour.

The minimum value is 0.

The maximum permitted number of user updates per hour.

The minimum value is 0.

The maximum permitted number of simultaneous client connections per hour.

The minimum value is 0.

The maximum number of simultaneous connections permitted to any given MySQL user account.

The minimum value is 0.

User authentication plugin.

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

Individual configurations for hosts that should be created for the MySQL cluster.

ID of the availability zone where the host resides. To get a list of available zones, use the list request.

The maximum string length in characters is 50.

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

The maximum string length in characters is 50.

Whether the host should get a public IP address on creation.

After a host has been created, this setting cannot be changed. To remove an assigned public IP, or to assign a public IP to a host without one, recreate the host with assignPublicIp set as needed.

Possible values:

• false - don't assign a public IP to the host.
• true - the host should have a public IP address.

name of the host to be used as the replication source (for cascading replication).

Host backup priority

ID of the network to create the cluster in.

The maximum string length in characters is 50.

User security groups

Deletion Protection inhibits deletion of the cluster

ID of the operation.

Description of the operation. 0-256 characters long.

Creation timestamp.

String in RFC3339 text format.

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

The time when the Operation resource was last modified.

String in RFC3339 text format.

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.

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.

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

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

An error message.

A list of messages that carry the error details.

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.