Get a DBaaS Kafka service

GET /dbaas-kafka/{name}

Path parameters

  • name string Required

    Service name

    Minimum length is 0, maximum length is 63.

Responses

  • • 200 object

    200

    • updated-at string(date-time)

      Service last update timestamp (ISO 8601)

    • authentication-methods object

      Kafka authentication methods

      • certificate boolean

        Whether certificate/SSL authentication is enabled

      • sasl boolean

        Whether SASL authentication is enabled

    • node-count integer(int64)

      Number of service nodes in the active plan

      Minimum value is 0.

    • connection-info object

      Kafka connection information properties

    • node-cpu-count integer(int64)

      Number of CPUs for each node

      Minimum value is 0.

    • kafka-rest-enabled boolean

      Whether Kafka REST is enabled

    • integrations array[object]

      Service integrations

    • zone string

      The zone where the service is running

    • node-states array[object]

      Automatic maintenance settings

      • name string Required

        Name of the service node

      • progress-updates array[object]

        Extra information regarding the progress for current state

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

    • kafka-connect-enabled boolean

      Whether Kafka Connect is enabled

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

    • ip-filter array[string]

      Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

    • schema-registry-settings object

      Schema Registry configuration

    • backups array[object]

      List of backups for the service

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

    • kafka-rest-settings object

      Kafka REST configuration

    • termination-protection boolean

      Service is protected against termination and powering off

    • notifications array[object]

      Service notifications

      • 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

    • kafka-connect-settings object

      Kafka Connect configuration values

    • components array[object]

      Service component information objects

      • component string Required

        Service component name

      • host string Required

        DNS name for connecting to the service component

      • kafka-authentication-method string

        Kafka authentication method. This is a value specific to the 'kafka' service component

        Values are certificate or sasl.

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

    • maintenance object

      Automatic maintenance settings

      • 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

        • 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

    • kafka-settings object

      Kafka-specific settings

    • 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

    • schema-registry-enabled boolean

      Whether Schema-Registry is enabled

    • version string

      Kafka version

    • created-at string(date-time)

      Service creation timestamp (ISO 8601)

    • plan string Required

      Subscription plan

    • users array[object]

      List of service users

GET /dbaas-kafka/{name} 
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/dbaas-kafka/{name}
Response example (200) 
{
  "updated-at": "2023-05-04T09:42:00+00:00",
  "authentication-methods": {
    "certificate": true,
    "sasl": true
  },
  "node-count": 42,
  "connection-info": {
    "nodes": [
      "string"
    ],
    "access-cert": "string",
    "access-key": "string",
    "connect-uri": "string",
    "rest-uri": "string",
    "registry-uri": "string"
  },
  "node-cpu-count": 42,
  "kafka-rest-enabled": true,
  "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",
  "kafka-connect-enabled": true,
  "type": "string",
  "state": "running",
  "ip-filter": [
    "string"
  ],
  "schema-registry-settings": {},
  "backups": [
    {
      "backup-name": "string",
      "backup-time": "2023-05-04T09:42:00+00:00",
      "data-size": 42
    }
  ],
  "kafka-rest-settings": {},
  "termination-protection": true,
  "notifications": [
    {
      "level": "warning",
      "message": "string",
      "type": "service_powered_off_removal",
      "metadata": {}
    }
  ],
  "kafka-connect-settings": {},
  "components": [
    {
      "component": "string",
      "host": "string",
      "kafka-authentication-method": "certificate",
      "port": 42,
      "route": "dynamic",
      "usage": "primary"
    }
  ],
  "maintenance": {
    "dow": "saturday",
    "time": "string",
    "updates": [
      {
        "description": "string",
        "deadline": "2023-05-04T09:42:00+00:00",
        "start-after": "2023-05-04T09:42:00+00:00",
        "start-at": "2023-05-04T09:42:00+00:00"
      }
    ]
  },
  "kafka-settings": {},
  "disk-size": 42,
  "node-memory": 42,
  "uri": "string",
  "uri-params": {},
  "schema-registry-enabled": true,
  "version": "string",
  "created-at": "2023-05-04T09:42:00+00:00",
  "plan": "string",
  "users": [
    {
      "type": "string",
      "username": "string",
      "password": "string",
      "access-cert": "string",
      "access-cert-expiry": "2023-05-04T09:42:00+00:00",
      "access-key": "string"
    }
  ]
}