DBaaS Management

Operational management for DBaaS services: logs, metrics, service types and lifecycle.

Read more

create-dbaas-integration

POST /dbaas-integration

[BETA] Create a new DBaaS integration between two services

Request body

• application/json
  • integration-type (required) (string)
  • source-service (required) (string)
  • dest-service (required) (string)
  • settings (object): Integration settings

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-integration: golang | Python | Java

CLI: exo api create-dbaas-integration

get-dbaas-integration

GET /dbaas-integration/{id}

[BETA] Get a DBaaS Integration

Path parameters

• id in path (required)

Responses

• 200: 200
  • application/json
    • 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): Integration id
    • dest (string): Destination service name

SDK reference for get-dbaas-integration: golang | Python | Java

CLI: exo api get-dbaas-integration

update-dbaas-integration

PUT /dbaas-integration/{id}

[BETA] Update a existing DBaaS integration

Path parameters

• id in path (required)

Request body

• application/json
  • settings (required) (object): Integration settings

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-integration: golang | Python | Java

CLI: exo api update-dbaas-integration

delete-dbaas-integration

DELETE /dbaas-integration/{id}

[BETA] Delete a DBaaS Integration

Path parameters

• id 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-integration: golang | Python | Java

CLI: exo api delete-dbaas-integration

Other Operations

get-dbaas-ca-certificate

Get DBaaS CA Certificate

GET /dbaas-ca-certificate

Returns a CA Certificate required to reach a DBaaS service through a TLS-protected connection.

Responses

• 200: 200
  • application/json
    • certificate (string)

SDK reference for get-dbaas-ca-certificate: golang | Python | Java

CLI: exo api get-dbaas-ca-certificate

get-dbaas-external-integration

GET /dbaas-external-integration/{integration-id}

[BETA] Get a DBaaS external integration

Path parameters

• integration-id in path (required)

Responses

• 200: 200
  • application/json
    • description (string): Description of the integration
    • dest-endpoint-name (string): External destination endpoint name
    • dest-endpoint-id (string): External destination endpoint id
    • integration-id (string): Endpoint integration UUID
    • status (string): Integration status
    • source-service-name (string): DBaaS source service name
    • source-service-type (string)
    • type (string)

SDK reference for get-dbaas-external-integration: golang | Python | Java

CLI: exo api get-dbaas-external-integration

list-dbaas-external-integrations

GET /dbaas-external-integrations/{service-name}

[BETA] List all DBaaS connections between services and external endpoints

Path parameters

• service-name in path (required)

Responses

• 200: 200
  • application/json
    • external-integrations (array[object]) - schema details

SDK reference for list-dbaas-external-integrations: golang | Python | Java

CLI: exo api list-dbaas-external-integrations

list-dbaas-integration-settings

GET /dbaas-integration-settings/{integration-type}/{source-type}/{dest-type}

[BETA] Get DBaaS integration settings

Path parameters

• integration-type in path (required)
• source-type in path (required)
• dest-type in path (required)

Responses

• 200: 200
  • application/json
    • settings (object): The JSON schema representing the settings for the given integration type, source, and destination service types. - schema details

SDK reference for list-dbaas-integration-settings: golang | Python | Java

CLI: exo api list-dbaas-integration-settings

list-dbaas-integration-types

GET /dbaas-integration-types

[BETA] Get DBaaS integration types

Responses

• 200: 200
  • application/json
    • dbaas-integration-types (array[object]) - schema details

SDK reference for list-dbaas-integration-types: golang | Python | Java

CLI: exo api list-dbaas-integration-types

get-dbaas-migration-status

Get a DBaaS migration status

GET /dbaas-migration-status/{name}

Get a DBaaS migration status

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • error (string): Error message in case that migration has failed
    • method (string): Migration method. Empty in case of multiple methods or error
    • status (string): Migration status
    • details (array[object]): Migration status per database - schema details

SDK reference for get-dbaas-migration-status: golang | Python | Java

CLI: exo api get-dbaas-migration-status

delete-dbaas-service

