DBaaS Mysql

MySQL, the popular open-source, object-relational database.

Read more

create-dbaas-mysql-database

Create a DBaaS MySQL database

POST /dbaas-mysql/{service-name}/database

null

Path parameters

• service-name in path (required)

Request body

• application/json
  • database-name (required) (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-mysql-database: golang | Python | Java

CLI: exo api create-dbaas-mysql-database

delete-dbaas-mysql-database

Delete a DBaaS MySQL database

DELETE /dbaas-mysql/{service-name}/database/{database-name}

null

Path parameters

• service-name in path (required)
• database-name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-mysql-database: golang | Python | Java

CLI: exo api delete-dbaas-mysql-database

create-dbaas-mysql-user

Create a DBaaS MySQL user

POST /dbaas-mysql/{service-name}/user

null

Path parameters

• service-name in path (required)

Request body

• application/json
  • username (required) (string)
  • authentication (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-mysql-user: golang | Python | Java

CLI: exo api create-dbaas-mysql-user

delete-dbaas-mysql-user

Delete a DBaaS MySQL user

DELETE /dbaas-mysql/{service-name}/user/{username}

null

Path parameters

• service-name in path (required)
• username in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-mysql-user: golang | Python | Java

CLI: exo api delete-dbaas-mysql-user

reveal-dbaas-mysql-user-password

Reveal the secrets of a DBaaS MySQL user

GET /dbaas-mysql/{service-name}/user/{username}/password/reveal

null

Path parameters

• service-name in path (required)
• username in path (required)

Responses

• 200: 200
  • application/json
    • username (string): MySQL username
    • password (string): MySQL password

SDK reference for reveal-dbaas-mysql-user-password: golang | Python | Java

CLI: exo api reveal-dbaas-mysql-user-password

reset-dbaas-mysql-user-password

Reset the credentials of a DBaaS mysql user

PUT /dbaas-mysql/{service-name}/user/{username}/password/reset

If no password is provided one will be generated automatically.

Path parameters

• service-name in path (required)
• username in path (required)

Request body

• application/json
  • password (string)
  • authentication (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for reset-dbaas-mysql-user-password: golang | Python | Java

CLI: exo api reset-dbaas-mysql-user-password

create-dbaas-service-mysql

Create a DBaaS MySQL service

POST /dbaas-mysql/{name}

Create a DBaaS MySQL service

Path parameters

• name in path (required)

Request body

• application/json
  • backup-schedule (object) - schema details
  • integrations (array[object]): Service integrations to be enabled when creating the service. - schema details
  • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
  • termination-protection (boolean): Service is protected against termination and powering off
  • fork-from-service (string)
  • recovery-backup-time (string): ISO time of a backup to recover from for services that support arbitrary times
  • mysql-settings (object) - schema details
  • maintenance (object): Automatic maintenance settings - schema details
  • admin-username (string): Custom username for admin user. This must be set only when a new service is being created.
  • version (string): MySQL major version
  • plan (required) (string): Subscription plan
  • admin-password (string): Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.
  • migration (object): Migrate data from existing server - schema details
  • 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.

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-service-mysql: golang | Python | Java

CLI: exo api create-dbaas-service-mysql

get-dbaas-service-mysql

Get a DBaaS MySQL service

GET /dbaas-mysql/{name}

Get a DBaaS MySQL service

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • updated-at (string): Service last update timestamp (ISO 8601)
    • node-count (integer): Number of service nodes in the active plan
    • connection-info (object): MySQL connection information properties - schema details
    • backup-schedule (object): Backup schedule - schema details
    • node-cpu-count (integer): Number of CPUs for each node
    • prometheus-uri (object): Prometheus integration URI - schema details
    • integrations (array[object]): Service integrations - schema details
    • zone (string): The zone where the service is running
    • node-states (array[object]): State of individual service nodes - schema details
    • name (string)
    • type (string)
    • state (string)
    • databases (array[string]): List of MySQL databases
    • ip-filter (array[string]): Allowed CIDR address blocks for incoming connections
    • backups (array[object]): List of backups for the service - schema details
    • termination-protection (boolean): Service is protected against termination and powering off
    • notifications (array[object]): Service notifications - schema details
    • components (array[object]): Service component information objects - schema details
    • mysql-settings (object) - schema details
    • maintenance (object): Automatic maintenance settings - schema details
    • 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): Service creation timestamp (ISO 8601)
    • plan (string): Subscription plan
    • users (array[object]): List of service users - schema details

SDK reference for get-dbaas-service-mysql: golang | Python | Java

CLI: exo api get-dbaas-service-mysql

update-dbaas-service-mysql

Update a DBaaS MySQL service

PUT /dbaas-mysql/{name}

Update a DBaaS MySQL service

Path parameters

• name in path (required)

Request body

• application/json
  • maintenance (object): Automatic maintenance settings - schema details
  • plan (string): Subscription plan
  • termination-protection (boolean): Service is protected against termination and powering off
  • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
  • mysql-settings (object) - schema details
  • migration (object): Migrate data from existing server - schema details
  • 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.
  • backup-schedule (object) - schema details

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for update-dbaas-service-mysql: golang | Python | Java

CLI: exo api update-dbaas-service-mysql

delete-dbaas-service-mysql

Delete a MySQL service

DELETE /dbaas-mysql/{name}

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-service-mysql: golang | Python | Java

CLI: exo api delete-dbaas-service-mysql

Other Operations

start-dbaas-mysql-maintenance

Initiate MySQL maintenance update

PUT /dbaas-mysql/{name}/maintenance/start

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for start-dbaas-mysql-maintenance: golang | Python | Java

CLI: exo api start-dbaas-mysql-maintenance

stop-dbaas-mysql-migration

Stop a DBaaS MySQL migration

POST /dbaas-mysql/{name}/migration/stop

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for stop-dbaas-mysql-migration: golang | Python | Java

CLI: exo api stop-dbaas-mysql-migration

enable-dbaas-mysql-writes

Temporarily enable writes for MySQL services in read-only mode due to filled up storage

PUT /dbaas-mysql/{name}/enable/writes

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for enable-dbaas-mysql-writes: golang | Python | Java

CLI: exo api enable-dbaas-mysql-writes

get-dbaas-settings-mysql

Get DBaaS MySQL settings

GET /dbaas-settings-mysql

Get DBaaS MySQL settings

Responses

• 200: 200
  • application/json
    • settings (object) - schema details

SDK reference for get-dbaas-settings-mysql: golang | Python | Java

CLI: exo api get-dbaas-settings-mysql