Get a DBaaS MySQL service

GET /dbaas-mysql/{name}

Get a DBaaS MySQL service

Path parameters

  • name string Required

    Service name

    Minimum length is 0, maximum length is 63.

Responses

  • • 200 application/json

    200

    Hide response attributes Show response attributes object
    • updated-at string(date-time)

      Service last update timestamp (ISO 8601)

    • node-count integer(int64)

      Number of service nodes in the active plan

      Minimum value is 0.

    • connection-info object

      MySQL connection information properties

      Hide connection-info attributes Show connection-info attributes
    • backup-schedule object

      Backup schedule

      Hide backup-schedule attributes Show backup-schedule attributes
      • backup-hour integer(int64)

        The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.

        Minimum value is 0, maximum value is 23.

      • backup-minute integer(int64)

        The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.

        Minimum value is 0, maximum value is 59.

    • node-cpu-count integer(int64)

      Number of CPUs for each node

      Minimum value is 0.

    • integrations array[object]

      Service integrations

      Hide integrations attributes Show integrations attributes object
    • zone string

      The zone where the service is running

    • node-states array[object]

      Automatic maintenance settings

      Hide node-states attributes Show node-states attributes object
      • name string Required

        Name of the service node

      • progress-updates array[object]

        Extra information regarding the progress for current state

        Hide progress-updates attributes Show progress-updates attributes object
        • completed boolean Required

          Indicates whether this phase has been completed or not

        • current integer(int64)

          Current progress for this phase. May be missing or null.

          Minimum value is 0.

        • max integer(int64)

          Maximum progress value for this phase. May be missing or null. May change.

          Minimum value is 0.

        • min integer(int64)

          Minimum progress value for this phase. May be missing or null.

          Minimum value is 0.

        • phase string Required

          Key identifying this phase

          Values are stream, basebackup, prepare, or finalize.

        • unit string

          Unit for current/min/max values. New units may be added. If null should be treated as generic unit

      • role string

        Role of this node. Only returned for a subset of service types

        Values are standby, master, or read-replica.

      • state string Required

        Current state of the service node

        Values are leaving, running, syncing_data, setting_up_vm, or unknown.

    • name string Required

      Service name

      Minimum length is 0, maximum length is 63.

    • type string Required

      DbaaS service name

      Minimum length is 0, maximum length is 64.

    • state string

      State of the service

      Values are running, rebuilding, rebalancing, or poweroff.

    • databases array[string]

      List of MySQL databases

      Minimum length of each is 1, maximum length of each is 64.

    • ip-filter array[string]

      Allowed CIDR address blocks for incoming connections

    • backups array[object]

      List of backups for the service

      Hide backups attributes Show backups attributes object
      • backup-name string Required

        Internal name of this backup

      • backup-time string(date-time) Required

        Backup timestamp (ISO 8601)

      • data-size integer(int64) Required

        Backup's original size before compression

        Minimum value is 0.

    • termination-protection boolean

      Service is protected against termination and powering off

    • notifications array[object]

      Service notifications

      Hide notifications attributes Show notifications attributes object
      • level string Required

        Notification level

        Values are warning or notice.

      • message string Required

        Human notification message

        Minimum length is 1, maximum length is 1024.

      • type string Required

        Notification type

        Values are service_powered_off_removal or service_end_of_life.

      • metadata object Required

        Notification type

    • components array[object]

      Service component information objects

      Hide components attributes Show components attributes object
      • component string Required

        Service component name

      • host string Required

        DNS name for connecting to the service component

      • port integer(int64) Required

        Port number for connecting to the service component

        Minimum value is 0, maximum value is 65535.

      • route string Required

        Network access route

        Values are dynamic, private, public, or privatelink.

      • usage string Required

        DNS usage name

        Values are primary or replica.

    • mysql-settings object

      MySQL-specific settings

      Hide mysql-settings attributes Show mysql-settings attributes
      • net_write_timeout integer

        The number of seconds to wait for a block to be written to a connection before aborting the write.

        Minimum value is 1, maximum value is 3600.

      • internal_tmp_mem_storage_engine string

        The storage engine for in-memory internal temporary tables.

        Values are TempTable or MEMORY.

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

        Maximum length is 1024. Format should match the following pattern: ^[A-Z_]*(,[A-Z_]+)*$.

      • information_schema_stats_expiry integer

        The time, in seconds, before cached statistics expire

        Minimum value is 900, maximum value is 31536000.

      • sort_buffer_size integer

        Sort buffer size in bytes for ORDER BY optimization. Default is 262144 (256K)

        Minimum value is 32768, maximum value is 1073741824.

      • innodb_thread_concurrency integer

        Defines the maximum number of threads permitted inside of InnoDB. Default is 0 (infinite concurrency - no limit)

        Minimum value is 0, maximum value is 1000.

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

        Minimum value is 1, maximum value is 64.

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

        Minimum value is 0, maximum value is 16.

      • 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

        Minimum value is 0, maximum value is 50.

      • 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

        Minimum value is 0, maximum value is 2.

      • tmp_table_size integer

        Limits the size of internal in-memory tables. Also set max_heap_table_size. Default is 16777216 (16M)

        Minimum value is 1048576, maximum value is 1073741824.

      • 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

        Minimum value is 2, maximum value is 3600.

      • net_read_timeout integer

        The number of seconds to wait for more data from a connection before aborting the read.

        Minimum value is 1, maximum value is 3600.

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

        Minimum value is 1, maximum value is 3600.

      • wait_timeout integer

        The number of seconds the server waits for activity on a noninteractive connection before closing it.

        Minimum value is 1, maximum value is 2147483.

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

        Minimum value is 4, maximum value is 18446744073709551615.

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

        Minimum value is 1024, maximum value is 1048576.

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

        Minimum value is 65536, maximum value is 1099511627776.

      • interactive_timeout integer

        The number of seconds the server waits for activity on an interactive connection before closing it.

        Minimum value is 30, maximum value is 604800.

      • innodb_log_buffer_size integer

        The size in bytes of the buffer that InnoDB uses to write to the log files on disk.

        Minimum value is 1048576, maximum value is 4294967295.

      • max_allowed_packet integer

        Size of the largest message in bytes that can be received by the server. Default is 67108864 (64M)

        Minimum value is 102400, maximum value is 1073741824.

      • max_heap_table_size integer

        Limits the size of internal in-memory tables. Also set tmp_table_size. Default is 16777216 (16M)

        Minimum value is 1048576, maximum value is 1073741824.

      • innodb_ft_server_stopword_table string | null

        This option is used to specify your own InnoDB FULLTEXT index stopword list for all InnoDB tables.

        Maximum length is 1024. Format should match the following pattern: ^.+/.+$.

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

        Minimum value is 1, maximum value is 64.

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

        Minimum length is 2, maximum length is 100.

      • 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

        Minimum value is 0.0, maximum value is 3600.

      • Additional properties are NOT allowed
    • maintenance object

      Automatic maintenance settings

      Hide maintenance attributes Show maintenance attributes
      • dow string Required

        Day of week for installing updates

        Values are saturday, tuesday, never, wednesday, sunday, friday, monday, or thursday.

      • time string Required

        Time for installing updates, UTC

        Minimum length is 8, maximum length is 8.

      • updates array[object] Required

        Update waiting to be installed

        Hide updates attributes Show updates attributes object
        • 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(int64)

      TODO UNIT disk space for data storage

      Minimum value is 0.

    • node-memory integer(int64)

      TODO UNIT of memory for each node

      Minimum value is 0.

    • 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 array[object]

      List of service users

      Hide users attributes Show users attributes object