Delete a DBaaS service

DELETE /dbaas-service/{name}

Delete a DBaaS service

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: golang | Python | Java

CLI: exo api delete-dbaas-service

detach-dbaas-service-from-endpoint

PUT /dbaas-external-endpoint/{source-service-name}/detach

[BETA] Detach a DBaaS external integration from a service

Path parameters

• source-service-name in path (required)

Request body

• application/json
  • integration-id (required) (string): External Integration ID

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 detach-dbaas-service-from-endpoint: golang | Python | Java

CLI: exo api detach-dbaas-service-from-endpoint

get-dbaas-service-logs

Get logs of DBaaS service

POST /dbaas-service-logs/{service-name}

Get logs of DBaaS service

Path parameters

• service-name in path (required)

Request body

• application/json
  • limit (integer): How many log entries to receive at most, up to 500 (default: 100)
  • sort-order (string)
  • offset (string): Opaque offset identifier

Responses

• 200: 200
  • application/json
    • offset (string)
    • first-log-offset (string)
    • logs (array[object]) - schema details

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

CLI: exo api get-dbaas-service-logs

get-dbaas-service-metrics

Get metrics of DBaaS service

POST /dbaas-service-metrics/{service-name}

Get metrics of DBaaS service

Path parameters

• service-name in path (required)

Request body

• application/json
  • period (string): Metrics time period (default: hour)

Responses

• 200: 200
  • application/json
    • metrics (object)

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

CLI: exo api get-dbaas-service-metrics

attach-dbaas-service-to-endpoint

PUT /dbaas-external-endpoint/{source-service-name}/attach

[BETA] Create a new DBaaS connection between a DBaaS service and an external service

Path parameters

• source-service-name in path (required)

Request body

• application/json
  • dest-endpoint-id (required) (string): External endpoint id
  • type (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 attach-dbaas-service-to-endpoint: golang | Python | Java

CLI: exo api attach-dbaas-service-to-endpoint

get-dbaas-service-type

Get a DBaaS service type

GET /dbaas-service-type/{service-type-name}

Get a DBaaS service type

Path parameters

• service-type-name in path (required)

Responses

• 200: 200
  • application/json
    • name (string)
    • available-versions (array[string]): DbaaS service available versions
    • default-version (string): DbaaS service default version
    • description (string): DbaaS service description
    • plans (array[object]): DbaaS service plans - schema details

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

CLI: exo api get-dbaas-service-type

list-dbaas-service-types

DBaaS Service Types

GET /dbaas-service-type

List available service types for DBaaS

Responses

• 200: 200
  • application/json
    • dbaas-service-types (array[object]) - schema details

SDK reference for list-dbaas-service-types: golang | Python | Java

CLI: exo api list-dbaas-service-types

list-dbaas-services

List DBaaS services

GET /dbaas-service

List DBaaS services

Responses

• 200: 200
  • application/json
    • dbaas-services (array[object]) - schema details

SDK reference for list-dbaas-services: golang | Python | Java

CLI: exo api list-dbaas-services

get-dbaas-task

Get a DBaaS task

GET /dbaas-task/{service}/{id}

Get a DBaaS task

Path parameters

• service in path (required)
• id in path (required)

Responses

• 200: 200
  • application/json
    • id (string)
    • create-time (string)
    • result (string)
    • result-codes (array[object]) - schema details
    • success (boolean)
    • task-type (string)

SDK reference for get-dbaas-task: golang | Python | Java

CLI: exo api get-dbaas-task

create-dbaas-task-migration-check

POST /dbaas-task-migration-check/{service}

Create a DBaaS task to check migration

Path parameters

• service in path (required)

Request body

• application/json
  • source-service-uri (required) (string): Service URI of the source MySQL or PostgreSQL database with admin credentials.
  • method (string)
  • ignore-dbs (string): Comma-separated list of databases, which should be ignored during migration (supported by MySQL only at the moment)

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-task-migration-check: golang | Python | Java

CLI: exo api create-dbaas-task-migration-check