Managed Service for MySQL API, gRPC: ClusterService
A set of methods for managing MySQL clusters.
Call | Description |
---|---|
Get | Retrieves information about a cluster. |
List | Retrieves the list of clusters in a folder. |
Create | Creates a cluster in a folder. |
Update | Updates a cluster. |
Delete | Deletes a cluster. |
Start | Starts a cluster. |
Stop | Stops a cluster. |
Move | Moves a cluster to a folder. |
Backup | Creates a backup for a cluster. |
Restore | Restores a backup to a new cluster. |
RescheduleMaintenance | Reschedules planned maintenance operation. |
StartFailover | Starts a manual failover for a cluster. |
ListLogs | Retrieves logs for a cluster. |
StreamLogs | Retrieves a log stream for a cluster. |
ListOperations | Retrieves a list of operations for a cluster. |
ListBackups | Retrieves a list of backups for a cluster. |
ListHosts | Retrieves a list of hosts for a cluster. |
AddHosts | Adds new hosts in a cluster. |
UpdateHosts | Updates the specified hosts. |
DeleteHosts | Deletes the specified hosts for a cluster. |
Calls ClusterService
Get
Retrieves information about a cluster.
rpc Get (GetClusterRequest) returns (Cluster)
GetClusterRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to return information about. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
List
Retrieves the list of clusters in a folder.
rpc List (ListClustersRequest) returns (ListClustersResponse)
ListClustersRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to list clusters in. To get this ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. 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 API returns a ListClustersResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.List requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListClustersResponse.next_page_token returned by the previous ClusterService.List request. The maximum string length in characters is 100. |
filter | string A filter expression that selects clusters listed in the response. The expression must specify:
|
ListClustersResponse
Field | Description |
---|---|
clusters[] | Cluster List of clusters. |
next_page_token | string The token that can be used to get the next page of results. If the number of results is larger than ListClustersRequest.page_size, use the next_page_token as the value for the ListClustersRequest.page_token in the subsequent ClusterService.List request to iterate through multiple pages of results. Each of the subsequent ClusterService.List requests should use the next_page_token value returned by the previous request to continue paging through the results. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Create
Creates a cluster in a 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 cluster in. To get this ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. The maximum string length in characters is 50. |
name | string Required. Name of the cluster. The name must be unique within the folder. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. 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 cluster. |
config_spec | ConfigSpec Configuration of the cluster. |
database_specs[] | DatabaseSpec Configuration of databases in the cluster. |
user_specs[] | UserSpec Configuration of database users in the cluster. |
host_specs[] | HostSpec Configuration of hosts in the cluster. |
network_id | string ID of the network to create the cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string List of security group IDs to apply to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
ConfigSpec
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. Possible values: 5.7 , 8.0 . |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. If the specific services need to access the cluster, then set the necessary values in this policy. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
DatabaseSpec
Field | Description |
---|---|
name | string Required. Name of the database. 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 user. The maximum string length in characters is 32. Value must match the regular expression [a-zA-Z0-9_-]* . |
password | string Required. Password of the user. The string length in characters must be 8-128. |
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. |
global_permissions[] | enum GlobalPermission Set of global permissions to grant to the user.
|
connection_limits | ConnectionLimits Set of user connection limits. |
authentication_plugin | enum AuthPlugin User authentication plugin.
|
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. See the documentation for details. The minimum number of elements is 1.
|
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, make the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet to assign to the host. This subnet should be a part of the cluster network (the network ID is specified in the ClusterService.CreateClusterRequest.network_id). The maximum string length in characters is 50. |
assign_public_ip | bool Option that enables public IP address for the host so that the host can be accessed from the internet. After a host has been created, this setting cannot be changed. To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate assign_public_ip value set. Possible values:
|
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). |
backup_priority | int64 Host backup priority Acceptable values are 0 to 100, inclusive. |
priority | int64 Host master promotion priority Acceptable values are 0 to 100, inclusive. |
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 if operation finished successfully. |
CreateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being created. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Update
Updates a 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 cluster to update. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
update_mask | google.protobuf.FieldMask Field mask that specifies which settings of the cluster should be updated. |
description | string New description of the cluster. The maximum string length in characters is 256. |
labels | map<string,string> New set of custom labels for the cluster as key:value pairs. This set will completely replace the current one. To add a label, request the current label set with the ClusterService.Get request, then send an ClusterService.Update request with the new label added to the current 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 of the cluster. |
name | string New name of the cluster. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
maintenance_window | MaintenanceWindow Configuration of a maintenance window in an MySQL cluster. |
security_group_ids[] | string New list of security group IDs to apply to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
ConfigSpec
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. Possible values: 5.7 , 8.0 . |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. If the specific services need to access the cluster, then set the necessary values in this policy. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
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 if operation finished successfully. |
UpdateClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being updated. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Delete
Deletes a 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 cluster to delete. To get this ID, make a ClusterService.List request. 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 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 if operation finished successfully. |
DeleteClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being deleted. |
Start
Starts a 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 cluster to start. To get this ID, make a ClusterService.List request. 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 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 if operation finished successfully. |
StartClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being started. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Stop
Stops a 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 cluster to stop. To get this ID, make a ClusterService.List request. 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 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 if operation finished successfully. |
StopClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being stopped. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Move
Moves a cluster to a 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 cluster to move. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
destination_folder_id | string Required. ID of the destination folder. To get this ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request. 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 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 if operation finished successfully. |
MoveClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being moved. |
source_folder_id | string ID of the source folder. |
destination_folder_id | string ID of the destination folder. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Backup
Creates a backup for a cluster.
To get information about a backup, make a BackupService.Get request.
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 cluster to back up. To get this ID, make a ClusterService.List request. 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 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 if operation finished successfully. |
BackupClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being backed up. |
backup_id | string ID of the MySQL backup that is created. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
Restore
Restores a backup to a new cluster.
See the documentation for details.
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 restore from. To get this ID, make a BackupService.List request (lists all backups in a folder) or a ClusterService.ListBackups request (lists all backups for an existing cluster). |
time | google.protobuf.Timestamp Required. Timestamp of the moment to which the MySQL cluster should be restored. |
name | string Required. Name of the new MySQL cluster the backup will be restored to. The name must be unique within the folder. Value must match the regular expression [a-zA-Z0-9_-]* . |
description | string Description of the new cluster. The maximum string length in characters is 256. |
labels | map<string,string> Custom labels for the new cluster as key:value pairs. 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 for the new cluster. |
config_spec | ConfigSpec Configuration of the new cluster. |
host_specs[] | HostSpec Configuration of hosts in the new cluster. |
network_id | string ID of the network to create the new cluster in. The maximum string length in characters is 50. |
folder_id | string ID of the folder to create the new cluster in. The maximum string length in characters is 50. |
security_group_ids[] | string List of security group IDs to apply to the new cluster. |
deletion_protection | bool Deletion Protection inhibits deletion of the cluster |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
ConfigSpec
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. Possible values: 5.7 , 8.0 . |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. If the specific services need to access the cluster, then set the necessary values in this policy. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
HostSpec
Field | Description |
---|---|
zone_id | string ID of the availability zone where the host resides. To get a list of available zones, make the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet to assign to the host. This subnet should be a part of the cluster network (the network ID is specified in the ClusterService.CreateClusterRequest.network_id). The maximum string length in characters is 50. |
assign_public_ip | bool Option that enables public IP address for the host so that the host can be accessed from the internet. After a host has been created, this setting cannot be changed. To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate assign_public_ip value set. Possible values:
|
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). |
backup_priority | int64 Host backup priority Acceptable values are 0 to 100, inclusive. |
priority | int64 Host master promotion priority Acceptable values are 0 to 100, inclusive. |
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 if operation finished successfully. |
RestoreClusterMetadata
Field | Description |
---|---|
cluster_id | string ID of the new 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 cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
RescheduleMaintenance
Reschedules planned maintenance operation.
rpc RescheduleMaintenance (RescheduleMaintenanceRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:RescheduleMaintenanceMetadata
Operation.response:Cluster
RescheduleMaintenanceRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to reschedule the maintenance operation for. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
reschedule_type | enum RescheduleType Required. The type of reschedule request.
|
delayed_until | google.protobuf.Timestamp The time until which this maintenance operation should be delayed. The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks. The value can also point to the past moment of time if IMMEDIATE reschedule type is chosen. |
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 if operation finished successfully. |
RescheduleMaintenanceMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster the maintenance operation is being rescheduled for. |
delayed_until | google.protobuf.Timestamp The time until which this maintenance operation is to be delayed. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
StartFailover
Starts a manual failover for a 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 the cluster to start failover for. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
host_name | string Host name to switch master role to. If not provided, then the master role is switched to the most up-to-date replica host. To get this name, make a ClusterService.ListHosts request. 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 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 if operation finished successfully. |
StartClusterFailoverMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster that is being failovered. |
Cluster
Field | Description |
---|---|
id | string ID of the cluster. This ID is assigned by the platform at the time of creation. |
folder_id | string ID of the folder that the cluster belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp of the cluster. |
name | string Name of the cluster. |
description | string Description of the cluster. |
labels | map<string,string> Custom labels for the cluster as key:value pairs. |
environment | enum Environment Deployment environment of the cluster.
|
monitoring[] | Monitoring Monitoring systems data that is relevant to the cluster. |
config | ClusterConfig Configuration of the cluster. |
network_id | string ID of the network that the cluster belongs to. |
health | enum Health Aggregated health of the cluster.
|
status | enum Status Current state of the cluster.
|
maintenance_window | MaintenanceWindow Maintenance window settings for the cluster. |
planned_operation | MaintenanceOperation Planned maintenance operation to be started for the cluster within the nearest maintenance_window . |
security_group_ids[] | string Effective list of security group IDs applied to the cluster. |
deletion_protection | bool This option prevents unintended deletion of the cluster. |
host_group_ids[] | string Host groups hosting VMs of the cluster. |
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 cluster. |
ClusterConfig
Field | Description |
---|---|
version | string Version of MySQL used in the cluster. |
mysql_config | oneof: mysql_config_5_7 or mysql_config_8_0 Cluster-wide MySQL configuration. |
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 Resource preset for the cluster hosts. |
backup_window_start | google.type.TimeOfDay Time to start the daily backup, in the UTC timezone. |
access | Access Access policy for external services. |
performance_diagnostics | PerformanceDiagnostics Configuration of the performance diagnostics service. |
backup_retain_period_days | google.protobuf.Int64Value Retention policy of automated backups. Acceptable values are 7 to 60, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Access
Field | Description |
---|---|
data_lens | bool Allows access from DataLens. See the documentation for details. |
web_sql | bool Allows SQL queries to the cluster databases from management console. See the documentation for details. |
data_transfer | bool Allow access for DataTransfer. |
PerformanceDiagnostics
Field | Description |
---|---|
enabled | bool Flag that shows if performance statistics gathering is enabled for the cluster. |
sessions_sampling_interval | int64 Interval (in seconds) for my_session sampling. Acceptable values are 1 to 86400, inclusive. |
statements_sampling_interval | int64 Interval (in seconds) for my_statements sampling. Acceptable values are 1 to 86400, inclusive. |
MaintenanceWindow
Field | Description |
---|---|
policy | oneof: anytime or weekly_maintenance_window The maintenance policy in effect. |
anytime | AnytimeMaintenanceWindow Maintenance operation can be scheduled anytime. |
weekly_maintenance_window | WeeklyMaintenanceWindow Maintenance operation can be scheduled on a weekly basis. |
AnytimeMaintenanceWindow
Empty.
WeeklyMaintenanceWindow
Field | Description |
---|---|
day | enum WeekDay Day of the week (in DDD format). |
hour | int64 Hour of the day in UTC (in HH format). Acceptable values are 1 to 24, inclusive. |
MaintenanceOperation
Field | Description |
---|---|
info | string Information about this maintenance operation. The maximum string length in characters is 256. |
delayed_until | google.protobuf.Timestamp Time until which this maintenance operation is delayed. |
ListLogs
Retrieves logs for a cluster.
Alternatively, logs can be streamed using StreamLogs.
rpc ListLogs (ListClusterLogsRequest) returns (ListClusterLogsResponse)
ListClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to request logs for. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from the logs table to request. If no columns are specified, complete log records are returned. |
service_type | enum ServiceType The log type.
|
from_time | google.protobuf.Timestamp Start timestamp for the logs request. The logs in the response will be within from_time to to_time range. |
to_time | google.protobuf.Timestamp End timestamp for the logs request. The logs in the response will be within from_time to to_time range. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the API returns a ListClusterLogsResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.ListLogs requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListClusterLogsResponse.next_page_token returned by the previous ClusterService.ListLogs request. The maximum string length in characters is 100. |
always_next_page_token | bool Option that controls the behavior of result pagination. If it is set to true , then ListClusterLogsResponse.next_page_token will always be returned, even if the current page is empty. |
ListClusterLogsResponse
Field | Description |
---|---|
logs[] | LogRecord Requested log records. |
next_page_token | string The token that can be used to get the next page of results. If the number of results is larger than ListClusterLogsRequest.page_size, use the next_page_token as the value for the ListClusterLogsRequest.page_token in the subsequent ClusterService.ListLogs request to iterate through multiple pages of results. Each of the subsequent ClusterService.ListLogs requests should use the next_page_token value returned by the previous request to continue paging through the results. This value is interchangeable with StreamLogRecord.next_record_token from ClusterService.StreamLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Timestamp of the log record. |
message | map<string,string> Contents of the log record. |
StreamLogs
Retrieves a log stream for a cluster.
This method is similar to ListLogs, but uses server-side streaming, which allows for the tail -f
command semantics.
rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)
StreamClusterLogsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to stream logs for. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
column_filter[] | string Columns from the logs table to request. If no columns are specified, complete log records are returned. |
service_type | enum ServiceType The log type.
|
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 log records beginning from from_time will be returned first, and then the new records will be returned as they appear. In essence it has tail -f command semantics. |
record_token | string Record token that can be used to control logs streaming. Set record_token to the StreamLogRecord.next_record_token, returned by the previous ClusterService.StreamLogs request to start streaming from the next log record. The maximum string length in characters is 100. |
filter | string A filter expression that selects clusters logs listed in the response. The expression must specify:
message.hostname='node1.db.cloud.yandex.net' The maximum string length in characters is 1000. |
StreamLogRecord
Field | Description |
---|---|
record | LogRecord One of the requested log records. |
next_record_token | string The token that can be used to continue streaming logs starting from the exact same record. To continue streaming, specify value of next_record_token as the StreamClusterLogsRequest.record_token value in the next ClusterService.StreamLogs request. This value is interchangeable with ListClusterLogsResponse.next_page_token from ClusterService.ListLogs method. |
LogRecord
Field | Description |
---|---|
timestamp | google.protobuf.Timestamp Timestamp of the log record. |
message | map<string,string> Contents of the log record. |
ListOperations
Retrieves a list of operations for a cluster.
rpc ListOperations (ListClusterOperationsRequest) returns (ListClusterOperationsResponse)
ListClusterOperationsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to list operations for. To get this ID, make a ClusterService.List request. 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 API returns a ListClusterOperationsResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.ListOperations requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListClusterOperationsResponse.next_page_token returned by the previous ClusterService.ListOperations request. The maximum string length in characters is 100. |
ListClusterOperationsResponse
Field | Description |
---|---|
operations[] | operation.Operation List of operations in the cluster. |
next_page_token | string The token that can be used to get the next page of results. If the number of results is larger than ListClusterOperationsRequest.page_size, use the next_page_token as the value for the ListClusterOperationsRequest.page_token in the subsequent ClusterService.ListOperations request to iterate through multiple pages of results. Each of the subsequent ClusterService.ListOperations requests should use the next_page_token value returned by the previous request 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 |
ListBackups
Retrieves a list of backups for a cluster.
To list all backups in a folder, make a BackupService.List request.
rpc ListBackups (ListClusterBackupsRequest) returns (ListClusterBackupsResponse)
ListClusterBackupsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to list backups for. To get this ID, make a ClusterService.List request. 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 API returns a ListClusterBackupsResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.ListBackups requests. The maximum value is 1000. |
page_token | string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListClusterBackupsResponse.next_page_token returned by the previous ClusterService.ListBackups request. The maximum string length in characters is 100. |
ListClusterBackupsResponse
Field | Description |
---|---|
backups[] | Backup List of the cluster backups. |
next_page_token | string The token that can be used to get the next page of results. If the number of results is larger than ListClusterBackupsRequest.page_size, use the next_page_token as the value for the ListClusterBackupsRequest.page_token in the subsequent ClusterService.ListBackups request to iterate through multiple pages of results. Each of the subsequent ClusterService.ListBackups requests should use the next_page_token value returned by the previous request to continue paging through the results. |
Backup
Field | Description |
---|---|
id | string Required. ID of the backup. |
folder_id | string ID of the folder that the backup belongs to. |
created_at | google.protobuf.Timestamp Creation timestamp (the time when the backup operation was completed). |
source_cluster_id | string ID of the cluster that the backup was created for. |
started_at | google.protobuf.Timestamp Start timestamp (the time when the backup operation was started). |
size | int64 Size of backup, in bytes |
type | enum BackupCreationType How this backup was created (manual/automatic/etc...)
|
ListHosts
Retrieves a list of hosts for a cluster.
rpc ListHosts (ListClusterHostsRequest) returns (ListClusterHostsResponse)
ListClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the cluster to list hosts for. To get this ID, make a ClusterService.List request. 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 API returns a ListClusterHostsResponse.next_page_token that can be used to get the next page of results in the subsequent ClusterService.ListHosts requests. Acceptable values are 0 to 1000, inclusive. |
page_token | string Page token that can be used to iterate through multiple pages of results. To get the next page of results, set page_token to the ListClusterHostsResponse.next_page_token returned by the previous ClusterService.ListHosts request. The maximum string length in characters is 100. |
ListClusterHostsResponse
Field | Description |
---|---|
hosts[] | Host List of hosts in the cluster. |
next_page_token | string The token that can be used to get the next page of results. If the number of results is larger than ListClusterHostsRequest.page_size, use the next_page_token as the value for the ListClusterHostsRequest.page_token in the subsequent ClusterService.ListHosts request to iterate through multiple pages of results. Each of the subsequent ClusterService.ListHosts requests should use the next_page_token value returned by the previous request to continue paging through the results. |
Host
Field | Description |
---|---|
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. |
cluster_id | string ID of the cluster the host belongs to. |
zone_id | string ID of the availability zone where the host resides. |
resources | Resources Resources allocated to the host. |
role | enum Role Role of the host in the cluster.
|
health | enum Health Aggregated health of the host.
|
services[] | Service List of services provided by the host. |
subnet_id | string ID of the subnet that the host belongs to. |
assign_public_ip | bool Flag that shows if public IP address is assigned to the host so that the host can be accessed from the internet. |
replication_source | string Name of the host to be used as the replication source for cascading replication. |
backup_priority | int64 Host backup priority. Acceptable values are 0 to 100, inclusive. |
priority | int64 Host master promotion priority. Acceptable values are 0 to 100, inclusive. |
Resources
Field | Description |
---|---|
resource_preset_id | 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. |
disk_size | int64 Volume of the storage (for each cluster host, in bytes). |
disk_type_id | string Type of the storage. Possible values:
See the documentation for details. |
Service
Field | Description |
---|---|
type | enum Type Type of the service provided by the host.
|
health | enum Health Aggregated health of the service.
|
AddHosts
Adds new hosts in 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 cluster to add hosts to. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
host_specs[] | HostSpec Configuration of the newly added hosts. 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, make the yandex.cloud.compute.v1.ZoneService.List request. The maximum string length in characters is 50. |
subnet_id | string ID of the subnet to assign to the host. This subnet should be a part of the cluster network (the network ID is specified in the ClusterService.CreateClusterRequest.network_id). The maximum string length in characters is 50. |
assign_public_ip | bool Option that enables public IP address for the host so that the host can be accessed from the internet. After a host has been created, this setting cannot be changed. To remove an assigned public IP address, or to assign a public IP address to a host without one, recreate the host with the appropriate assign_public_ip value set. Possible values:
|
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). |
backup_priority | int64 Host backup priority Acceptable values are 0 to 100, inclusive. |
priority | int64 Host master promotion priority Acceptable values are 0 to 100, inclusive. |
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 if operation finished successfully. |
AddClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster to which the hosts are being added. |
host_names[] | string Names of hosts that are being added. |
UpdateHosts
Updates the specified hosts.
rpc UpdateHosts (UpdateClusterHostsRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateClusterHostsMetadata
Operation.response:google.protobuf.Empty
UpdateClusterHostsRequest
Field | Description |
---|---|
cluster_id | string Required. ID of the MySQL cluster to update hosts in. To get the MySQL cluster ID, use a ClusterService.List request. The maximum string length in characters is 50. |
update_host_specs[] | UpdateHostSpec New configurations to apply to hosts. The number of elements must be greater than 0. |
UpdateHostSpec
Field | Description |
---|---|
host_name | string Required. Name of the host to update. To get a MySQL host name, use a ClusterService.ListHosts request. |
replication_source | string Host.name of the host to be used as the replication source (for cascading replication). To get a MySQL host name, use a ClusterService.ListHosts request. |
update_mask | google.protobuf.FieldMask Field mask that specifies which settings of the MySQL host should be updated. |
backup_priority | int64 Host backup priority. Acceptable values are 0 to 100, inclusive. |
assign_public_ip | bool Whether the host should get a public IP address on creation. |
priority | int64 Host master promotion priority. Acceptable values are 0 to 100, inclusive. |
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 if operation finished successfully. |
UpdateClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster in which the hosts are being updated. |
host_names[] | string Names of hosts that are being updated. |
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 cluster to delete hosts from. To get this ID, make a ClusterService.List request. The maximum string length in characters is 50. |
host_names[] | string Names of hosts to delete. To get these names, make a ClusterService.ListHosts request. 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 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 if operation finished successfully. |
DeleteClusterHostsMetadata
Field | Description |
---|---|
cluster_id | string ID of the cluster from which the hosts are being deleted. |
host_names[] | string Names of hosts that are being deleted. |