Cluster

A set of methods for managing MySQL clusters.

JSON Representation

{
  "id": "string",
  "folderId": "string",
  "createdAt": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "environment": "string",
  "monitoring": [
    {
      "name": "string",
      "description": "string",
      "link": "string"
    }
  ],
  "config": {
    "version": "string",
    "resources": {
      "resourcePresetId": "string",
      "diskSize": "string",
      "diskTypeId": "string"
    },
    "backupWindowStart": {
      "hours": "integer",
      "minutes": "integer",
      "seconds": "integer",
      "nanos": "integer"
    },
    "access": {
      "dataLens": true
    },

    // `config` includes only one of the fields `mysqlConfig_5_7`, `mysqlConfig_8_0`
    "mysqlConfig_5_7": {
      "effectiveConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      },
      "userConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      },
      "defaultConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      }
    },
    "mysqlConfig_8_0": {
      "effectiveConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      },
      "userConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      },
      "defaultConfig": {
        "innodbBufferPoolSize": "integer",
        "maxConnections": "integer",
        "longQueryTime": "number",
        "generalLog": true,
        "auditLog": true,
        "sqlMode": [
          "string"
        ],
        "maxAllowedPacket": "integer",
        "defaultAuthenticationPlugin": "string"
      }
    },
    // end of the list of possible fields`config`

  },
  "networkId": "string",
  "health": "string",
  "status": "string"
}
Field Description
id string

ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.

folderId string

ID of the folder that the MySQL cluster belongs to.

createdAt string (date-time)

String in RFC3339 text format.

name string

Name of the MySQL cluster. The name must be unique within the folder, comply with RFC 1035 and be 1-63 characters long.

description string

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

labels object

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

environment string

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.
monitoring[] object

Description of monitoring systems relevant to the MySQL cluster.

monitoring[].
name
string

Name of the monitoring system.

monitoring[].
description
string

Description of the monitoring system.

monitoring[].
link
string

Link to the monitoring system charts for the MySQL cluster.

config object

Configuration of the MySQL cluster.

config.
version
string

Version of MySQL server software.

config.
resources
object
config.
resources.
resourcePresetId
string

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

config.
resources.
diskSize
string (int64)

Volume of the storage available to a host.

config.
resources.
diskTypeId
string

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

  • network-ssd — network SSD drive,
  • local-ssd — local SSD storage.
config.
backupWindowStart
object

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.

config.
backupWindowStart.
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.

config.
backupWindowStart.
minutes
integer (int32)

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

config.
backupWindowStart.
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.

config.
backupWindowStart.
nanos
integer (int32)

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

config.
access
object
config.
access.
dataLens
boolean (boolean)

Allow access for DataLens

config.
mysqlConfig_5_7
object
config includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0

config.
mysqlConfig_5_7.
effectiveConfig
object

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

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

config.
mysqlConfig_5_7.
effectiveConfig.
innodbBufferPoolSize
integer (int64)

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.

config.
mysqlConfig_5_7.
effectiveConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

config.
mysqlConfig_5_7.
effectiveConfig.
longQueryTime
number (double)

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

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
effectiveConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
effectiveConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
effectiveConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
effectiveConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

config.
mysqlConfig_5_7.
effectiveConfig.
defaultAuthenticationPlugin
string
config.
mysqlConfig_5_7.
userConfig
object

User-defined settings for a MySQL 5.7 cluster.

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

config.
mysqlConfig_5_7.
userConfig.
innodbBufferPoolSize
integer (int64)

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.

config.
mysqlConfig_5_7.
userConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

config.
mysqlConfig_5_7.
userConfig.
longQueryTime
number (double)

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

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
userConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
userConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
userConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
userConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

config.
mysqlConfig_5_7.
userConfig.
defaultAuthenticationPlugin
string
config.
mysqlConfig_5_7.
defaultConfig
object

Default configuration for a MySQL 5.7 cluster.

Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file

config.
mysqlConfig_5_7.
defaultConfig.
innodbBufferPoolSize
integer (int64)

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.