GET /dbaas-mysql/{name} 
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/dbaas-mysql/{name}
Response examples (200) 
{
  "updated-at": "2024-05-04T09:42:00+00:00",
  "node-count": 42,
  "connection-info": {
    "uri": [
      "string"
    ],
    "params": [
      {}
    ],
    "standby": [
      "string"
    ]
  },
  "backup-schedule": {
    "backup-hour": 42,
    "backup-minute": 42
  },
  "node-cpu-count": 42,
  "integrations": [
    {
      "description": "string",
      "settings": {},
      "type": "string",
      "is-enabled": true,
      "source": "string",
      "is-active": true,
      "status": "string",
      "id": "string",
      "dest": "string"
    }
  ],
  "zone": "string",
  "node-states": [
    {
      "name": "string",
      "progress-updates": [
        {
          "completed": true,
          "current": 42,
          "max": 42,
          "min": 42,
          "phase": "stream",
          "unit": "string"
        }
      ],
      "role": "standby",
      "state": "leaving"
    }
  ],
  "name": "string",
  "type": "string",
  "state": "running",
  "databases": [
    "string"
  ],
  "ip-filter": [
    "string"
  ],
  "backups": [
    {
      "backup-name": "string",
      "backup-time": "2024-05-04T09:42:00+00:00",
      "data-size": 42
    }
  ],
  "termination-protection": true,
  "notifications": [
    {
      "level": "warning",
      "message": "string",
      "type": "service_powered_off_removal",
      "metadata": {}
    }
  ],
  "components": [
    {
      "component": "string",
      "host": "string",
      "port": 42,
      "route": "dynamic",
      "usage": "primary"
    }
  ],
  "mysql-settings": {
    "net_write_timeout": 30,
    "internal_tmp_mem_storage_engine": "TempTable",
    "sql_mode": "ANSI,TRADITIONAL",
    "information_schema_stats_expiry": 86400,
    "sort_buffer_size": 262144,
    "innodb_thread_concurrency": 10,
    "innodb_write_io_threads": 10,
    "innodb_ft_min_token_size": 3,
    "innodb_change_buffer_max_size": 30,
    "innodb_flush_neighbors": 0,
    "tmp_table_size": 16777216,
    "slow_query_log": true,
    "connect_timeout": 10,
    "net_read_timeout": 30,
    "innodb_lock_wait_timeout": 50,
    "wait_timeout": 28800,
    "innodb_rollback_on_timeout": true,
    "group_concat_max_len": 1024,
    "net_buffer_length": 16384,
    "innodb_print_all_deadlocks": true,
    "innodb_online_alter_log_max_size": 134217728,
    "interactive_timeout": 3600,
    "innodb_log_buffer_size": 16777216,
    "max_allowed_packet": 67108864,
    "max_heap_table_size": 16777216,
    "innodb_ft_server_stopword_table": "db_name/table_name",
    "innodb_read_io_threads": 10,
    "sql_require_primary_key": true,
    "default_time_zone": "+03:00",
    "long_query_time": 10
  },
  "maintenance": {
    "dow": "saturday",
    "time": "string",
    "updates": [
      {
        "description": "string",
        "deadline": "2024-05-04T09:42:00+00:00",
        "start-after": "2024-05-04T09:42:00+00:00",
        "start-at": "2024-05-04T09:42:00+00:00"
      }
    ]
  },
  "disk-size": 42,
  "node-memory": 42,
  "uri": "string",
  "uri-params": {},
  "version": "string",
  "created-at": "2024-05-04T09:42:00+00:00",
  "plan": "string",
  "users": [
    {
      "type": "string",
      "username": "string",
      "password": "string",
      "authentication": "string"
    }
  ]
}