dbaas

Get a DBaaS Kafka service

get/dbaas-kafka/{name}

Request

Path parameters

namestring required

Response

200

updated-atstring date-time

Service last update timestamp (ISO 8601)

node-countinteger

Number of service nodes in the active plan

node-cpu-countinteger

Number of CPUs for each node

kafka-rest-enabledboolean

Whether Kafka REST is enabled

zonestring

The zone where the service is running

namestring required
kafka-connect-enabledboolean

Whether Kafka Connect is enabled

typestring required
state'running' | 'rebuilding' | 'rebalancing' | 'poweroff'
ip-filterstring[]

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

termination-protectionboolean

Service is protected against termination and powering off

disk-sizeinteger

TODO UNIT disk space for data storage

node-memoryinteger

TODO UNIT of memory for each node

uristring

URI for connecting to the service (may be absent)

uri-paramsobject

service_uri parameterized into key-value pairs

schema-registry-enabledboolean

Whether Schema-Registry is enabled

versionstring

Kafka version

created-atstring date-time

Service creation timestamp (ISO 8601)

planstring required

Subscription plan

Example response

{
  "schema-registry-settings": {
    "leader_eligibility": true,
    "topic_name": "_schemas"
  },
  "kafka-connect-settings": {
    "producer_buffer_memory": 8388608,
    "consumer_max_poll_interval_ms": 300000,
    "offset_flush_interval_ms": 60000,
    "scheduled_rebalance_max_delay_ms": 300000,
    "consumer_fetch_max_bytes": 52428800,
    "consumer_max_partition_fetch_bytes": 1048576,
    "offset_flush_timeout_ms": 5000,
    "producer_max_request_size": 1048576,
    "producer_batch_size": 1024,
    "session_timeout_ms": 10000,
    "producer_linger_ms": 100,
    "consumer_max_poll_records": 500
  },
  "kafka-settings": {
    "group_max_session_timeout_ms": 1800000,
    "log_flush_interval_messages": 9223372036854776000,
    "log_index_size_max_bytes": 10485760,
    "auto_create_topics_enable": true,
    "log_index_interval_bytes": 4096,
    "transaction_state_log_segment_bytes": 104857600,
    "connections_max_idle_ms": 540000,
    "log_segment_delete_delay_ms": 60000,
    "message_max_bytes": 1048588,
    "group_initial_rebalance_delay_ms": 3000,
    "transaction_remove_expired_transaction_cleanup_interval_ms": 3600000,
    "transaction_partition_verification_enable": true,
    "min_insync_replicas": 1,
    "log_message_downconversion_enable": true,
    "max_incremental_fetch_session_cache_slots": 1000,
    "group_min_session_timeout_ms": 6000,
    "log-cleanup-and-compaction": {
      "log_cleaner_delete_retention_ms": 86400000,
      "log_cleaner_min_cleanable_ratio": 0.5,
      "log_cleanup_policy": "delete"
    },
    "offsets_retention_minutes": 10080
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.