--- title: "Get a DBaaS MySQL service" method: GET path: "/dbaas-mysql/{name}" tags: ["dbaas"] --- # Get a DBaaS MySQL service `GET /dbaas-mysql/{name}` ## Request - Base URL: `https://api-ch-gva-2.exoscale.com/v2` - URL: `https://api-ch-gva-2.exoscale.com/v2/dbaas-mysql/{name}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Get a DBaaS MySQL service ## Path parameters - `name` string, required ## Response `200` 200 - DbaasServiceMysql - `updated-at` string, date-time: Service last update timestamp (ISO 8601) - `node-count` integer: Number of service nodes in the active plan - `connection-info` object: MySQL connection information properties - `uri` string[] - `params` object[] - `standby` string[] - `backup-schedule` object: Backup schedule - `backup-hour` integer: The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed. - `backup-minute` integer: The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed. - `node-cpu-count` integer: Number of CPUs for each node - `prometheus-uri` object, required: Prometheus integration URI - `host` string - `port` integer - `integrations` DbaasIntegration[]: Service integrations - `description` string: Description of the integration - `settings` object: Integration settings - `type` string: Integration type - `is-enabled` boolean: Whether the integration is enabled or not - `source` string: Source service name - `is-active` boolean: Whether the integration is active or not - `status` string: Integration status - `id` string, uuid: Integration id - `dest` string: Destination service name - `zone` string: The zone where the service is running - `node-states` DbaasNodeState[]: State of individual service nodes - `name` string, required: Name of the service node - `progress-updates` DbaasNodeStateProgressUpdate[]: Extra information regarding the progress for current state - `completed` boolean, required: Indicates whether this phase has been completed or not - `current` integer: Current progress for this phase. May be missing or null. - `max` integer: Maximum progress value for this phase. May be missing or null. May change. - `min` integer: Minimum progress value for this phase. May be missing or null. - `phase` 'stream' | 'basebackup' | 'prepare' | 'finalize', required: Key identifying this phase - `unit` string: Unit for current/min/max values. New units may be added. If null should be treated as generic unit - `role` 'standby' | 'master' | 'read-replica': Role of this node. Only returned for a subset of service types - `state` 'leaving' | 'running' | 'syncing_data' | 'setting_up_vm' | 'unknown', required: Current state of the service node - `name` string, required - `type` string, required - `state` 'running' | 'rebuilding' | 'rebalancing' | 'poweroff' - `databases` DbaasMysqlDatabaseName[]: List of MySQL databases - `ip-filter` string[]: Allowed CIDR address blocks for incoming connections - `backups` DbaasServiceBackup[]: List of backups for the service - `backup-name` string, required: Internal name of this backup - `backup-time` string, date-time, required: Backup timestamp (ISO 8601) - `data-size` integer, required: Backup's original size before compression - `termination-protection` boolean: Service is protected against termination and powering off - `notifications` DbaasServiceNotification[]: Service notifications - `level` 'warning' | 'notice', required: Notification level - `message` string, required: Human notification message - `type` 'service_powered_off_removal' | 'service_end_of_life', required: Notification type - `metadata` object, required: Notification type - `components` object[]: Service component information objects - `component` string, required: Service component name - `host` string, required: DNS name for connecting to the service component - `port` integer, required: Port number for connecting to the service component - `route` 'dynamic' | 'private' | 'public' | 'privatelink', required - `usage` 'primary' | 'replica', required - `mysql-settings` JsonSchemaMysql - `net_write_timeout` integer: The number of seconds to wait for a block to be written to a connection before aborting the write. - `internal_tmp_mem_storage_engine` 'TempTable' | 'MEMORY': The storage engine for in-memory internal temporary tables. - `sql_mode` string: Global SQL mode. Set to empty to use MySQL server defaults. When creating a new service and not setting this field Aiven default SQL mode (strict, SQL standard compliant) will be assigned. - `information_schema_stats_expiry` integer: The time, in seconds, before cached statistics expire - `sort_buffer_size` integer: Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K) - `innodb_thread_concurrency` integer: Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit) - `innodb_write_io_threads` integer: The number of I/O threads for write operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service. - `innodb_ft_min_token_size` integer: Minimum length of words that are stored in an InnoDB FULLTEXT index. Changing this parameter will lead to a restart of the MySQL service. - `innodb_change_buffer_max_size` integer: Maximum size for the InnoDB change buffer, as a percentage of the total size of the buffer pool. Default is 25 - `innodb_flush_neighbors` integer: Specifies whether flushing a page from the InnoDB buffer pool also flushes other dirty pages in the same extent (default is 1): 0 - dirty pages in the same extent are not flushed, 1 - flush contiguous dirty pages in the same extent, 2 - flush dirty pages in the same extent - `tmp_table_size` integer: Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M) - `slow_query_log` boolean: Slow query log enables capturing of slow queries. Setting slow_query_log to false also truncates the mysql.slow_log table. Default is off - `connect_timeout` integer: The number of seconds that the mysqld server waits for a connect packet before responding with Bad handshake - `log_output` 'INSIGHTS' | 'INSIGHTS,TABLE' | 'NONE' | 'TABLE': The slow log output destination when slow_query_log is ON. To enable MySQL AI Insights, choose INSIGHTS. To use MySQL AI Insights and the mysql.slow_log table at the same time, choose INSIGHTS,TABLE. To only use the mysql.slow_log table, choose TABLE. To silence slow logs, choose NONE. - `net_read_timeout` integer: The number of seconds to wait for more data from a connection before aborting the read. - `innodb_lock_wait_timeout` integer: The length of time in seconds an InnoDB transaction waits for a row lock before giving up. Default is 120. - `wait_timeout` integer: The number of seconds the server waits for activity on a noninteractive connection before closing it. - `innodb_rollback_on_timeout` boolean: When enabled a transaction timeout causes InnoDB to abort and roll back the entire transaction. Changing this parameter will lead to a restart of the MySQL service. - `group_concat_max_len` integer: The maximum permitted result length in bytes for the GROUP_CONCAT() function. - `net_buffer_length` integer: Start sizes of connection buffer and result buffer. Default is 16384 (16K). Changing this parameter will lead to a restart of the MySQL service. - `innodb_print_all_deadlocks` boolean: When enabled, information about all deadlocks in InnoDB user transactions is recorded in the error log. Disabled by default. - `innodb_online_alter_log_max_size` integer: The upper limit in bytes on the size of the temporary log files used during online DDL operations for InnoDB tables. - `interactive_timeout` integer: The number of seconds the server waits for activity on an interactive connection before closing it. - `innodb_log_buffer_size` integer: The size in bytes of the buffer that InnoDB uses to write to the log files on disk. - `max_allowed_packet` integer: Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M) - `max_heap_table_size` integer: Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M) - `innodb_ft_server_stopword_table` string, nullable: This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables. - `innodb_read_io_threads` integer: The number of I/O threads for read operations in InnoDB. Default is 4. Changing this parameter will lead to a restart of the MySQL service. - `sql_require_primary_key` boolean: Require primary key to be defined for new tables or old tables modified with ALTER TABLE and fail if missing. It is recommended to always have primary keys because various functionality may break if any large table is missing them. - `default_time_zone` string: Default server time zone as an offset from UTC (from -12:00 to +12:00), a time zone name, or 'SYSTEM' to use the MySQL server default. - `long_query_time` number: The slow_query_logs work as SQL statements that take more than long_query_time seconds to execute. Default is 10s - `maintenance` DbaasServiceMaintenance: Automatic maintenance settings - `dow` 'saturday' | 'tuesday' | 'never' | 'wednesday' | 'sunday' | 'friday' | 'monday' | 'thursday', required: Day of week for installing updates - `time` string, required: Time for installing updates, UTC - `updates` DbaasServiceUpdate[], required: List of updates waiting to be installed - `description` string: Description of the update - `deadline` string, date-time: Deadline for installing the update - `start-after` string, date-time: The earliest time the update will be automatically applied - `start-at` string, date-time: The time when the update will be automatically applied - `disk-size` integer: TODO UNIT disk space for data storage - `node-memory` integer: TODO UNIT of memory for each node - `uri` string: URI for connecting to the service (may be absent) - `uri-params` object: service_uri parameterized into key-value pairs - `version` string: MySQL version - `created-at` string, date-time: Service creation timestamp (ISO 8601) - `plan` string, required: Subscription plan - `users` object[]: List of service users - `type` string - `username` string - `password` string - `authentication` string - `binlog-retention-period` integer: The minimum amount of time in seconds to keep binlog entries before deletion. This may be extended for services that require binlog entries for longer than the default for example if using the MySQL Debezium Kafka connector. ## Changes - **2026-11-06** `63da6f74c845`: 1 info - added the optional property `binlog-retention-period` to the response with the `200` status - **2025-05-22** `37a05010e8b4`: 1 info - added the required property `prometheus-uri` to the response with the `200` status - **2024-09-18** `eae1143f1c63`: 1 info - added the optional property `mysql-settings/log_output` to the response with the `200` status - **2024-05-22** `d1903c399d90`: 1 info - the `mysql-settings/default_time_zone` response's property pattern `^([-+][\d:]*|[\w/]*)$` was added for the status `200` - **2023-12-08** `ec6a2a6bc1c1`: 30 info - added the optional property `mysql-settings/connect_timeout` to the response with the `200` status - added the optional property `mysql-settings/default_time_zone` to the response with the `200` status - added the optional property `mysql-settings/group_concat_max_len` to the response with the `200` status - added the optional property `mysql-settings/information_schema_stats_expiry` to the response with the `200` status - …26 more [Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/dbaas-mysql/:name/get.md) --- [API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)