Skip to main content

types

Access​

dataLens : bool​

Allows access from DataLens.

See the documentation for details.

webSql : bool​

Allows SQL queries to the cluster databases from management console.

See the documentation for details.

dataTransfer : bool​

Allow access for DataTransfer.

AnytimeMaintenanceWindow​

Backup​

An object that represents MySQL backup.

See the documentation for details.

BackupCreationType​

  • BACKUP_CREATION_TYPE_UNSPECIFIED

  • AUTOMATED

    Backup created by automated daily schedule

  • MANUAL

    Backup created by user request

BackupStatus​

  • BACKUP_STATUS_UNSPECIFIED

  • DONE

    Backup is done

  • CREATING

    Backup is creating

id : string​

ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp (the time when the backup operation was completed).

sourceClusterId : string​

ID of the cluster that the backup was created for.

startedAt : google.protobuf.Timestamp​

Start timestamp (the time when the backup operation was started).

size : int64​

Size of backup, in bytes

type : BackupCreationType​

How this backup was created (manual/automatic/etc...)

status : BackupStatus​

Status of backup

Cluster​

An object that represents MySQL cluster.

See the documentation for details.

Environment​

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

Health​

  • HEALTH_UNKNOWN

    Health 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 degraded ([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 is stopped.

  • STARTING

    Cluster is starting.

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

Creation timestamp of the cluster.

name : string​

Name of the cluster.

description : string​

Description of the cluster.

labels : string​

Custom labels for the cluster as key:value pairs.

environment : Environment​

Deployment environment of the MySQL cluster.

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 : Health​

Aggregated health of the cluster.

status : Status​

Current state of the cluster.

maintenanceWindow : MaintenanceWindow​

Maintenance window settings for the cluster.

plannedOperation : MaintenanceOperation​

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

securityGroupIds : string​

Effective list of security group IDs applied to the cluster.

deletionProtection : bool​

This option prevents unintended deletion of the cluster.

hostGroupIds : string​

Host groups hosting VMs of the cluster.

ClusterConfig​

version : string​

Version of MySQL used in the cluster.

One of mysqlConfig​

Cluster-wide MySQL configuration.

  • mysqlConfig_5_7 : config.MysqlConfigSet5_7​

    Configuration of a MySQL 5.7 server.

  • mysqlConfig_8_0 : config.MysqlConfigSet8_0​

    Configuration of a MySQL 8.0 server.

resources : Resources​

Resource preset for the cluster hosts.

backupWindowStart : google.type.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 : google.protobuf.Int64Value​

Retention policy of automated backups.

ConnectionLimits​

maxQuestionsPerHour : google.protobuf.Int64Value​

The maximum permitted number of user questions per hour.

maxUpdatesPerHour : google.protobuf.Int64Value​

The maximum permitted number of user updates per hour.

maxConnectionsPerHour : google.protobuf.Int64Value​

The maximum permitted number of simultaneous client connections per hour.

maxUserConnections : google.protobuf.Int64Value​

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

Database​

An object that represents MySQL database.

See the documentation for details.

name : string​

Name of the database.

clusterId : string​

ID of the cluster that the database belongs to.

DatabaseSpec​

name : string​

Name of the database.

Host​

Role​

  • ROLE_UNKNOWN

    Role of the host is unknown. Default value.

  • MASTER

    Host is the master.

  • REPLICA

    Host is a replica.

Health​

  • HEALTH_UNKNOWN

    Health of the host is unknown. Default value.

  • ALIVE

    Host is performing all its functions normally.

  • DEAD

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

  • DEGRADED

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

  • READONLY

    Host is alive, but in read-only mode.

name : string​

Name of the host.

This name is assigned by the platform at the time of creation. The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

ID of the cluster the host belongs to.

zoneId : string​

ID of the availability zone where the host resides.

resources : Resources​

Resources allocated to the host.

role : Role​

Role of the host in the cluster. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

services : Service​

List of services provided by the host.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Flag that shows if public IP address is assigned to the host so that the host can be accessed from the internet.

replicationSource : string​

Name of the host to be used as the replication source for cascading replication.

backupPriority : int64​

Host backup priority.

priority : int64​

Host master promotion priority.

MaintenanceOperation​

A planned maintenance operation.

info : string​

Information about this maintenance operation.

delayedUntil : google.protobuf.Timestamp​

Time until which this maintenance operation is delayed.

MaintenanceWindow​

Configuration of a maintenance window in a MySQL cluster.

One of policy​

The maintenance policy in effect.

  • anytime : AnytimeMaintenanceWindow​

    Maintenance operation can be scheduled anytime.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    Maintenance operation can be scheduled on a weekly basis.

Monitoring​

Cluster-related monitoring system data.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the cluster.

PerformanceDiagnostics​

enabled : bool​

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

sessionsSamplingInterval : int64​

Interval (in seconds) for my_session sampling.

statementsSamplingInterval : int64​

Interval (in seconds) for my_statements sampling.

Permission​

Privilege​

  • PRIVILEGE_UNSPECIFIED

  • ALL_PRIVILEGES

    All privileges that can be made available to the user.

  • ALTER

    Altering tables.

  • ALTER_ROUTINE

    Altering stored routines 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 MySQL documentation for details.

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

databaseName : string​

Name of the database that the permission grants access to.

roles : Privilege​

Roles granted to the user within the database.

See the documentation for details.

ResourcePreset​

An object that represents MySQL resource preset. A resource preset defines hardware configuration for cluster hosts.

See the documentation for details.

id : string​

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

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​

Cluster resource preset.

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

Service​

Type​

  • TYPE_UNSPECIFIED

    Service type of the host is unspecified. Default value.

  • MYSQL

    The host is a MySQL server.

Health​

  • HEALTH_UNKNOWN

    Health of the service is unknown. Default value.

  • ALIVE

    The service is working normally.

  • DEAD

    The service is dead or unresponsive.

  • READONLY

    The service is in read-only mode.

type : Type​

Type of the service provided by the host. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the service. If the field has default value, it is not returned in the response.

User​

An object that represents MySQL user.

See the documentation for details.

name : string​

Name of the user.

clusterId : string​

ID of the cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

globalPermissions : GlobalPermission​

Set of global permissions to grant to the user.

connectionLimits : ConnectionLimits​

Set of user connection limits.

authenticationPlugin : AuthPlugin​

User authentication plugin.

UserSpec​

name : string​

Name of the user.

password : string​

Password of the user.

permissions : Permission​

Set of permissions granted to the user to access specific databases. One permission per database.

When a permission for a database is set, the user will have access to the database.

globalPermissions : GlobalPermission​

Set of global permissions to grant to the user.

connectionLimits : ConnectionLimits​

Set of user connection limits.

authenticationPlugin : AuthPlugin​

User authentication plugin.

WeeklyMaintenanceWindow​

Weelky maintenance window settings.

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​

Day of the week (in DDD format).

hour : int64​

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