Managed Service for MySQL API, gRPC: ClusterService.Backup
Creates a backup for a cluster.
To get information about a backup, make a BackupService.Get request.
gRPC request
rpc Backup (BackupClusterRequest) returns (operation.Operation)
BackupClusterRequest
{
"cluster_id": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the cluster to back up. To get this ID, make a ClusterService.List request. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": {
"cluster_id": "string",
"backup_id": "string"
},
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": {
"id": "string",
"folder_id": "string",
"created_at": "google.protobuf.Timestamp",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"environment": "Environment",
"monitoring": [
{
"name": "string",
"description": "string",
"link": "string"
}
],
"config": {
"version": "string",
// Includes only one of the fields `mysql_config_5_7`, `mysql_config_8_0`
"mysql_config_5_7": {
"effective_config": {
"innodb_buffer_pool_size": "google.protobuf.Int64Value",
"max_connections": "google.protobuf.Int64Value",
"long_query_time": "google.protobuf.DoubleValue",
"general_log": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue",
"sql_mode": [
"SQLMode"
],
"max_allowed_packet": "google.protobuf.Int64Value",
"default_authentication_plugin": "AuthPlugin",
"innodb_flush_log_at_trx_commit": "google.protobuf.Int64Value",
"innodb_lock_wait_timeout": "google.protobuf.Int64Value",
"transaction_isolation": "TransactionIsolation",
"innodb_print_all_deadlocks": "google.protobuf.BoolValue",
"net_read_timeout": "google.protobuf.Int64Value",
"net_write_timeout": "google.protobuf.Int64Value",
"group_concat_max_len": "google.protobuf.Int64Value",
"tmp_table_size": "google.protobuf.Int64Value",
"max_heap_table_size": "google.protobuf.Int64Value",
"default_time_zone": "string",
"character_set_server": "string",
"collation_server": "string",
"innodb_adaptive_hash_index": "google.protobuf.BoolValue",
"innodb_numa_interleave": "google.protobuf.BoolValue",
"innodb_log_buffer_size": "google.protobuf.Int64Value",
"innodb_log_file_size": "google.protobuf.Int64Value",
"innodb_io_capacity": "google.protobuf.Int64Value",
"innodb_io_capacity_max": "google.protobuf.Int64Value",
"innodb_read_io_threads": "google.protobuf.Int64Value",
"innodb_write_io_threads": "google.protobuf.Int64Value",
"innodb_purge_threads": "google.protobuf.Int64Value",
"innodb_thread_concurrency": "google.protobuf.Int64Value",
"innodb_temp_data_file_max_size": "google.protobuf.Int64Value",
"thread_cache_size": "google.protobuf.Int64Value",
"thread_stack": "google.protobuf.Int64Value",
"join_buffer_size": "google.protobuf.Int64Value",
"sort_buffer_size": "google.protobuf.Int64Value",
"table_definition_cache": "google.protobuf.Int64Value",
"table_open_cache": "google.protobuf.Int64Value",
"table_open_cache_instances": "google.protobuf.Int64Value",
"explicit_defaults_for_timestamp": "google.protobuf.BoolValue",
"auto_increment_increment": "google.protobuf.Int64Value",
"auto_increment_offset": "google.protobuf.Int64Value",
"sync_binlog": "google.protobuf.Int64Value",
"binlog_cache_size": "google.protobuf.Int64Value",
"binlog_group_commit_sync_delay": "google.protobuf.Int64Value",
"binlog_row_image": "BinlogRowImage",
"binlog_rows_query_log_events": "google.protobuf.BoolValue",
"rpl_semi_sync_master_wait_for_slave_count": "google.protobuf.Int64Value",
"slave_parallel_type": "SlaveParallelType",
"slave_parallel_workers": "google.protobuf.Int64Value",
"mdb_preserve_binlog_bytes": "google.protobuf.Int64Value",
"interactive_timeout": "google.protobuf.Int64Value",
"wait_timeout": "google.protobuf.Int64Value",
"mdb_offline_mode_enable_lag": "google.protobuf.Int64Value",
"mdb_offline_mode_disable_lag": "google.protobuf.Int64Value",
"range_optimizer_max_mem_size": "google.protobuf.Int64Value",
"slow_query_log": "google.protobuf.BoolValue",
"slow_query_log_always_write_time": "google.protobuf.DoubleValue",
"log_slow_rate_type": "LogSlowRateType",
"log_slow_rate_limit": "google.protobuf.Int64Value",
"log_slow_sp_statements": "google.protobuf.BoolValue",
"log_slow_filter": [
"LogSlowFilterType"
],
"mdb_priority_choice_max_lag": "google.protobuf.Int64Value",
"innodb_page_size": "google.protobuf.Int64Value",
"innodb_online_alter_log_max_size": "google.protobuf.Int64Value",
"innodb_ft_min_token_size": "google.protobuf.Int64Value",
"innodb_ft_max_token_size": "google.protobuf.Int64Value",
"lower_case_table_names": "google.protobuf.Int64Value",
"show_compatibility_56": "google.protobuf.BoolValue",
"max_sp_recursion_depth": "google.protobuf.Int64Value",
"innodb_compression_level": "google.protobuf.Int64Value",
"binlog_transaction_dependency_tracking": "BinlogTransactionDependencyTracking",
"autocommit": "google.protobuf.BoolValue",
"innodb_status_output": "google.protobuf.BoolValue",
"innodb_strict_mode": "google.protobuf.BoolValue",
"innodb_print_lock_wait_timeout_info": "google.protobuf.BoolValue",
"log_error_verbosity": "google.protobuf.Int64Value",
"max_digest_length": "google.protobuf.Int64Value",
"query_cache_limit": "google.protobuf.Int64Value",
"query_cache_size": "google.protobuf.Int64Value",
"query_cache_type": "google.protobuf.Int64Value",
"lock_wait_timeout": "google.protobuf.Int64Value",
"max_prepared_stmt_count": "google.protobuf.Int64Value",
"optimizer_switch": "string",
"optimizer_search_depth": "google.protobuf.Int64Value",
"query_response_time_stats": "google.protobuf.BoolValue",
"userstat": "google.protobuf.BoolValue",
"max_execution_time": "google.protobuf.Int64Value"
},
"user_config": {
"innodb_buffer_pool_size": "google.protobuf.Int64Value",
"max_connections": "google.protobuf.Int64Value",
"long_query_time": "google.protobuf.DoubleValue",
"general_log": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue",
"sql_mode": [
"SQLMode"
],
"max_allowed_packet": "google.protobuf.Int64Value",
"default_authentication_plugin": "AuthPlugin",
"innodb_flush_log_at_trx_commit": "google.protobuf.Int64Value",
"innodb_lock_wait_timeout": "google.protobuf.Int64Value",
"transaction_isolation": "TransactionIsolation",
"innodb_print_all_deadlocks": "google.protobuf.BoolValue",
"net_read_timeout": "google.protobuf.Int64Value",
"net_write_timeout": "google.protobuf.Int64Value",
"group_concat_max_len": "google.protobuf.Int64Value",
"tmp_table_size": "google.protobuf.Int64Value",
"max_heap_table_size": "google.protobuf.Int64Value",
"default_time_zone": "string",
"character_set_server": "string",
"collation_server": "string",
"innodb_adaptive_hash_index": "google.protobuf.BoolValue",
"innodb_numa_interleave": "google.protobuf.BoolValue",
"innodb_log_buffer_size": "google.protobuf.Int64Value",
"innodb_log_file_size": "google.protobuf.Int64Value",
"innodb_io_capacity": "google.protobuf.Int64Value",
"innodb_io_capacity_max": "google.protobuf.Int64Value",
"innodb_read_io_threads": "google.protobuf.Int64Value",
"innodb_write_io_threads": "google.protobuf.Int64Value",
"innodb_purge_threads": "google.protobuf.Int64Value",
"innodb_thread_concurrency": "google.protobuf.Int64Value",
"innodb_temp_data_file_max_size": "google.protobuf.Int64Value",
"thread_cache_size": "google.protobuf.Int64Value",
"thread_stack": "google.protobuf.Int64Value",
"join_buffer_size": "google.protobuf.Int64Value",
"sort_buffer_size": "google.protobuf.Int64Value",
"table_definition_cache": "google.protobuf.Int64Value",
"table_open_cache": "google.protobuf.Int64Value",
"table_open_cache_instances": "google.protobuf.Int64Value",
"explicit_defaults_for_timestamp": "google.protobuf.BoolValue",
"auto_increment_increment": "google.protobuf.Int64Value",
"auto_increment_offset": "google.protobuf.Int64Value",
"sync_binlog": "google.protobuf.Int64Value",
"binlog_cache_size": "google.protobuf.Int64Value",
"binlog_group_commit_sync_delay": "google.protobuf.Int64Value",
"binlog_row_image": "BinlogRowImage",
"binlog_rows_query_log_events": "google.protobuf.BoolValue",
"rpl_semi_sync_master_wait_for_slave_count": "google.protobuf.Int64Value",
"slave_parallel_type": "SlaveParallelType",
"slave_parallel_workers": "google.protobuf.Int64Value",
"mdb_preserve_binlog_bytes": "google.protobuf.Int64Value",
"interactive_timeout": "google.protobuf.Int64Value",
"wait_timeout": "google.protobuf.Int64Value",
"mdb_offline_mode_enable_lag": "google.protobuf.Int64Value",
"mdb_offline_mode_disable_lag": "google.protobuf.Int64Value",
"range_optimizer_max_mem_size": "google.protobuf.Int64Value",
"slow_query_log": "google.protobuf.BoolValue",
"slow_query_log_always_write_time": "google.protobuf.DoubleValue",
"log_slow_rate_type": "LogSlowRateType",
"log_slow_rate_limit": "google.protobuf.Int64Value",
"log_slow_sp_statements": "google.protobuf.BoolValue",
"log_slow_filter": [
"LogSlowFilterType"
],
"mdb_priority_choice_max_lag": "google.protobuf.Int64Value",
"innodb_page_size": "google.protobuf.Int64Value",
"innodb_online_alter_log_max_size": "google.protobuf.Int64Value",
"innodb_ft_min_token_size": "google.protobuf.Int64Value",
"innodb_ft_max_token_size": "google.protobuf.Int64Value",
"lower_case_table_names": "google.protobuf.Int64Value",
"show_compatibility_56": "google.protobuf.BoolValue",
"max_sp_recursion_depth": "google.protobuf.Int64Value",
"innodb_compression_level": "google.protobuf.Int64Value",
"binlog_transaction_dependency_tracking": "BinlogTransactionDependencyTracking",
"autocommit": "google.protobuf.BoolValue",
"innodb_status_output": "google.protobuf.BoolValue",
"innodb_strict_mode": "google.protobuf.BoolValue",
"innodb_print_lock_wait_timeout_info": "google.protobuf.BoolValue",
"log_error_verbosity": "google.protobuf.Int64Value",
"max_digest_length": "google.protobuf.Int64Value",
"query_cache_limit": "google.protobuf.Int64Value",
"query_cache_size": "google.protobuf.Int64Value",
"query_cache_type": "google.protobuf.Int64Value",
"lock_wait_timeout": "google.protobuf.Int64Value",
"max_prepared_stmt_count": "google.protobuf.Int64Value",
"optimizer_switch": "string",
"optimizer_search_depth": "google.protobuf.Int64Value",
"query_response_time_stats": "google.protobuf.BoolValue",
"userstat": "google.protobuf.BoolValue",
"max_execution_time": "google.protobuf.Int64Value"
},
"default_config": {
"innodb_buffer_pool_size": "google.protobuf.Int64Value",
"max_connections": "google.protobuf.Int64Value",
"long_query_time": "google.protobuf.DoubleValue",
"general_log": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue",
"sql_mode": [
"SQLMode"
],
"max_allowed_packet": "google.protobuf.Int64Value",
"default_authentication_plugin": "AuthPlugin",
"innodb_flush_log_at_trx_commit": "google.protobuf.Int64Value",
"innodb_lock_wait_timeout": "google.protobuf.Int64Value",
"transaction_isolation": "TransactionIsolation",
"innodb_print_all_deadlocks": "google.protobuf.BoolValue",
"net_read_timeout": "google.protobuf.Int64Value",
"net_write_timeout": "google.protobuf.Int64Value",
"group_concat_max_len": "google.protobuf.Int64Value",
"tmp_table_size": "google.protobuf.Int64Value",
"max_heap_table_size": "google.protobuf.Int64Value",
"default_time_zone": "string",
"character_set_server": "string",
"collation_server": "string",
"innodb_adaptive_hash_index": "google.protobuf.BoolValue",
"innodb_numa_interleave": "google.protobuf.BoolValue",
"innodb_log_buffer_size": "google.protobuf.Int64Value",
"innodb_log_file_size": "google.protobuf.Int64Value",
"innodb_io_capacity": "google.protobuf.Int64Value",
"innodb_io_capacity_max": "google.protobuf.Int64Value",
"innodb_read_io_threads": "google.protobuf.Int64Value",
"innodb_write_io_threads": "google.protobuf.Int64Value",
"innodb_purge_threads": "google.protobuf.Int64Value",
"innodb_thread_concurrency": "google.protobuf.Int64Value",
"innodb_temp_data_file_max_size": "google.protobuf.Int64Value",
"thread_cache_size": "google.protobuf.Int64Value",
"thread_stack": "google.protobuf.Int64Value",
"join_buffer_size": "google.protobuf.Int64Value",
"sort_buffer_size": "google.protobuf.Int64Value",
"table_definition_cache": "google.protobuf.Int64Value",
"table_open_cache": "google.protobuf.Int64Value",
"table_open_cache_instances": "google.protobuf.Int64Value",
"explicit_defaults_for_timestamp": "google.protobuf.BoolValue",
"auto_increment_increment": "google.protobuf.Int64Value",
"auto_increment_offset": "google.protobuf.Int64Value",
"sync_binlog": "google.protobuf.Int64Value",
"binlog_cache_size": "google.protobuf.Int64Value",
"binlog_group_commit_sync_delay": "google.protobuf.Int64Value",
"binlog_row_image": "BinlogRowImage",
"binlog_rows_query_log_events": "google.protobuf.BoolValue",
"rpl_semi_sync_master_wait_for_slave_count": "google.protobuf.Int64Value",
"slave_parallel_type": "SlaveParallelType",
"slave_parallel_workers": "google.protobuf.Int64Value",
"mdb_preserve_binlog_bytes": "google.protobuf.Int64Value",
"interactive_timeout": "google.protobuf.Int64Value",
"wait_timeout": "google.protobuf.Int64Value",
"mdb_offline_mode_enable_lag": "google.protobuf.Int64Value",
"mdb_offline_mode_disable_lag": "google.protobuf.Int64Value",
"range_optimizer_max_mem_size": "google.protobuf.Int64Value",
"slow_query_log": "google.protobuf.BoolValue",
"slow_query_log_always_write_time": "google.protobuf.DoubleValue",
"log_slow_rate_type": "LogSlowRateType",
"log_slow_rate_limit": "google.protobuf.Int64Value",
"log_slow_sp_statements": "google.protobuf.BoolValue",
"log_slow_filter": [
"LogSlowFilterType"
],
"mdb_priority_choice_max_lag": "google.protobuf.Int64Value",
"innodb_page_size": "google.protobuf.Int64Value",
"innodb_online_alter_log_max_size": "google.protobuf.Int64Value",
"innodb_ft_min_token_size": "google.protobuf.Int64Value",
"innodb_ft_max_token_size": "google.protobuf.Int64Value",
"lower_case_table_names": "google.protobuf.Int64Value",
"show_compatibility_56": "google.protobuf.BoolValue",
"max_sp_recursion_depth": "google.protobuf.Int64Value",
"innodb_compression_level": "google.protobuf.Int64Value",
"binlog_transaction_dependency_tracking": "BinlogTransactionDependencyTracking",
"autocommit": "google.protobuf.BoolValue",
"innodb_status_output": "google.protobuf.BoolValue",
"innodb_strict_mode": "google.protobuf.BoolValue",
"innodb_print_lock_wait_timeout_info": "google.protobuf.BoolValue",
"log_error_verbosity": "google.protobuf.Int64Value",
"max_digest_length": "google.protobuf.Int64Value",
"query_cache_limit": "google.protobuf.Int64Value",
"query_cache_size": "google.protobuf.Int64Value",
"query_cache_type": "google.protobuf.Int64Value",
"lock_wait_timeout": "google.protobuf.Int64Value",
"max_prepared_stmt_count": "google.protobuf.Int64Value",
"optimizer_switch": "string",
"optimizer_search_depth": "google.protobuf.Int64Value",
"query_response_time_stats": "google.protobuf.BoolValue",
"userstat": "google.protobuf.BoolValue",
"max_execution_time": "google.protobuf.Int64Value"
}
},
"mysql_config_8_0": {
"effective_config": {
"innodb_buffer_pool_size": "google.protobuf.Int64Value",
"max_connections": "google.protobuf.Int64Value",
"long_query_time": "google.protobuf.DoubleValue",
"general_log": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue",
"sql_mode": [
"SQLMode"
],
"max_allowed_packet": "google.protobuf.Int64Value",
"default_authentication_plugin": "AuthPlugin",
"innodb_flush_log_at_trx_commit": "google.protobuf.Int64Value",
"innodb_lock_wait_timeout": "google.protobuf.Int64Value",
"transaction_isolation": "TransactionIsolation",
"innodb_print_all_deadlocks": "google.protobuf.BoolValue",
"net_read_timeout": "google.protobuf.Int64Value",
"net_write_timeout": "google.protobuf.Int64Value",
"group_concat_max_len": "google.protobuf.Int64Value",
"tmp_table_size": "google.protobuf.Int64Value",
"max_heap_table_size": "google.protobuf.Int64Value",
"default_time_zone": "string",
"character_set_server": "string",
"collation_server": "string",
"innodb_adaptive_hash_index": "google.protobuf.BoolValue",
"innodb_numa_interleave": "google.protobuf.BoolValue",
"innodb_log_buffer_size": "google.protobuf.Int64Value",
"innodb_log_file_size": "google.protobuf.Int64Value",
"innodb_io_capacity": "google.protobuf.Int64Value",
"innodb_io_capacity_max": "google.protobuf.Int64Value",
"innodb_read_io_threads": "google.protobuf.Int64Value",
"innodb_write_io_threads": "google.protobuf.Int64Value",
"innodb_purge_threads": "google.protobuf.Int64Value",
"innodb_thread_concurrency": "google.protobuf.Int64Value",
"innodb_temp_data_file_max_size": "google.protobuf.Int64Value",
"thread_cache_size": "google.protobuf.Int64Value",
"thread_stack": "google.protobuf.Int64Value",
"join_buffer_size": "google.protobuf.Int64Value",
"sort_buffer_size": "google.protobuf.Int64Value",
"table_definition_cache": "google.protobuf.Int64Value",
"table_open_cache": "google.protobuf.Int64Value",
"table_open_cache_instances": "google.protobuf.Int64Value",
"explicit_defaults_for_timestamp": "google.protobuf.BoolValue",
"auto_increment_increment": "google.protobuf.Int64Value",
"auto_increment_offset": "google.protobuf.Int64Value",
"sync_binlog": "google.protobuf.Int64Value",
"binlog_cache_size": "google.protobuf.Int64Value",
"binlog_group_commit_sync_delay": "google.protobuf.Int64Value",
"binlog_row_image": "BinlogRowImage",
"binlog_rows_query_log_events": "google.protobuf.BoolValue",
"rpl_semi_sync_master_wait_for_slave_count": "google.protobuf.Int64Value",
"slave_parallel_type": "SlaveParallelType",
"slave_parallel_workers": "google.protobuf.Int64Value",
"regexp_time_limit": "google.protobuf.Int64Value",
"mdb_preserve_binlog_bytes": "google.protobuf.Int64Value",
"interactive_timeout": "google.protobuf.Int64Value",
"wait_timeout": "google.protobuf.Int64Value",
"mdb_offline_mode_enable_lag": "google.protobuf.Int64Value",
"mdb_offline_mode_disable_lag": "google.protobuf.Int64Value",
"range_optimizer_max_mem_size": "google.protobuf.Int64Value",
"slow_query_log": "google.protobuf.BoolValue",
"slow_query_log_always_write_time": "google.protobuf.DoubleValue",
"log_slow_rate_type": "LogSlowRateType",
"log_slow_rate_limit": "google.protobuf.Int64Value",
"log_slow_sp_statements": "google.protobuf.BoolValue",
"log_slow_filter": [
"LogSlowFilterType"
],
"mdb_priority_choice_max_lag": "google.protobuf.Int64Value",
"innodb_page_size": "google.protobuf.Int64Value",
"innodb_online_alter_log_max_size": "google.protobuf.Int64Value",
"innodb_ft_min_token_size": "google.protobuf.Int64Value",
"innodb_ft_max_token_size": "google.protobuf.Int64Value",
"lower_case_table_names": "google.protobuf.Int64Value",
"max_sp_recursion_depth": "google.protobuf.Int64Value",
"innodb_compression_level": "google.protobuf.Int64Value",
"binlog_transaction_dependency_tracking": "BinlogTransactionDependencyTracking",
"autocommit": "google.protobuf.BoolValue",
"innodb_status_output": "google.protobuf.BoolValue",
"innodb_strict_mode": "google.protobuf.BoolValue",
"innodb_print_lock_wait_timeout_info": "google.protobuf.BoolValue",
"log_error_verbosity": "google.protobuf.Int64Value",
"max_digest_length": "google.protobuf.Int64Value",
"lock_wait_timeout": "google.protobuf.Int64Value",
"max_prepared_stmt_count": "google.protobuf.Int64Value",
"optimizer_switch": "string",
"optimizer_search_depth": "google.protobuf.Int64Value",
"userstat": "google.protobuf.BoolValue",
"max_execution_time": "google.protobuf.Int64Value"
},
"user_config": {
"innodb_buffer_pool_size": "google.protobuf.Int64Value",
"max_connections": "google.protobuf.Int64Value",
"long_query_time": "google.protobuf.DoubleValue",
"general_log": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue",
"sql_mode": [
"SQLMode"
],
"max_allowed_packet": "google.protobuf.Int64Value",
"default_authentication_plugin": "AuthPlugin",
"innodb_flush_log_at_trx_commit": "google.protobuf.Int64Value",
"innodb_lock_wait_timeout": "google.protobuf.Int64Value",
"transaction_isolation": "TransactionIsolation",
"innodb_print_all_deadlocks": "google.protobuf.BoolValue",
"net_read_timeout": "google.protobuf.Int64Value",
"net_write_timeout": "google.protobuf.Int64Value",
"group_concat_max_len": "google.protobuf.Int64Value",
"tmp_table_size": "google.protobuf.Int64Value",
"max_heap_table_size": "google.protobuf.Int64Value",
"default_time_zone": "string",
"character_set_server": "string",
"collation_server": "string",
"innodb_adaptive_hash_index": "google.protobuf.BoolValue",
"innodb_numa_interleave": "google.protobuf.BoolValue",
"innodb_log_buffer_size": "google.protobuf.Int64Value",
"innodb_log_file_size": "google.protobuf.Int64Value",
"innodb_io_capacity": "google.protobuf.Int64Value",
"innodb_io_capacity_max": "google.protobuf.Int64Value",
"innodb_read_io_threads": "google.protobuf.Int64Value",
"innodb_write_io_threads": "google.protobuf.Int64Value",
"innodb_purge_threads": "google.protobuf.Int64Value",
"innodb_thread_concurrency": "google.protobuf.Int64Value",
"innodb_temp_data_file_max_size": "google.protobuf.Int64Value",
"thread_cache_size": "google.protobuf.Int64Value",
"thread_stack": "google.protobuf.Int64Value",
"join_buffer_size": "google.protobuf.Int64Value",
"sort_buffer_size": "google.protobuf.Int64Value",
"table_definition_cache": "google.protobuf.Int64Value",
"table_open_cache": "google.protobuf.Int64Value",
"table_open_cache_instances": "google.protobuf.Int64Value",
"explicit_defaults_for_timestamp": "google.protobuf.BoolValue",
"auto_increment_increment": "google.protobuf.Int64Value",
"auto_increment_offset": "google.protobuf.Int64Value",
"sync_binlog": "google.protobuf.Int64Value",
"binlog_cache_size": "google.protobuf.Int64Value",
"binlog_group_commit_sync_delay": "google.protobuf.Int64Value",
"binlog_row_image": "BinlogRowImage",
"binlog_rows_query_log_events": "google.protobuf.BoolValue",
"rpl_semi_sync_master_wait_for_slave_count": "google.protobuf.Int64Value",
"slave_parallel_type": "SlaveParallelType",
"slave_parallel_workers": "google.protobuf.Int64Value",
"regexp_time_limit": "google.protobuf.Int64Value",
"mdb_preserve_binlog_bytes": "google.protobuf.Int64Value",
"interactive_timeout": "google.protobuf.Int64Value",
"wait_timeout": "google.protobuf.Int64Value",
"mdb_offline_mode_enable_lag": "google.protobuf.Int64Value",
"mdb_offline_mode_disable_lag": "google.protobuf.Int64Value",
"range_optimizer_max_mem_size": "google.protobuf.Int64Value",
"slow_query_log": "google.protobuf.BoolValue",
"slow_query_log_always_write_time": "google.protobuf.DoubleValue",
"log_slow_rate_type": "LogSlowRateType",
"log_slow_rate_limit": "google.protobuf.Int64Value",
"log_slow_sp_statements": "google.protobuf.BoolValue",
"log_slow_filter": [
"LogSlowFilterType"
],
"mdb_priority_choice_max_lag": "google.protobuf.Int64Value",
"innodb_page_size": "google.protobuf.Int64Value",
"innodb_online_alter_log_max_size": "google.protobuf.Int64Value",
"innodb_ft_min_token_size": "google.protobuf.Int64Value",
"innodb_ft_max_token_size": "google.protobuf.Int64Value",
"lower_case_table_names": "google.protobuf.Int64Value",
"max_sp_recursion_depth": "google.protobuf.Int64Value",
"innodb_compression_level": "google.protobuf.Int64Value",
"binlog_transaction_dependency_tracking": "BinlogTransactionDependencyTracking",
"autocommit": "google.protobuf.BoolValue",
"innodb_status_output": "google.protobuf.BoolValue",
"innodb_strict_mode": "google.protobuf.BoolValue",
"innodb_print_lock_wait_timeout_info": "google.protobuf.BoolValue",
"log_error_verbosity": "google.protobuf.Int64Value",
"max_digest_length": "google.protobuf.Int64Value",
"lock_wait_timeout": "google.protobuf.Int64Value",
"max_prepared_stmt_count": "google.protobuf.Int64Value",
"optimizer_switch": "string",
"optimizer_search_depth": "google.protobuf.Int64Value",
"userstat": "google.protobuf.BoolValue",
"max_execution_time": "google.protobuf.Int64Value"
},
"default_config": {
"innodb_buffer_pool_size": "google.protobuf.Int64Value",
"max_connections": "google.protobuf.Int64Value",
"long_query_time": "google.protobuf.DoubleValue",
"general_log": "google.protobuf.BoolValue",
"audit_log": "google.protobuf.BoolValue",
"sql_mode": [
"SQLMode"
],
"max_allowed_packet": "google.protobuf.Int64Value",
"default_authentication_plugin": "AuthPlugin",
"innodb_flush_log_at_trx_commit": "google.protobuf.Int64Value",
"innodb_lock_wait_timeout": "google.protobuf.Int64Value",
"transaction_isolation": "TransactionIsolation",
"innodb_print_all_deadlocks": "google.protobuf.BoolValue",
"net_read_timeout": "google.protobuf.Int64Value",
"net_write_timeout": "google.protobuf.Int64Value",
"group_concat_max_len": "google.protobuf.Int64Value",
"tmp_table_size": "google.protobuf.Int64Value",
"max_heap_table_size": "google.protobuf.Int64Value",
"default_time_zone": "string",
"character_set_server": "string",
"collation_server": "string",
"innodb_adaptive_hash_index": "google.protobuf.BoolValue",
"innodb_numa_interleave": "google.protobuf.BoolValue",
"innodb_log_buffer_size": "google.protobuf.Int64Value",
"innodb_log_file_size": "google.protobuf.Int64Value",
"innodb_io_capacity": "google.protobuf.Int64Value",
"innodb_io_capacity_max": "google.protobuf.Int64Value",
"innodb_read_io_threads": "google.protobuf.Int64Value",
"innodb_write_io_threads": "google.protobuf.Int64Value",
"innodb_purge_threads": "google.protobuf.Int64Value",
"innodb_thread_concurrency": "google.protobuf.Int64Value",
"innodb_temp_data_file_max_size": "google.protobuf.Int64Value",
"thread_cache_size": "google.protobuf.Int64Value",
"thread_stack": "google.protobuf.Int64Value",
"join_buffer_size": "google.protobuf.Int64Value",
"sort_buffer_size": "google.protobuf.Int64Value",
"table_definition_cache": "google.protobuf.Int64Value",
"table_open_cache": "google.protobuf.Int64Value",
"table_open_cache_instances": "google.protobuf.Int64Value",
"explicit_defaults_for_timestamp": "google.protobuf.BoolValue",
"auto_increment_increment": "google.protobuf.Int64Value",
"auto_increment_offset": "google.protobuf.Int64Value",
"sync_binlog": "google.protobuf.Int64Value",
"binlog_cache_size": "google.protobuf.Int64Value",
"binlog_group_commit_sync_delay": "google.protobuf.Int64Value",
"binlog_row_image": "BinlogRowImage",
"binlog_rows_query_log_events": "google.protobuf.BoolValue",
"rpl_semi_sync_master_wait_for_slave_count": "google.protobuf.Int64Value",
"slave_parallel_type": "SlaveParallelType",
"slave_parallel_workers": "google.protobuf.Int64Value",
"regexp_time_limit": "google.protobuf.Int64Value",
"mdb_preserve_binlog_bytes": "google.protobuf.Int64Value",
"interactive_timeout": "google.protobuf.Int64Value",
"wait_timeout": "google.protobuf.Int64Value",
"mdb_offline_mode_enable_lag": "google.protobuf.Int64Value",
"mdb_offline_mode_disable_lag": "google.protobuf.Int64Value",
"range_optimizer_max_mem_size": "google.protobuf.Int64Value",
"slow_query_log": "google.protobuf.BoolValue",
"slow_query_log_always_write_time": "google.protobuf.DoubleValue",
"log_slow_rate_type": "LogSlowRateType",
"log_slow_rate_limit": "google.protobuf.Int64Value",
"log_slow_sp_statements": "google.protobuf.BoolValue",
"log_slow_filter": [
"LogSlowFilterType"
],
"mdb_priority_choice_max_lag": "google.protobuf.Int64Value",
"innodb_page_size": "google.protobuf.Int64Value",
"innodb_online_alter_log_max_size": "google.protobuf.Int64Value",
"innodb_ft_min_token_size": "google.protobuf.Int64Value",
"innodb_ft_max_token_size": "google.protobuf.Int64Value",
"lower_case_table_names": "google.protobuf.Int64Value",
"max_sp_recursion_depth": "google.protobuf.Int64Value",
"innodb_compression_level": "google.protobuf.Int64Value",
"binlog_transaction_dependency_tracking": "BinlogTransactionDependencyTracking",
"autocommit": "google.protobuf.BoolValue",
"innodb_status_output": "google.protobuf.BoolValue",
"innodb_strict_mode": "google.protobuf.BoolValue",
"innodb_print_lock_wait_timeout_info": "google.protobuf.BoolValue",
"log_error_verbosity": "google.protobuf.Int64Value",
"max_digest_length": "google.protobuf.Int64Value",
"lock_wait_timeout": "google.protobuf.Int64Value",
"max_prepared_stmt_count": "google.protobuf.Int64Value",
"optimizer_switch": "string",
"optimizer_search_depth": "google.protobuf.Int64Value",
"userstat": "google.protobuf.BoolValue",
"max_execution_time": "google.protobuf.Int64Value"
}
},
// end of the list of possible fields
"resources": {
"resource_preset_id": "string",
"disk_size": "int64",
"disk_type_id": "string"
},
"backup_window_start": "google.type.TimeOfDay",
"access": {
"data_lens": "bool",
"web_sql": "bool",
"data_transfer": "bool"
},
"performance_diagnostics": {
"enabled": "bool",
"sessions_sampling_interval": "int64",
"statements_sampling_interval": "int64"
},
"backup_retain_period_days": "google.protobuf.Int64Value"
},
"network_id": "string",
"health": "Health",
"status": "Status",
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"planned_operation": {
"info": "string",
"delayed_until": "google.protobuf.Timestamp"
},
"security_group_ids": [
"string"
],
"deletion_protection": "bool",
"host_group_ids": [
"string"
]
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
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
An object that represents MySQL cluster.
See the documentation for details.
|
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 |
Creation timestamp of the cluster. |
|
name |
string Name of the cluster. |
|
description |
string Description of the cluster. |
|
labels |
object (map<string, string>) Custom labels for the cluster as |
|
environment |
enum Environment Deployment environment of the MySQL cluster.
|
|
monitoring[] |
Monitoring systems data that is relevant to the cluster. |
|
config |
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 |
Maintenance window settings for the cluster. |
|
planned_operation |
Planned maintenance operation to be started for the cluster within the nearest |
|
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
Cluster-related monitoring system data.
|
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_5_7 |
Configuration of a MySQL 5.7 server. Includes only one of the fields Cluster-wide MySQL configuration. |
|
mysql_config_8_0 |
Configuration of a MySQL 8.0 server. Includes only one of the fields Cluster-wide MySQL configuration. |
|
resources |
Resource preset for the cluster hosts. |
|
backup_window_start |
Time to start the daily backup, in the UTC timezone. |
|
access |
Access policy for external services. |
|
performance_diagnostics |
Configuration of the performance diagnostics service. |
|
backup_retain_period_days |
Retention policy of automated backups. |
MysqlConfigSet5_7
|
Field |
Description |
|
effective_config |
Effective settings for a MySQL 5.7 cluster (a combination of settings defined |
|
user_config |
User-defined settings for a MySQL 5.7 cluster. |
|
default_config |
Default configuration for a MySQL 5.7 cluster. |
MysqlConfig5_7
Options and structure of MysqlConfig5_7 reflects MySQL 5.7 configuration file.
|
Field |
Description |
|
innodb_buffer_pool_size |
Size of the InnoDB buffer pool used for caching table and index data. See MySQL documentation for details. |
|
max_connections |
The maximum permitted number of simultaneous client connections. See MySQL documentation for details. |
|
long_query_time |
Time that it takes to process a query before it is considered slow. See MySQL documentation for details. |
|
general_log |
Enable writing of general query log of MySQL. See MySQL documentation for details. |
|
audit_log |
Enable writing of audit log of MySQL. See MySQL documentation for details. |
|
sql_mode[] |
enum SQLMode Server SQL mode of MySQL. See MySQL documentation for details.
|
|
max_allowed_packet |
The maximum size in bytes of one packet. See MySQL documentation for details. |
|
default_authentication_plugin |
enum AuthPlugin Authentication plugin used in the managed MySQL cluster. See MySQL documentation for details.
|
|
innodb_flush_log_at_trx_commit |
Transaction log flush behaviour. See MySQL documentation for details. |
|
innodb_lock_wait_timeout |
Max time in seconds for a transaction to wait for a row lock. See MySQL documentation for details. |
|
transaction_isolation |
enum TransactionIsolation Default transaction isolation level. See MySQL documentation for details.
|
|
innodb_print_all_deadlocks |
Print information about deadlocks in error log. See MySQL documentation for details. |
|
net_read_timeout |
The number of seconds to wait for more data from a connection before aborting the read. See MySQL documentation for details. |
|
net_write_timeout |
The number of seconds to wait for a block to be written to a connection before aborting the write. See MySQL documentation for details. |
|
group_concat_max_len |
The maximum permitted result length in bytes for the GROUP_CONCAT() function. See MySQL documentation for details. |
|
tmp_table_size |
The maximum size of internal in-memory temporary tables. See MySQL documentation for details. |
|
max_heap_table_size |
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. See MySQL documentation for details. |
|
default_time_zone |
string The servers default time zone. See MySQL documentation for details. |
|
character_set_server |
string The servers default character set. See MySQL documentation for details. |
|
collation_server |
string The server default collation. See MySQL documentation for details. |
|
innodb_adaptive_hash_index |
Enables InnoDB adaptive hash index. See MySQL documentation for details. |
|
innodb_numa_interleave |
Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. See MySQL documentation for details. |
|
innodb_log_buffer_size |
The size in bytes of the buffer that InnoDB uses to write to the log files on disk. See MySQL documentation for details. |
|
innodb_log_file_size |
The size in bytes of the single InnoDB Redo log file. See MySQL documentation for details. |
|
innodb_io_capacity |
Limits IO available for InnoDB background tasks. See MySQL documentation for details. |
|
innodb_io_capacity_max |
Limits IO available for InnoDB background tasks. See MySQL documentation for details. |
|
innodb_read_io_threads |
The number of I/O threads for read operations in InnoDB. See MySQL documentation for details. |
|
innodb_write_io_threads |
The number of I/O threads for write operations in InnoDB. See MySQL documentation for details. |
|
innodb_purge_threads |
The number of background threads devoted to the InnoDB purge operation. See MySQL documentation for details. |
|
innodb_thread_concurrency |
Defines the maximum number of threads permitted inside of InnoDB. See MySQL documentation for details. |
|
innodb_temp_data_file_max_size |
Limits the max size of InnoDB temp tablespace. See MySQL documentation for details. |
|
thread_cache_size |
A number of threads the server should cache for reuse. See MySQL documentation for details. |
|
thread_stack |
The stack size for each thread. The default is large enough for normal operation. See MySQL documentation for details. |
|
join_buffer_size |
The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. See MySQL documentation for details. |
|
sort_buffer_size |
Each session that must perform a sort allocates a buffer of this size. See MySQL documentation for details. |
|
table_definition_cache |
The number of table definitions that can be stored in the definition cache. See MySQL documentation for details. |
|
table_open_cache |
The number of open tables for all threads. See MySQL documentation for details. |
|
table_open_cache_instances |
The number of open tables cache instances. See MySQL documentation for details. |
|
explicit_defaults_for_timestamp |
Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. See MySQL documentation for details. |
|
auto_increment_increment |
Can be used to control the operation of AUTO_INCREMENT columns. See MySQL documentation for details. |
|
auto_increment_offset |
Can be used to control the operation of AUTO_INCREMENT columns. See MySQL documentation for details. |
|
sync_binlog |
Controls how often the MySQL server synchronizes the binary log to disk. See MySQL documentation for details. |
|
binlog_cache_size |
The size of the cache to hold changes to the binary log during a transaction. See MySQL documentation for details. |
|
binlog_group_commit_sync_delay |
Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. See MySQL documentation for the variable for details. |
|
binlog_row_image |
enum BinlogRowImage For MySQL row-based replication, this variable determines how row images are written to the binary log. See MySQL documentation for details.
|
|
binlog_rows_query_log_events |
When enabled, it causes the server to write informational log events such as row query log events into its binary log. See MySQL documentation for details. |
|
rpl_semi_sync_master_wait_for_slave_count |
The number of replica acknowledgments the source must receive per transaction before proceeding. See MySQL documentation for details. |
|
slave_parallel_type |
enum SlaveParallelType When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica. See MySQL documentation for details.
|
|
slave_parallel_workers |
Sets the number of applier threads for executing replication transactions in parallel. See MySQL documentation for details. |
|
mdb_preserve_binlog_bytes |
The size of the binary log to hold. |
|
interactive_timeout |
The number of seconds the server waits for activity on an interactive connection before closing it. See MySQL documentation for details. |
|
wait_timeout |
The number of seconds the server waits for activity on a noninteractive connection before closing it. See MySQL documentation for details. |
|
mdb_offline_mode_enable_lag |
Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data. |
|
mdb_offline_mode_disable_lag |
Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'. |
|
range_optimizer_max_mem_size |
The limit on memory consumption for the range optimizer. See MySQL documentation for details. |
|
slow_query_log |
Manages slow query log. See MySQL documentation for details. |
|
slow_query_log_always_write_time |
Query execution time, after which query to be logged unconditionally, that is, `log_slow_rate_limit`` will not apply to it. See Percona documentation for details. |
|
log_slow_rate_type |
enum LogSlowRateType Specifies slow log granularity for See Percona documentation for details.
|
|
log_slow_rate_limit |
Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query. See Percona documentation for details. |
|
log_slow_sp_statements |
When TRUE, statements executed by stored procedures are logged to the slow log. See Percona documentation for details. |
|
log_slow_filter[] |
enum LogSlowFilterType Filters the slow log by the query's execution plan. See Percona documentation for details.
|
|
mdb_priority_choice_max_lag |
Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from". |
|
innodb_page_size |
Specifies the page size for InnoDB tablespaces. For details, see MySQL documentation for the variable. |
|
innodb_online_alter_log_max_size |
The limit in bytes on the size of the temporary log files used during online DDL operations For details, see MySQL documentation for the variable. |
|
innodb_ft_min_token_size |
Minimum length of words that are stored in an InnoDB FULLTEXT index For details, see MySQL documentation for the variable. |
|
innodb_ft_max_token_size |
Maximum length of words that are stored in an InnoDB FULLTEXT index For details, see MySQL documentation for the variable. |
|
lower_case_table_names |
Table names storage and comparison strategy For details, see MySQL documentation for the variable. |
|
show_compatibility_56 |
Manages MySQL 5.6 compatibility For details, see MySQL documentation for the variable. |
|
max_sp_recursion_depth |
The number of times that any given stored procedure may be called recursively. For details, see MySQL documentation for the variable. |
|
innodb_compression_level |
The level of zlib compression to use for InnoDB compressed tables and indexes. For details, see MySQL documentation for the variable. |
|
binlog_transaction_dependency_tracking |
enum BinlogTransactionDependencyTracking Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel. For details, see MySQL documentation for the variable.
|
|
autocommit |
Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it. For details, see MySQL documentation for the variable. |
|
innodb_status_output |
Enables or disables periodic output for the standard InnoDB Monitor. For details, see MySQL documentation for the variable. |
|
innodb_strict_mode |
When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options. For details, see MySQL documentation for the variable. |
|
innodb_print_lock_wait_timeout_info |
Makes InnoDB to write information about all lock wait timeout errors into the log file. For details, see Percona documentation for the variable. |
|
log_error_verbosity |
System variable specifies the verbosity for handling events intended for the error log For details, see MySQL documentation for the variable. |
|
max_digest_length |
The maximum number of bytes of memory reserved per session for computation of normalized statement digests. For details, see MySQL documentation for the variable. |
|
query_cache_limit |
Do not cache results that are larger than this number of bytes. For details, see MySQL documentation for the variable. |
|
query_cache_size |
The amount of memory allocated for caching query results. For details, see MySQL documentation for the variable. |
|
query_cache_type |
Set the query cache type. For details, see MySQL documentation for the variable. |
|
lock_wait_timeout |
This variable specifies the timeout in seconds for attempts to acquire metadata locks For details, see MySQL documentation for the variable. |
|
max_prepared_stmt_count |
This variable limits the total number of prepared statements in the server. For details, see MySQL documentation for the variable. |
|
optimizer_switch |
string The system variable enables control over optimizer behavior. For details, see MySQL documentation for the variable |
|
optimizer_search_depth |
The maximum depth of search performed by the query optimizer For details, see MySQL documentation for the variable |
|
query_response_time_stats |
Enables and disables collection of query times For details, see Percona documentation for the variable. |
|
userstat |
Enables or disables collection of statistics For details, see Percona documentation for the variable. |
|
max_execution_time |
The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled. For details, see MySQL documentation for the variable |
MysqlConfigSet8_0
|
Field |
Description |
|
effective_config |
Effective settings for a MySQL 8.0 cluster (a combination of settings defined |
|
user_config |
User-defined settings for a MySQL 8.0 cluster. |
|
default_config |
Default configuration for a MySQL 8.0 cluster. |
MysqlConfig8_0
Options and structure of MysqlConfig8_0 reflects MySQL 8.0 configuration file.
|
Field |
Description |
|
innodb_buffer_pool_size |
Size of the InnoDB buffer pool used for caching table and index data. See MySQL documentation for details. |
|
max_connections |
The maximum permitted number of simultaneous client connections. See MySQL documentation for details. |
|
long_query_time |
Time that it takes to process a query before it is considered slow. See MySQL documentation for details. |
|
general_log |
Enable writing of general query log of MySQL. See MySQL documentation for details. |
|
audit_log |
Enable writing of audit log of MySQL. See MySQL documentation for details. |
|
sql_mode[] |
enum SQLMode Server SQL mode of MySQL. See MySQL documentation for details.
|
|
max_allowed_packet |
The maximum size in bytes of one packet. See MySQL documentation for details. |
|
default_authentication_plugin |
enum AuthPlugin Authentication plugin used in the managed MySQL cluster. See MySQL documentation for details.
|
|
innodb_flush_log_at_trx_commit |
Transaction log flush behaviour. See MySQL documentation for details. |
|
innodb_lock_wait_timeout |
Max time in seconds for a transaction to wait for a row lock. See MySQL documentation for details. |
|
transaction_isolation |
enum TransactionIsolation Default transaction isolation level. See MySQL documentation for details.
|
|
innodb_print_all_deadlocks |
Print information about deadlocks in error log. See MySQL documentation for details. |
|
net_read_timeout |
The number of seconds to wait for more data from a connection before aborting the read. See MySQL documentation for details. |
|
net_write_timeout |
The number of seconds to wait for a block to be written to a connection before aborting the write. See MySQL documentation for details. |
|
group_concat_max_len |
The maximum permitted result length in bytes for the GROUP_CONCAT() function. See MySQL documentation for details. |
|
tmp_table_size |
The maximum size of internal in-memory temporary tables. See MySQL documentation for details. |
|
max_heap_table_size |
This variable sets the maximum size to which user-created MEMORY tables are permitted to grow. See MySQL documentation for details. |
|
default_time_zone |
string The servers default time zone. See MySQL documentation for details. |
|
character_set_server |
string The servers default character set. See MySQL documentation for details. |
|
collation_server |
string The server default collation. See MySQL documentation for details. |
|
innodb_adaptive_hash_index |
Enables InnoDB adaptive hash index. See MySQL documentation for details. |
|
innodb_numa_interleave |
Enables the NUMA interleave memory policy for allocation of the InnoDB buffer pool. See MySQL documentation for details. |
|
innodb_log_buffer_size |
The size in bytes of the buffer that InnoDB uses to write to the log files on disk. See MySQL documentation for details. |
|
innodb_log_file_size |
The size in bytes of the single InnoDB Redo log file. See MySQL documentation for details. |
|
innodb_io_capacity |
Limits IO available for InnoDB background tasks. See MySQL documentation for details. |
|
innodb_io_capacity_max |
Limits IO available for InnoDB background tasks. See MySQL documentation for details. |
|
innodb_read_io_threads |
The number of I/O threads for read operations in InnoDB. See MySQL documentation for details. |
|
innodb_write_io_threads |
The number of I/O threads for write operations in InnoDB. See MySQL documentation for details. |
|
innodb_purge_threads |
The number of background threads devoted to the InnoDB purge operation. See MySQL documentation for details. |
|
innodb_thread_concurrency |
Defines the maximum number of threads permitted inside of InnoDB. See MySQL documentation for details. |
|
innodb_temp_data_file_max_size |
Limits the max size of InnoDB temp tablespace. See MySQL documentation for details. |
|
thread_cache_size |
How many threads the server should cache for reuse. See MySQL documentation for details. |
|
thread_stack |
The stack size for each thread. The default is large enough for normal operation. See MySQL documentation for details. |
|
join_buffer_size |
The minimum size of the buffer that is used for plain index scans, range index scans, and joins that do not use indexes and thus perform full table scans. See MySQL documentation for details. |
|
sort_buffer_size |
Each session that must perform a sort allocates a buffer of this size. See MySQL documentation for details. |
|
table_definition_cache |
The number of table definitions that can be stored in the definition cache. See MySQL documentation for details. |
|
table_open_cache |
The number of open tables for all threads. See MySQL documentation for details. |
|
table_open_cache_instances |
The number of open tables cache instances. See MySQL documentation for details. |
|
explicit_defaults_for_timestamp |
Determines whether the server enables certain nonstandard behaviors for default values and NULL-value handling in TIMESTAMP columns. See MySQL documentation for details. |
|
auto_increment_increment |
Can be used to control the operation of AUTO_INCREMENT columns. See MySQL documentation for details. |
|
auto_increment_offset |
Can be used to control the operation of AUTO_INCREMENT columns. See MySQL documentation for details. |
|
sync_binlog |
Controls how often the MySQL server synchronizes the binary log to disk. See MySQL documentation for details. |
|
binlog_cache_size |
The size of the cache to hold changes to the binary log during a transaction. See MySQL documentation for details. |
|
binlog_group_commit_sync_delay |
Controls how many microseconds the binary log commit waits before synchronizing the binary log file to disk. See MySQL documentation for details. |
|
binlog_row_image |
enum BinlogRowImage For MySQL row-based replication, this variable determines how row images are written to the binary log. See MySQL documentation for details.
|
|
binlog_rows_query_log_events |
When enabled, it causes the server to write informational log events such as row query log events into its binary log. See MySQL documentation for details. |
|
rpl_semi_sync_master_wait_for_slave_count |
The number of replica acknowledgments the source must receive per transaction before proceeding. See MySQL documentation for details. |
|
slave_parallel_type |
enum SlaveParallelType When using a multi-threaded replica, this variable specifies the policy used to decide which transactions are allowed to execute in parallel on the replica. See MySQL documentation for details.
|
|
slave_parallel_workers |
Sets the number of applier threads for executing replication transactions in parallel. See MySQL documentation for details. |
|
regexp_time_limit |
The time limit for regular expression matching operations performed by REGEXP_LIKE and similar functions. See MySQL documentation for details. |
|
mdb_preserve_binlog_bytes |
The size of the binary log to hold. |
|
interactive_timeout |
The number of seconds the server waits for activity on an interactive connection before closing it. See MySQL documentation for details. |
|
wait_timeout |
The number of seconds the server waits for activity on a noninteractive connection before closing it. See MySQL documentation for details. |
|
mdb_offline_mode_enable_lag |
Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = ON' to prevent users from reading stale data. |
|
mdb_offline_mode_disable_lag |
Replication lag threshold (seconds) which will switch MySQL to 'offline_mode = OFF'. |
|
range_optimizer_max_mem_size |
The limit on memory consumption for the range optimizer. See MySQL documentation for details. |
|
slow_query_log |
Manages slow query log. See MySQL documentation for details. |
|
slow_query_log_always_write_time |
Query execution time, after which query to be logged unconditionally, that is, See Percona documentation for details. |
|
log_slow_rate_type |
enum LogSlowRateType Specifies slow log granularity for See Percona documentation for details.
|
|
log_slow_rate_limit |
Specifies what fraction of session/query should be logged. Logging is enabled for every nth session/query. See Percona documentation for details. |
|
log_slow_sp_statements |
When TRUE, statements executed by stored procedures are logged to the slow log. See Percona documentation for details. |
|
log_slow_filter[] |
enum LogSlowFilterType Filters the slow log by the query's execution plan. See Percona documentation for details.
|
|
mdb_priority_choice_max_lag |
Replication lag threshold (seconds) which allows replica to be promoted to master while executing "switchover from". |
|
innodb_page_size |
Specifies the page size for InnoDB tablespaces. For details, see MySQL documentation for the variable. |
|
innodb_online_alter_log_max_size |
The limit in bytes on the size of the temporary log files used during online DDL operations See MySQL documentation for the variable for details. |
|
innodb_ft_min_token_size |
Minimum length of words that are stored in an InnoDB FULLTEXT index See MySQL documentation for the variable for details. |
|
innodb_ft_max_token_size |
Maximum length of words that are stored in an InnoDB FULLTEXT index See MySQL documentation for the variable for details. |
|
lower_case_table_names |
Table names storage and comparison strategy See MySQL documentation for the variable for details. |
|
max_sp_recursion_depth |
The number of times that any given stored procedure may be called recursively. For details, see MySQL documentation for the variable. |
|
innodb_compression_level |
The level of zlib compression to use for InnoDB compressed tables and indexes. For details, see MySQL documentation for the variable. |
|
binlog_transaction_dependency_tracking |
enum BinlogTransactionDependencyTracking Specifies how the source mysqld generates the dependency information that it writes in the binary log to help replicas determine which transactions can be executed in parallel. For details, see MySQL documentation for the variable.
|
|
autocommit |
Config specific will be all changes to a table take effect immediately or you must use COMMIT to accept a transaction or ROLLBACK to cancel it. For details, see MySQL documentation for the variable. |
|
innodb_status_output |
Enables or disables periodic output for the standard InnoDB Monitor. For details, see MySQL documentation for the variable. |
|
innodb_strict_mode |
When innodb_strict_mode is enabled, InnoDB returns errors rather than warnings when checking for invalid or incompatible table options. For details, see MySQL documentation for the variable. |
|
innodb_print_lock_wait_timeout_info |
Makes InnoDB to write information about all lock wait timeout errors into the log file. For details, see Percona documentation for the variable. |
|
log_error_verbosity |
System variable specifies the verbosity for handling events intended for the error log For details, see MySQL documentation for the variable. |
|
max_digest_length |
The maximum number of bytes of memory reserved per session for computation of normalized statement digests. For details, see MySQL documentation for the variable. |
|
lock_wait_timeout |
This variable specifies the timeout in seconds for attempts to acquire metadata locks For details, see MySQL documentation for the variable. |
|
max_prepared_stmt_count |
This variable limits the total number of prepared statements in the server. For details, see MySQL documentation for the variable. |
|
optimizer_switch |
string The system variable enables control over optimizer behavior. For details, see MySQL documentation for the variable |
|
optimizer_search_depth |
The maximum depth of search performed by the query optimizer For details, see MySQL documentation for the variable |
|
userstat |
Enables or disables collection of statistics For details, see Percona documentation for the variable. |
|
max_execution_time |
The execution timeout for SELECT statements, in milliseconds. If the value is 0, timeouts are not enabled. For details, see MySQL documentation for the variable |
Resources
Cluster resource preset.
|
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 |
|
statements_sampling_interval |
int64 Interval (in seconds) for |
MaintenanceWindow
Configuration of a maintenance window in a MySQL cluster.
|
Field |
Description |
|
anytime |
Maintenance operation can be scheduled anytime. Includes only one of the fields The maintenance policy in effect. |
|
weekly_maintenance_window |
Maintenance operation can be scheduled on a weekly basis. Includes only one of the fields The maintenance policy in effect. |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
Weelky maintenance window settings.
|
Field |
Description |
|
day |
enum WeekDay Day of the week (in
|
|
hour |
int64 Hour of the day in UTC (in |
MaintenanceOperation
A planned maintenance operation.
|
Field |
Description |
|
info |
string Information about this maintenance operation. |
|
delayed_until |
Time until which this maintenance operation is delayed. |