Skip to main content

types

Backup​

A MySQL backup. For more information, see the documentation.

id : string​

ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​
sourceClusterId : string​

ID of the MySQL cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

Cluster​

A MySQL cluster. For more information, see the documentation.

Environment​

  • ENVIRONMENT_UNSPECIFIED

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

Health​

  • HEALTH_UNKNOWN

    State of the cluster is unknown ([Host.health][1] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and well ([Host.health][2] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is working below capacity ([Host.health][4] for at least one host in the cluster is not ALIVE).

Status​

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

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 : google.protobuf.Timestamp​
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 : string​

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

environment : Environment​

Deployment environment of the MySQL cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the MySQL cluster.

config : ClusterConfig​

Configuration of the MySQL cluster.

networkId : string​

ID of the network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

ClusterConfig​

version : string​

Version of MySQL server software.

One of mysqlConfig​

Configuration for MySQL servers in the cluster.

  • mysqlConfig_5_7 : config.MysqlConfigSet5_7​

    Configuration of a MySQL 5.7 server.

resources : Resources​

Resources allocated to MySQL hosts.

backupWindowStart : google.type.TimeOfDay​

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

Database​

A MySQL database. For more information, see the documentation.

name : string​

Name of the database.

clusterId : string​

ID of the MySQL cluster that the database belongs to.

DatabaseSpec​

name : string​

Name of the MySQL database.

Host​

Role​

  • ROLE_UNKNOWN

    Role of the host in the cluster is unknown.

  • MASTER

    Host is the master MySQL server in the cluster.

  • REPLICA

    Host is a replica MySQL server in the cluster.

Health​

  • HEALTH_UNKNOWN

    Health of the host is unknown.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable, and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded, and can perform only some of its essential functions.

name : string​

Name of the MySQL host. The host name is assigned by Managed Service for MySQL at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all database hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

ID of the MySQL host. The ID is assigned by Managed Service for MySQL at creation time.

zoneId : string​

ID of the availability zone where the MySQL host resides.

resources : Resources​

Resources allocated to the host.

role : Role​

Role of the host in the cluster.

health : Health​

Status code of the aggregated health of the host.

services : Service​

Services provided by the host.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Flag showing public IP assignment status to this host.

Monitoring​

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the MySQL cluster.

Permission​

Privilege​

  • PRIVILEGE_UNSPECIFIED

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

databaseName : string​

Name of the database that the permission grants access to.

roles : Privilege​

Roles granted to the user within the database.

ResourcePreset​

A preset of resources for hardware configuration of MySQL hosts.

id : string​

ID of the resource preset.

zoneIds : string​

IDs of availability zones where the resource preset is available.

cores : int64​

Number of CPU cores for a MySQL host created with the preset.

memory : int64​

RAM volume for a MySQL host created with the preset, in bytes.

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.

diskSize : int64​

Volume of the storage available to a host.

diskTypeId : string​

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

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

Service​

Type​

  • TYPE_UNSPECIFIED

  • MYSQL_ERROR

    Host provides the MySQL error log.

  • MYSQL_GENERAL

    Host provides the MySQL general query log.

  • MYSQL_SLOW_QUERY

    Host provides the MySQL slow query log.

Health​

  • HEALTH_UNKNOWN

    Health of the server is unknown.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host.

health : Health​

Status code of server availability.

User​

A MySQL user. For more information, see the documentation.

name : string​

Name of the MySQL user.

clusterId : string​

ID of the MySQL cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

UserSpec​

name : string​

Name of the MySQL user.

password : string​

Password of the MySQL user.

permissions : Permission​

Set of permissions to grant to the user.