List DBaaS services

GET /dbaas-service

List DBaaS services


  • 200 application/json


    Hide response attribute Show response attribute object
    • dbaas-services array[object]
      Hide dbaas-services attributes Show dbaas-services 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.

      • 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

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

      • 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

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

      • created-at string(date-time)

        Service creation timestamp (ISO 8601)

      • plan string Required

        Subscription plan

GET /dbaas-service
curl \
Response examples (200)
  "dbaas-services": [
      "updated-at": "2024-05-04T09:42:00+00:00",
      "node-count": 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",
      "name": "string",
      "type": "string",
      "state": "running",
      "termination-protection": true,
      "notifications": [
          "level": "warning",
          "message": "string",
          "type": "service_powered_off_removal",
          "metadata": {}
      "disk-size": 42,
      "node-memory": 42,
      "created-at": "2024-05-04T09:42:00+00:00",
      "plan": "string"