# DBaaS Service Mysql

## Properties

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | **yes** | Service name<br/><br/>Min length: `0`. Max length: `63`. |
| `plan` | string | **yes** | Subscription plan |
| `prometheus-uri` | [Prometheus URI](/reference/api/_schemas/dbaas-service-mysql/#prometheus-uri) | **yes** | Prometheus integration URI |
| `type` | string | **yes** | Service type code<br/><br/>Min length: `0`. Max length: `64`. |
| `backup-schedule` | [Backup Schedule](/reference/api/_schemas/dbaas-service-mysql/#backup-schedule) | no | Backup schedule |
| `backups` | array of [List of backups for the service](/reference/api/_schemas/dbaas-service-backup/) | no | List of backups for the service |
| `binlog-retention-period` | integer | no | 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.<br/><br/>Min: `0`. |
| `components` | array of [Components](/reference/api/_schemas/dbaas-service-mysql/#components) | no | Service component information objects |
| `connection-info` | [Connection Info](/reference/api/_schemas/dbaas-service-mysql/#connection-info) | no | MySQL connection information properties |
| `created-at` | string | no | Service creation timestamp (ISO 8601)<br/><br/>ISO 8601 date-time. |
| `databases` | array of [DBaaS Mysql Database Name](/reference/api/_schemas/dbaas-mysql-database-name/) | no | List of MySQL databases |
| `disk-size` | integer | no | TODO UNIT disk space for data storage<br/><br/>Min: `0`. |
| `integrations` | array of [DBaaS Integration](/reference/api/_schemas/dbaas-integration/) | no | Service integrations |
| `ip-filter` | array[string] | no | Allowed CIDR address blocks for incoming connections |
| `maintenance` | [Automatic maintenance settings](/reference/api/_schemas/dbaas-service-maintenance/) | no | Automatic maintenance settings |
| `mysql-settings` | [mysql.conf configuration values](/reference/api/_schemas/json-schema-mysql/) | no | MySQL-specific settings |
| `node-count` | integer | no | Number of service nodes in the active plan<br/><br/>Min: `0`. |
| `node-cpu-count` | integer | no | Number of CPUs for each node<br/><br/>Min: `0`. |
| `node-memory` | integer | no | TODO UNIT of memory for each node<br/><br/>Min: `0`. |
| `node-states` | array of [Automatic maintenance settings](/reference/api/_schemas/dbaas-node-state/) | no | State of individual service nodes |
| `notifications` | array of [Service notifications](/reference/api/_schemas/dbaas-service-notification/) | no | Service notifications |
| `state` | string | no | State of the service<br/><br/>Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`. |
| `termination-protection` | boolean | no | Service is protected against termination and powering off |
| `updated-at` | string | no | Service last update timestamp (ISO 8601)<br/><br/>ISO 8601 date-time. |
| `uri` | string | no | URI for connecting to the service (may be absent) |
| `uri-params` | object | no | service_uri parameterized into key-value pairs |
| `users` | array of [Users](/reference/api/_schemas/dbaas-service-mysql/#users) | no | List of service users |
| `version` | string | no | MySQL version |
| `zone` | string | no | The zone where the service is running |

### Connection Info {#connection-info}

MySQL connection information properties

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | array of [Params](/reference/api/_schemas/dbaas-service-mysql/#params) | no |  |
| `standby` | array[string] | no |  |
| `uri` | array[string] | no |  |

### Backup Schedule {#backup-schedule}

Backup schedule

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `backup-hour` | integer | no | The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.<br/><br/>Min: `0`. Max: `23`. |
| `backup-minute` | integer | no | The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.<br/><br/>Min: `0`. Max: `59`. |

### Prometheus URI {#prometheus-uri}

Prometheus integration URI

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `host` | string | no |  |
| `port` | integer | no | Min: `0`. Max: `65535`. |

### Components {#components}

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `component` | string | **yes** | Service component name |
| `host` | string | **yes** | DNS name for connecting to the service component |
| `port` | integer | **yes** | Port number for connecting to the service component<br/><br/>Min: `0`. Max: `65535`. |
| `route` | string | **yes** | Network access route<br/><br/>Allowed values: `dynamic`, `private`, `public`, `privatelink`. |
| `usage` | string | **yes** | DNS usage name<br/><br/>Allowed values: `primary`, `replica`. |

### Users {#users}

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `authentication` | string | no |  |
| `password` | string | no |  |
| `type` | string | no |  |
| `username` | string | no |  |