--- title: "Get a DBaaS Kafka service" method: GET path: "/dbaas-kafka/{name}" tags: ["dbaas"] --- # Get a DBaaS Kafka service `GET /dbaas-kafka/{name}` ## Request - Base URL: `https://api-ch-gva-2.exoscale.com/v2` - URL: `https://api-ch-gva-2.exoscale.com/v2/dbaas-kafka/{name}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `name` string, required ## Response `200` 200 - DbaasServiceKafka - `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: Number of service nodes in the active plan - `connection-info` object: Kafka connection information properties - `nodes` string[] - `access-cert` string - `access-key` string - `connect-uri` string - `rest-uri` string - `registry-uri` string - `node-cpu-count` integer: Number of CPUs for each node - `kafka-rest-enabled` boolean: Whether Kafka REST is enabled - `prometheus-uri` object, required: Prometheus integration URI - `host` string - `port` integer - `integrations` DbaasIntegration[]: Service integrations - `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, uuid: Integration id - `dest` string: Destination service name - `zone` string: The zone where the service is running - `node-states` DbaasNodeState[]: State of individual service nodes - `name` string, required: Name of the service node - `progress-updates` DbaasNodeStateProgressUpdate[]: Extra information regarding the progress for current state - `completed` boolean, required: Indicates whether this phase has been completed or not - `current` integer: Current progress for this phase. May be missing or null. - `max` integer: Maximum progress value for this phase. May be missing or null. May change. - `min` integer: Minimum progress value for this phase. May be missing or null. - `phase` 'stream' | 'basebackup' | 'prepare' | 'finalize', required: Key identifying this phase - `unit` string: Unit for current/min/max values. New units may be added. If null should be treated as generic unit - `role` 'standby' | 'master' | 'read-replica': Role of this node. Only returned for a subset of service types - `state` 'leaving' | 'running' | 'syncing_data' | 'setting_up_vm' | 'unknown', required: Current state of the service node - `name` string, required - `kafka-connect-enabled` boolean: Whether Kafka Connect is enabled - `type` string, required - `state` 'running' | 'rebuilding' | 'rebalancing' | 'poweroff' - `ip-filter` string[]: Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16' - `schema-registry-settings` JsonSchemaSchemaRegistry - `leader_eligibility` boolean: If true, Karapace / Schema Registry on the service nodes can participate in leader election. It might be needed to disable this when the schemas topic is replicated to a secondary cluster and Karapace / Schema Registry there must not participate in leader election. Defaults to `true`. - `topic_name` string: The durable single partition topic that acts as the durable log for the data. This topic must be compacted to avoid losing data due to retention policy. Please note that changing this configuration in an existing Schema Registry / Karapace setup leads to previous schemas being inaccessible, data encoded with them potentially unreadable and schema ID sequence put out of order. It's only possible to do the switch while Schema Registry / Karapace is disabled. Defaults to `_schemas`. - `backups` DbaasServiceBackup[]: 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, required: Backup's original size before compression - `kafka-rest-settings` JsonSchemaKafkaRest - `producer_compression_type` 'gzip' | 'snappy' | 'lz4' | 'zstd' | 'none': Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression. - `name_strategy_validation` boolean: If true, validate that given schema is registered under expected subject name by the used name strategy when producing messages. - `name_strategy` 'topic_name' | 'record_name' | 'topic_record_name': Name strategy to use when selecting subject for storing schemas - `consumer_enable_auto_commit` boolean: If true the consumer's offset will be periodically committed to Kafka in the background - `producer_acks` 'all' | '-1' | '0' | '1': The number of acknowledgments the producer requires the leader to have received before considering a request complete. If set to 'all' or '-1', the leader will wait for the full set of in-sync replicas to acknowledge the record. - `consumer_request_max_bytes` integer: Maximum number of bytes in unencoded message keys and values by a single request - `producer_max_request_size` integer: The maximum size of a request in bytes. Note that Kafka broker can also cap the record batch size. - `simpleconsumer_pool_size_max` integer: Maximum number of SimpleConsumers that can be instantiated per broker - `producer_linger_ms` integer: Wait for up to the given delay to allow batching records together - `consumer_request_timeout_ms` 1000 | 15000 | 30000: The maximum total time to wait for messages for a request if the maximum number of messages has not yet been reached - `termination-protection` boolean: Service is protected against termination and powering off - `notifications` DbaasServiceNotification[]: Service notifications - `level` 'warning' | 'notice', required: Notification level - `message` string, required: Human notification message - `type` 'service_powered_off_removal' | 'service_end_of_life', required: Notification type - `metadata` object, required: Notification type - `kafka-connect-settings` JsonSchemaKafkaConnect - `producer_buffer_memory` integer: The total bytes of memory the producer can use to buffer records waiting to be sent to the broker (defaults to 33554432). - `consumer_max_poll_interval_ms` integer: The maximum delay in milliseconds between invocations of poll() when using consumer group management (defaults to 300000). - `producer_compression_type` 'gzip' | 'snappy' | 'lz4' | 'zstd' | 'none': Specify the default compression type for producers. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'none' which is the default and equivalent to no compression. - `connector_client_config_override_policy` 'None' | 'All': Defines what client configurations can be overridden by the connector. Default is None - `offset_flush_interval_ms` integer: The interval at which to try committing offsets for tasks (defaults to 60000). - `scheduled_rebalance_max_delay_ms` integer: The maximum delay that is scheduled in order to wait for the return of one or more departed workers before rebalancing and reassigning their connectors and tasks to the group. During this period the connectors and tasks of the departed workers remain unassigned. Defaults to 5 minutes. - `consumer_fetch_max_bytes` integer: Records are fetched in batches by the consumer, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that the consumer can make progress. As such, this is not a absolute maximum. - `consumer_max_partition_fetch_bytes` integer: Records are fetched in batches by the consumer.If the first record batch in the first non-empty partition of the fetch is larger than this limit, the batch will still be returned to ensure that the consumer can make progress. - `offset_flush_timeout_ms` integer: Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt (defaults to 5000). - `consumer_auto_offset_reset` 'earliest' | 'latest': What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server. Default is earliest - `producer_max_request_size` integer: This setting will limit the number of record batches the producer will send in a single request to avoid sending huge requests. - `producer_batch_size` integer: This setting gives the upper bound of the batch size to be sent. If there are fewer than this many bytes accumulated for this partition, the producer will 'linger' for the linger.ms time waiting for more records to show up. A batch size of zero will disable batching entirely (defaults to 16384). - `session_timeout_ms` integer: The timeout in milliseconds used to detect failures when using Kafka’s group management facilities (defaults to 10000). - `producer_linger_ms` integer: This setting gives the upper bound on the delay for batching: once there is batch.size worth of records for a partition it will be sent immediately regardless of this setting, however if there are fewer than this many bytes accumulated for this partition the producer will 'linger' for the specified time waiting for more records to show up. Defaults to 0. - `consumer_isolation_level` 'read_uncommitted' | 'read_committed': Transaction read isolation level. read_uncommitted is the default, but read_committed can be used if consume-exactly-once behavior is desired. - `consumer_max_poll_records` integer: The maximum number of records returned in a single call to poll() (defaults to 500). - `components` 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` 'certificate' | 'sasl' - `port` integer, required: Port number for connecting to the service component - `route` 'dynamic' | 'private' | 'public' | 'privatelink', required - `usage` 'primary' | 'replica', required - `maintenance` DbaasServiceMaintenance: Automatic maintenance settings - `dow` 'saturday' | 'tuesday' | 'never' | 'wednesday' | 'sunday' | 'friday' | 'monday' | 'thursday', required: Day of week for installing updates - `time` string, required: Time for installing updates, UTC - `updates` DbaasServiceUpdate[], required: List of updates 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` JsonSchemaKafka - `sasl_oauthbearer_expected_audience` string: The (optional) comma-delimited setting for the broker to use to verify that the JWT was issued for one of the expected audiences. - `group_max_session_timeout_ms` integer: The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. - `log_flush_interval_messages` integer: The number of messages accumulated on a log partition before messages are flushed to disk - `sasl_oauthbearer_jwks_endpoint_url` string: OIDC JWKS endpoint URL. By setting this the SASL SSL OAuth2/OIDC authentication is enabled. See also other options for SASL OAuth2/OIDC. - `max_connections_per_ip` integer: The maximum number of connections allowed from each ip address (defaults to 2147483647). - `sasl_oauthbearer_expected_issuer` string: Optional setting for the broker to use to verify that the JWT was created by the expected issuer. - `log_index_size_max_bytes` integer: The maximum size in bytes of the offset index - `auto_create_topics_enable` boolean: Enable auto creation of topics - `log_index_interval_bytes` integer: The interval with which Kafka adds an entry to the offset index - `replica_fetch_max_bytes` integer: The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. - `num_partitions` integer: Number of partitions for autocreated topics - `transaction_state_log_segment_bytes` integer: The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)). - `replica_fetch_response_max_bytes` integer: Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. - `log_message_timestamp_type` 'CreateTime' | 'LogAppendTime': Define whether the timestamp in the message is message create time or log append time. - `connections_max_idle_ms` integer: Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. - `log_flush_interval_ms` integer: The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used - `log_preallocate` boolean: Should pre allocate file when create new segment? - `log_segment_delete_delay_ms` integer: The amount of time to wait before deleting a file from the filesystem - `message_max_bytes` integer: The maximum size of message that the server can receive. - `group_initial_rebalance_delay_ms` integer: The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. - `log_local_retention_bytes` integer: The maximum size of local log segments that can grow for a partition before it gets eligible for deletion. If set to -2, the value of log.retention.bytes is used. The effective value should always be less than or equal to log.retention.bytes value. - `log_roll_jitter_ms` integer: The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used - `transaction_remove_expired_transaction_cleanup_interval_ms` integer: The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)). - `transaction_partition_verification_enable` boolean: Enable verification that checks that the partition has been added to the transaction before writing transactional records to the partition - `default_replication_factor` integer: Replication factor for autocreated topics - `log_roll_ms` integer: The maximum time before a new log segment is rolled out (in milliseconds). - `producer_purgatory_purge_interval_requests` integer: The purge interval (in number of requests) of the producer request purgatory(defaults to 1000). - `log_retention_bytes` integer: The maximum size of the log before deleting messages - `min_insync_replicas` integer: When a producer sets acks to 'all' (or '-1'), min.insync.replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. - `compression_type` 'gzip' | 'snappy' | 'lz4' | 'zstd' | 'uncompressed' | 'producer': Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. - `log_message_timestamp_difference_max_ms` integer: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message - `log_local_retention_ms` integer: The number of milliseconds to keep the local log segments before it gets eligible for deletion. If set to -2, the value of log.retention.ms is used. The effective value should always be less than or equal to log.retention.ms value. - `log_message_downconversion_enable` boolean: This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. - `sasl_oauthbearer_sub_claim_name` string: Name of the scope from which to extract the subject claim from the JWT. Defaults to sub. - `max_incremental_fetch_session_cache_slots` integer: The maximum number of incremental fetch sessions that the broker will maintain. - `log_retention_hours` integer: The number of hours to keep a log file before deleting it - `group_min_session_timeout_ms` integer: The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. - `socket_request_max_bytes` integer: The maximum number of bytes in a socket request (defaults to 104857600). - `log_segment_bytes` integer: The maximum size of a single log file - `log-cleanup-and-compaction` object - `log_cleaner_delete_retention_ms` integer: How long are delete records retained? - `log_cleaner_max_compaction_lag_ms` integer: The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted - `log_cleaner_min_cleanable_ratio` number: Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log.cleaner.max.compaction.lag.ms to enforce compactions sooner, instead of setting a very high value for this option. - `log_cleaner_min_compaction_lag_ms` integer: The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. - `log_cleanup_policy` 'delete' | 'compact' | 'compact,delete': The default cleanup policy for segments beyond the retention window - `offsets_retention_minutes` integer: Log retention window in minutes for offsets topic - `log_retention_ms` integer: The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. - `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 - `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` object[]: List of service users - `type` string - `username` string - `password` string - `access-cert` string - `access-cert-expiry` string, date-time - `access-key` string ## Changes - **2025-05-22** `37a05010e8b4`: 1 info - added the required property `prometheus-uri` to the response with the `200` status - **2024-05-22** `d1903c399d90`: 7 info - added the optional property `kafka-rest-settings/name_strategy` to the response with the `200` status - added the optional property `kafka-rest-settings/name_strategy_validation` to the response with the `200` status - added the optional property `kafka-settings/transaction_partition_verification_enable` to the response with the `200` status - the `kafka-settings` response's property default value `{}` was removed for the status `200` - …3 more - **2023-12-08** `ec6a2a6bc1c1`: 68 info - added the optional property `kafka-connect-settings/connector_client_config_override_policy` to the response with the `200` status - added the optional property `kafka-connect-settings/consumer_auto_offset_reset` to the response with the `200` status - added the optional property `kafka-connect-settings/consumer_fetch_max_bytes` to the response with the `200` status - added the optional property `kafka-connect-settings/consumer_isolation_level` to the response with the `200` status - …64 more - **2023-06-06** `cf7b08181585`: 2 info - added the optional property `connection-info/connect-uri` to the response with the `200` status - added the optional property `zone` to the response with the `200` status - …earlier changes not shown [Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/dbaas-kafka/:name/get.md) --- [API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)