dbaas

Update a DBaaS Kafka service

Changed on May 22, 2024

put/dbaas-kafka/{name}

Request

Base URL
https://api-ch-gva-2.exoscale.com/v2
Auth
none declared
TypeScript
https://skmtc.dev/exoscale/apis/exoscale-api/docs/dbaas-kafka/:name/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

namestring required

Request body

kafka-rest-enabledboolean

Enable Kafka-REST service

kafka-connect-enabledboolean

Allow clients to connect to kafka_connect from the public internet for service nodes that are in a project VPC or another type of private network

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

schema-registry-enabledboolean

Enable Schema-Registry service

versionstring

Kafka major version

planstring

Subscription plan

Example request

{
  "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
  }
}

Response

200

idstring uuid

Operation ID

Operation failure reason

messagestring

Operation message

state'failure' | 'pending' | 'success' | 'timeout'

Operation status

Changes

May 22, 2024d1903c399d90 Revision changes
- breaking
  added the pattern ^[^\r\n]*$ to the request property /
- breaking
  added the pattern ^[^\r\n]*$ to the request property /
- breaking
  added the pattern ^[^\r\n]*$ to the request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  the request property default value {} was removed
Dec 8, 2023ec6a2a6bc1c1 Revision changes
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property
- info
  the request property default value {} was added

Operation history (3 revisions)

Update a DBaaS Kafka service

Request

Path parameters

Request body

Example request

Response 200OK

Changes

Response