ClusterService

A set of methods for managing MySQL clusters.

Call	Description
Get	Returns the specified MySQL cluster.
List	Retrieves the list of MySQL clusters that belong to the specified folder.
Create	Creates a MySQL cluster in the specified folder.
Update	Modifies the specified MySQL cluster.
Delete	Deletes the specified MySQL cluster.
Start	Starts the specified MySQL cluster.
Stop	Stops the specified MySQL cluster.
Move	Moves the specified MySQL cluster to the specified folder.
Backup	Creates a backup for the specified MySQL cluster.
Restore	Creates a new MySQL cluster using the specified backup.
StartFailover	Start a manual failover on the specified MySQL cluster.
ListLogs	Retrieves logs for the specified MySQL cluster.
StreamLogs	Same as ListLogs but using server-side streaming.
ListOperations	Retrieves the list of operations for the specified MySQL cluster.
ListBackups	Retrieves the list of available backups for the specified MySQL cluster.
ListHosts	Retrieves a list of hosts for the specified MySQL cluster.
AddHosts	Creates new hosts for a cluster.
DeleteHosts	Deletes the specified hosts for a cluster.

Calls ClusterService

Get

Returns the specified MySQL cluster.
To get the list of available MySQL clusters, make a List request.

rpc Get (GetClusterRequest) returns (Cluster)

GetClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to return. To get the cluster ID use a ClusterService.List request. false The maximum string length in characters is 50.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Monitoring

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

ClusterConfig

Field	Description
version	string Version of MySQL server software.
mysql_config	oneof: mysql_config_5_7 or mysql_config_8_0 Configuration for MySQL servers in the cluster.
mysql_config_5_7	config.MysqlConfigSet5_7 Configuration of a MySQL 5.7 server.
mysql_config_8_0	config.MysqlConfigSet8_0 Configuration of a MySQL 8.0 server.
resources	Resources Resources allocated to MySQL hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

List

Retrieves the list of MySQL clusters that belong to the specified folder.

rpc List (ListClustersRequest) returns (ListClustersResponse)

ListClustersRequest

Field	Description
folder_id	string Required. ID of the folder to list MySQL clusters in. To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request. false The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClustersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
filter	string The field name. Currently you can only use filtering with the Cluster.name field. An operator. Can be either = or != for single values, IN or NOT IN for lists of values. The value. Мust be 1-63 characters long and match the regular expression ^[a-zA-Z0-9_-]+$. The maximum string length in characters is 1000.

ListClustersResponse

Field	Description
clusters[]	Cluster List of MySQL clusters.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Monitoring

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

ClusterConfig

Field	Description
version	string Version of MySQL server software.
mysql_config	oneof: mysql_config_5_7 or mysql_config_8_0 Configuration for MySQL servers in the cluster.
mysql_config_5_7	config.MysqlConfigSet5_7 Configuration of a MySQL 5.7 server.
mysql_config_8_0	config.MysqlConfigSet8_0 Configuration of a MySQL 8.0 server.
resources	Resources Resources allocated to MySQL hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

Create

Creates a MySQL cluster in the specified folder.