config.
mysqlConfig_5_7.
defaultConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

config.
mysqlConfig_5_7.
defaultConfig.
longQueryTime
number (double)

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

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
defaultConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
defaultConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
defaultConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_5_7.
defaultConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

config.
mysqlConfig_5_7.
defaultConfig.
defaultAuthenticationPlugin
string
config.
mysqlConfig_8_0
object
config includes only one of the fields mysqlConfig_5_7, mysqlConfig_8_0

config.
mysqlConfig_8_0.
effectiveConfig
object

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

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

config.
mysqlConfig_8_0.
effectiveConfig.
innodbBufferPoolSize
integer (int64)

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.

config.
mysqlConfig_8_0.
effectiveConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

config.
mysqlConfig_8_0.
effectiveConfig.
longQueryTime
number (double)

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

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
effectiveConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
effectiveConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
effectiveConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
effectiveConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

config.
mysqlConfig_8_0.
effectiveConfig.
defaultAuthenticationPlugin
string
config.
mysqlConfig_8_0.
userConfig
object

User-defined settings for a MySQL 8.0 cluster.

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

config.
mysqlConfig_8_0.
userConfig.
innodbBufferPoolSize
integer (int64)

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.

config.
mysqlConfig_8_0.
userConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

config.
mysqlConfig_8_0.
userConfig.
longQueryTime
number (double)

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

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
userConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
userConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
userConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
userConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

config.
mysqlConfig_8_0.
userConfig.
defaultAuthenticationPlugin
string
config.
mysqlConfig_8_0.
defaultConfig
object

Default configuration for a MySQL 8.0 cluster.

Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file

config.
mysqlConfig_8_0.
defaultConfig.
innodbBufferPoolSize
integer (int64)

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.

config.
mysqlConfig_8_0.
defaultConfig.
maxConnections
integer (int64)

The maximum permitted number of simultaneous client connections.

For details, see MySQL documentation for the variable.

Acceptable values are 10 to 10000, inclusive.

config.
mysqlConfig_8_0.
defaultConfig.
longQueryTime
number (double)

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

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
defaultConfig.
generalLog
boolean (boolean)

Enable writing of general query log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
defaultConfig.
auditLog
boolean (boolean)

Enable writing of audit log of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
defaultConfig.
sqlMode[]
string

Server SQL mode of MySQL.

For details, see MySQL documentation for the variable.

config.
mysqlConfig_8_0.
defaultConfig.
maxAllowedPacket
integer (int64)

The maximum size in bytes of one packet.

For details, see MySQL documentation for the variable.

Acceptable values are 1024 to 134217728, inclusive.

config.
mysqlConfig_8_0.
defaultConfig.
defaultAuthenticationPlugin
string
networkId string

ID of the network that the cluster belongs to.

health string

Aggregated cluster health.

  • HEALTH_UNKNOWN: State 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 working below capacity ([Host.health] for at least one host in the cluster is not ALIVE).
status string

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 stopped.
  • STARTING: Cluster is starting.

Methods

Method Description
addHosts Creates new hosts for a cluster.
backup Creates a backup for the specified MySQL cluster.
create Creates a MySQL cluster in the specified folder.
delete Deletes the specified MySQL cluster.
deleteHosts Deletes the specified hosts for a cluster.
get Returns the specified MySQL cluster.
list Retrieves the list of MySQL clusters that belong to the specified folder.
listBackups Retrieves the list of available backups for the specified MySQL cluster.
listHosts Retrieves a list of hosts for the specified MySQL cluster.
listLogs Retrieves logs for the specified MySQL cluster.
listOperations Retrieves the list of operations for the specified MySQL cluster.
move Moves the specified MySQL cluster to the specified folder.
restore Creates a new MySQL cluster using the specified backup.
start Starts the specified MySQL cluster.
startFailover Start a manual failover on the specified MySQL cluster.
stop Stops the specified MySQL cluster.
update Modifies the specified MySQL cluster.