rpc Create (CreateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateClusterMetadata

    Operation.response:Cluster

CreateClusterRequest

Field	Description
folder_id	string Required. ID of the folder to create the MySQL cluster in. false The maximum string length in characters is 50.
name	string Required. Name of the MySQL cluster. The name must be unique within the folder. false The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the MySQL cluster. The maximum string length in characters is 256.
labels	map<string,string> 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 maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
environment	Cluster.Environment Deployment environment of the MySQL cluster.
config_spec	ConfigSpec Configuration and resources for hosts that should be created for the MySQL cluster.
database_specs[]	DatabaseSpec Descriptions of databases to be created in the MySQL cluster.
user_specs[]	UserSpec Descriptions of database users to be created in the MySQL cluster.
host_specs[]	HostSpec Individual configurations for hosts that should be created for the MySQL cluster.
network_id	string ID of the network to create the cluster in. The maximum string length in characters is 50.

ConfigSpec

Field	Description
version	string 5.7 8.0
mysql_config	oneof: mysql_config_5_7 or mysql_config_8_0 Configuration of a MySQL cluster.
mysql_config_5_7	config.MysqlConfig5_7 Configuration for a MySQL 5.7 cluster.
mysql_config_8_0	config.MysqlConfig8_0 Configuration for a MySQL 8.0 cluster.
resources	Resources Resources allocated to MySQL hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

DatabaseSpec

Field	Description
name	string Required. Name of the MySQL database. false The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

UserSpec

Field	Description
name	string Required. Name of the MySQL user. false The maximum string length in characters is 32. Value must match the regular expression [a-zA-Z0-9_]*.
password	string Required. Password of the MySQL user. false The string length in characters must be 8-128.
permissions[]	Permission Set of permissions to grant to the user.
global_permissions[]	enum GlobalPermission Set of global permissions to grant to the user. 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.
connection_limits	ConnectionLimits Set of user connection limits.
authentication_plugin	enum AuthPlugin 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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.
roles[]	enum Privilege Roles granted to the user within the database. The minimum number of elements is 1. 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.

ConnectionLimits

Field	Description
max_questions_per_hour	google.protobuf.Int64Value The maximum permitted number of user questions per hour. The minimum value is 0.
max_updates_per_hour	google.protobuf.Int64Value The maximum permitted number of user updates per hour. The minimum value is 0.
max_connections_per_hour	google.protobuf.Int64Value The maximum permitted number of simultaneous client connections per hour. The minimum value is 0.
max_user_connections	google.protobuf.Int64Value The maximum number of simultaneous connections permitted to any given MySQL user account. The minimum value is 0.

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string 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.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<CreateClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

CreateClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster that is being created.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Update

Modifies the specified MySQL cluster.

rpc Update (UpdateClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateClusterMetadata

    Operation.response:Cluster

UpdateClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to update. To get the MySQL cluster ID, use a ClusterService.List request. false The maximum string length in characters is 50.
update_mask	google.protobuf.FieldMask Field mask that specifies which fields of the MySQL cluster should be updated.
description	string New description of the MySQL cluster. The maximum string length in characters is 256.
labels	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource. For example, "project": "mvp" or "source": "dictionary". The new set of labels will completely replace the old ones. To add a label, request the current set with the ClusterService.Get method, then send an ClusterService.Update request with the new label added to the set. No more than 64 per resource. The maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
config_spec	ConfigSpec New configuration and resources for hosts in the cluster.
name	string New name for the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

ConfigSpec

Field	Description
version	string 5.7 8.0
mysql_config	oneof: mysql_config_5_7 or mysql_config_8_0 Configuration of a MySQL cluster.
mysql_config_5_7	config.MysqlConfig5_7 Configuration for a MySQL 5.7 cluster.
mysql_config_8_0	config.MysqlConfig8_0 Configuration for a MySQL 8.0 cluster.
resources	Resources Resources allocated to MySQL hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<UpdateClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

UpdateClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster that is being modified.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Delete

Deletes the specified MySQL cluster.

rpc Delete (DeleteClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to delete. To get the MySQL cluster ID, use a ClusterService.List request. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<DeleteClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster that is being deleted.

Start

Starts the specified MySQL cluster.

rpc Start (StartClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterMetadata

    Operation.response:Cluster

StartClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to start. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<StartClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster being started.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Stop

Stops the specified MySQL cluster.

rpc Stop (StopClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StopClusterMetadata

    Operation.response:Cluster

StopClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to stop. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<StopClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StopClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster being stopped.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Move

Moves the specified MySQL cluster to the specified folder.

rpc Move (MoveClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:MoveClusterMetadata

    Operation.response:Cluster

MoveClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to move. false The maximum string length in characters is 50.
destination_folder_id	string Required. ID of the destination folder. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<MoveClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

MoveClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster being moved.
source_folder_id	string ID of the source folder.
destination_folder_id	string ID of the destnation folder.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Backup

Creates a backup for the specified MySQL cluster.

rpc Backup (BackupClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:BackupClusterMetadata

    Operation.response:Cluster

BackupClusterRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to back up. To get the MySQL cluster ID, use a ClusterService.List request. false The maximum string length in characters is 50.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

BackupClusterMetadata

Field	Description
cluster_id	string ID of the MySQL cluster that is being backed up.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

Restore

Creates a new MySQL cluster using the specified backup.

rpc Restore (RestoreClusterRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RestoreClusterMetadata

    Operation.response:Cluster

RestoreClusterRequest

Field	Description
backup_id	string Required. ID of the backup to create a cluster from. To get the backup ID, use a ClusterService.ListBackups request. false
time	google.protobuf.Timestamp Required. Timestamp of the moment to which the MySQL cluster should be restored. false
name	string Required. Name of the new MySQL cluster. The name must be unique within the folder. false Value must match the regular expression [a-zA-Z0-9_-]*.
description	string Description of the new MySQL cluster. The maximum string length in characters is 256.
labels	map<string,string> 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 maximum string length in characters for each value is 63. Each value must match the regular expression [-_0-9a-z]*. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_0-9a-z]*.
environment	Cluster.Environment Deployment environment of the new MySQL cluster.
config_spec	ConfigSpec Configuration for the MySQL cluster to be created.
host_specs[]	HostSpec Configurations for MySQL hosts that should be added to the cluster that is being created from the backup.
network_id	string ID of the network to create the MySQL cluster in. The maximum string length in characters is 50.
folder_id	string ID of the folder to create the MySQL cluster in. The maximum string length in characters is 50.

ConfigSpec

Field	Description
version	string 5.7 8.0
mysql_config	oneof: mysql_config_5_7 or mysql_config_8_0 Configuration of a MySQL cluster.
mysql_config_5_7	config.MysqlConfig5_7 Configuration for a MySQL 5.7 cluster.
mysql_config_8_0	config.MysqlConfig8_0 Configuration for a MySQL 8.0 cluster.
resources	Resources Resources allocated to MySQL hosts.
backup_window_start	google.type.TimeOfDay Time to start the daily backup, in the UTC timezone.
access	Access Access policy to DB

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-ssd — network SSD drive, local-ssd — local SSD storage.

Access

Field	Description
data_lens	bool Allow access for DataLens

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string 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.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<RestoreClusterMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

RestoreClusterMetadata

Field	Description
cluster_id	string ID of the new MySQL cluster that is being created from a backup.
backup_id	string ID of the backup that is being used for creating a cluster.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

StartFailover

Start a manual failover on the specified MySQL cluster.

rpc StartFailover (StartClusterFailoverRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:StartClusterFailoverMetadata

    Operation.response:Cluster

StartClusterFailoverRequest

Field	Description
cluster_id	string Required. ID of MySQL cluster. false The maximum string length in characters is 50.
host_name	string New master host. Switch to the most up-to-date replica if not provided. The maximum string length in characters is 253.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<StartClusterFailoverMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Cluster> if operation finished successfully.

StartClusterFailoverMetadata

Field	Description
cluster_id	string ID of the MySQL cluster being failovered.

Cluster

Field	Description
id	string ID of the MySQL cluster. This ID is assigned by Managed Service for MySQL at creation time.
folder_id	string ID of the folder that the MySQL cluster belongs to.
created_at	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	map<string,string> Custom labels for the MySQL cluster as key:value pairs. Maximum 64 per resource.
environment	enum Environment 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[]	Monitoring Description of monitoring systems relevant to the MySQL cluster.
config	ClusterConfig Configuration of the MySQL cluster.
network_id	string ID of the network that the cluster belongs to.
health	enum Health 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	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 stopped. STARTING: Cluster is starting.

ListLogs

Retrieves logs for the specified MySQL cluster.

rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)

ListClusterLogsRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to request logs for. To get the MySQL cluster ID use a ClusterService.List request. false The maximum string length in characters is 50.
column_filter[]	string Columns from the logs table to request. If no columns are specified, entire log records are returned.
service_type	enum ServiceType Type of the service to request logs about. MYSQL_ERROR: MySQL error log. MYSQL_GENERAL: MySQL general query log. MYSQL_SLOW_QUERY: MySQL slow query log. MYSQL_AUDIT: MySQL audit log.
from_time	google.protobuf.Timestamp Start timestamp for the logs request.
to_time	google.protobuf.Timestamp End timestamp for the logs request.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.
always_next_page_token	bool Always return next_page_token, even if current page is empty.

ListClusterLogsResponse

Field	Description
logs[]	LogRecord Requested log records.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results. This value is interchangeable with next_record_token from StreamLogs method.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp in RFC3339 text format.
message	map<string,string> Contents of the log record.

StreamLogs

Same as ListLogs but using server-side streaming. Also allows for 'tail -f' semantics.

rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

StreamClusterLogsRequest

Field	Description
cluster_id	string Required. Required. ID of the MySQL cluster. false The maximum string length in characters is 50.
column_filter[]	string Columns from logs table to get in the response.
service_type	enum ServiceType MYSQL_ERROR: MySQL error log. MYSQL_GENERAL: MySQL general query log. MYSQL_SLOW_QUERY: MySQL slow query log. MYSQL_AUDIT: MySQL audit log.
from_time	google.protobuf.Timestamp Start timestamp for the logs request.
to_time	google.protobuf.Timestamp End timestamp for the logs request. If this field is not set, all existing logs will be sent and then the new ones as they appear. In essence it has 'tail -f' semantics.
record_token	string Record token. Set record_token to the next_record_token returned by a previous StreamLogs request to start streaming from next log record. The maximum string length in characters is 100.

StreamLogRecord

Field	Description
record	LogRecord One of the requested log records.
next_record_token	string This token allows you to continue streaming logs starting from the exact same record. To continue streaming, specify value of next_record_token as value for record_token parameter in the next StreamLogs request. This value is interchangeable with next_page_token from ListLogs method.

LogRecord

Field	Description
timestamp	google.protobuf.Timestamp Log record timestamp in RFC3339 text format.
message	map<string,string> Contents of the log record.

ListOperations

Retrieves the list of operations for the specified MySQL cluster.

rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)

ListClusterOperationsRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to list operations for. false The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterOperationsResponse

Field	Description
operations[]	operation.Operation List of operations for the specified MySQL cluster.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any 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.

ListBackups

Retrieves the list of available backups for the specified MySQL cluster.

rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)

ListClusterBackupsRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster. To get the MySQL cluster ID use a ClusterService.List request. false The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterBackupsResponse

Field	Description
backups[]	Backup List of MySQL backups.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Backup

Field	Description
id	string Required. ID of the backup. false
folder_id	string ID of the folder that the backup belongs to.
created_at	google.protobuf.Timestamp
source_cluster_id	string ID of the MySQL cluster that the backup was created for.
started_at	google.protobuf.Timestamp Time when the backup operation was started.

ListHosts

Retrieves a list of hosts for the specified MySQL cluster.

rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)

ListClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster. To get the MySQL cluster ID use a ClusterService.List request. false The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListClusterHostsResponse

Field	Description
hosts[]	Host List of MySQL hosts.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token query parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

Host

Field	Description
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 existing database hosts in Yandex.Cloud, as it defines the FQDN of the host.
cluster_id	string ID of the MySQL host. The ID is assigned by Managed Service for MySQL at creation time.
zone_id	string ID of the availability zone where the MySQL host resides.
resources	Resources Resources allocated to the host.
role	enum Role Role of the host in the cluster. 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	enum Health Status code of the aggregated health of the host. 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.
services[]	Service Services provided by the host.
subnet_id	string ID of the subnet that the host belongs to.
assign_public_ip	bool Flag showing public IP assignment status to this host.

Resources

Field	Description
resource_preset_id	string ID of the preset for computational resources available to a host (CPU, memory etc.). All available presets are listed in the documentation.
disk_size	int64 Volume of the storage available to a host.
disk_type_id	string network-ssd — network SSD drive, local-ssd — local SSD storage.

Service

Field	Description
type	enum Type Type of the service provided by the host. MYSQL: The host is a MySQL server.
health	enum Health Status code of server availability. HEALTH_UNKNOWN: Health of the server is unknown. ALIVE: The server is working normally. DEAD: The server is dead or unresponsive.

AddHosts

Creates new hosts for a cluster.

rpc AddHosts (AddClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:AddClusterHostsMetadata

    Operation.response:google.protobuf.Empty

AddClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to add hosts to. To get the MySQL cluster ID, use a ClusterService.List request. false The maximum string length in characters is 50.
host_specs[]	HostSpec Configurations for MySQL hosts that should be added to the cluster. The number of elements must be greater than 0.

HostSpec

Field	Description
zone_id	string ID of the availability zone where the host resides. To get a list of available zones, use the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50.
subnet_id	string 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.network_id. The maximum string length in characters is 50.
assign_public_ip	bool false — don't assign a public IP to the host. true — the host should have a public IP address.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<AddClusterHostsMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

AddClusterHostsMetadata

Field	Description
cluster_id	string ID of the MySQL cluster to which the hosts are being added.
host_names[]	string Names of hosts that are being added to the cluster.

DeleteHosts

Deletes the specified hosts for a cluster.

rpc DeleteHosts (DeleteClusterHostsRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteClusterHostsMetadata

    Operation.response:google.protobuf.Empty

DeleteClusterHostsRequest

Field	Description
cluster_id	string Required. ID of the MySQL cluster to remove hosts from. To get the MySQL cluster ID, use a ClusterService.List request. false The maximum string length in characters is 50.
host_names[]	string Names of hosts to delete. The number of elements must be greater than 0. The maximum string length in characters for each value is 253.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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	google.protobuf.Any<DeleteClusterHostsMetadata> 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.
result	oneof: error or 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.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteClusterHostsMetadata

Field	Description
cluster_id	string ID of the MySQL cluster to remove hosts from.
host_names[]	string Names of hosts that are being deleted.