DBaaS Kafka

Kafka is a distributed, open-source data platform for optimized real-time processing of streaming data.

Read more

create-dbaas-kafka-schema-registry-acl-config

Add a Kafka Schema Registry ACL entry

POST /dbaas-kafka/{name}/schema-registry/acl-config

null

Path parameters

• name in path (required)

Request body

• application/json
  • id (string)
  • username (required) (string): Kafka username or username pattern
  • resource (required) (string): Kafka Schema Registry name or pattern
  • permission (required) (string): Kafka Schema Registry permission

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-kafka-schema-registry-acl-config: golang | Python | Java

CLI: exo api create-dbaas-kafka-schema-registry-acl-config

delete-dbaas-kafka-schema-registry-acl-config

Delete a Kafka ACL entry

DELETE /dbaas-kafka/{name}/schema-registry/acl-config/{acl-id}

null

Path parameters

• name in path (required)
• acl-id in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-kafka-schema-registry-acl-config: golang | Python | Java

CLI: exo api delete-dbaas-kafka-schema-registry-acl-config

create-dbaas-kafka-topic-acl-config

Add a Kafka topic ACL entry

POST /dbaas-kafka/{name}/topic/acl-config

null

Path parameters

• name in path (required)

Request body

• application/json
  • id (string)
  • username (required) (string): Kafka username or username pattern
  • topic (required) (string): Kafka topic name or pattern
  • permission (required) (string): Kafka permission

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-kafka-topic-acl-config: golang | Python | Java

CLI: exo api create-dbaas-kafka-topic-acl-config

delete-dbaas-kafka-topic-acl-config

Delete a Kafka ACL entry

DELETE /dbaas-kafka/{name}/topic/acl-config/{acl-id}

null

Path parameters

• name in path (required)
• acl-id in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-kafka-topic-acl-config: golang | Python | Java

CLI: exo api delete-dbaas-kafka-topic-acl-config

create-dbaas-kafka-user

Create a DBaaS Kafka user

POST /dbaas-kafka/{service-name}/user

null

Path parameters

• service-name in path (required)

Request body

• application/json
  • username (required) (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-kafka-user: golang | Python | Java

CLI: exo api create-dbaas-kafka-user

delete-dbaas-kafka-user

Delete a DBaaS kafka user

DELETE /dbaas-kafka/{service-name}/user/{username}

null

Path parameters

• service-name in path (required)
• username in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-kafka-user: golang | Python | Java

CLI: exo api delete-dbaas-kafka-user

reveal-dbaas-kafka-user-password

Reveal the secrets of a DBaaS Kafka user

GET /dbaas-kafka/{service-name}/user/{username}/password/reveal

null

Path parameters

• service-name in path (required)
• username in path (required)

Responses

• 200: 200
  • application/json
    • username (string): Kafka username
    • password (string): Kafka password
    • access-cert (string): Kafka certificate
    • access-cert-expiry (string)
    • access-key (string): Kafka access key

SDK reference for reveal-dbaas-kafka-user-password: golang | Python | Java

CLI: exo api reveal-dbaas-kafka-user-password

reset-dbaas-kafka-user-password

Reset the credentials of a DBaaS Kafka user

PUT /dbaas-kafka/{service-name}/user/{username}/password/reset

If no password is provided one will be generated automatically.

Path parameters

• service-name in path (required)
• username in path (required)

Request body

• application/json
  • password (string)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for reset-dbaas-kafka-user-password: golang | Python | Java

CLI: exo api reset-dbaas-kafka-user-password

create-dbaas-service-kafka

Create a DBaaS Kafka service

POST /dbaas-kafka/{name}

Create a DBaaS Kafka service

Path parameters

• name in path (required)

Request body

• application/json
  • authentication-methods (object): Kafka authentication methods - schema details
  • kafka-rest-enabled (boolean): Enable Kafka-REST service
  • kafka-connect-enabled (boolean): 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-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
  • schema-registry-settings (object) - schema details
  • kafka-rest-settings (object) - schema details
  • termination-protection (boolean): Service is protected against termination and powering off
  • kafka-connect-settings (object) - schema details
  • maintenance (object): Automatic maintenance settings - schema details
  • kafka-settings (object) - schema details
  • schema-registry-enabled (boolean): Enable Schema-Registry service
  • version (string): Kafka major version
  • plan (required) (string): Subscription plan

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for create-dbaas-service-kafka: golang | Python | Java

CLI: exo api create-dbaas-service-kafka

get-dbaas-service-kafka

Get a DBaaS Kafka service

GET /dbaas-kafka/{name}

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • updated-at (string): Service last update timestamp (ISO 8601)
    • authentication-methods (object): Kafka authentication methods - schema details
    • node-count (integer): Number of service nodes in the active plan
    • connection-info (object): Kafka connection information properties - schema details
    • node-cpu-count (integer): Number of CPUs for each node
    • kafka-rest-enabled (boolean): Whether Kafka REST is enabled
    • prometheus-uri (object): Prometheus integration URI - schema details
    • integrations (array[object]): Service integrations - schema details
    • zone (string): The zone where the service is running
    • node-states (array[object]): State of individual service nodes - schema details
    • name (string)
    • kafka-connect-enabled (boolean): Whether Kafka Connect is enabled
    • type (string)
    • state (string)
    • ip-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
    • schema-registry-settings (object) - schema details
    • backups (array[object]): List of backups for the service - schema details
    • kafka-rest-settings (object) - schema details
    • termination-protection (boolean): Service is protected against termination and powering off
    • notifications (array[object]): Service notifications - schema details
    • kafka-connect-settings (object) - schema details
    • components (array[object]): Service component information objects - schema details
    • maintenance (object): Automatic maintenance settings - schema details
    • kafka-settings (object) - schema details
    • 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): Service creation timestamp (ISO 8601)
    • plan (string): Subscription plan
    • users (array[object]): List of service users - schema details

SDK reference for get-dbaas-service-kafka: golang | Python | Java

CLI: exo api get-dbaas-service-kafka

update-dbaas-service-kafka

Update a DBaaS Kafka service

PUT /dbaas-kafka/{name}

Update a DBaaS Kafka service

Path parameters

• name in path (required)

Request body

• application/json
  • authentication-methods (object): Kafka authentication methods - schema details
  • kafka-rest-enabled (boolean): Enable Kafka-REST service
  • kafka-connect-enabled (boolean): 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-filter (array[string]): Allow incoming connections from CIDR address block, e.g. ‘10.20.0.0/16’
  • schema-registry-settings (object) - schema details
  • kafka-rest-settings (object) - schema details
  • termination-protection (boolean): Service is protected against termination and powering off
  • kafka-connect-settings (object) - schema details
  • maintenance (object): Automatic maintenance settings - schema details
  • kafka-settings (object) - schema details
  • schema-registry-enabled (boolean): Enable Schema-Registry service
  • version (string): Kafka major version
  • plan (string): Subscription plan

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for update-dbaas-service-kafka: golang | Python | Java

CLI: exo api update-dbaas-service-kafka

delete-dbaas-service-kafka

Delete a Kafka service

DELETE /dbaas-kafka/{name}

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for delete-dbaas-service-kafka: golang | Python | Java

CLI: exo api delete-dbaas-service-kafka

Other Operations

get-dbaas-kafka-acl-config

Get DBaaS kafka ACL configuration

GET /dbaas-kafka/{name}/acl-config

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • topic-acl (array[object]) - schema details
    • schema-registry-acl (array[object]) - schema details

SDK reference for get-dbaas-kafka-acl-config: golang | Python | Java

CLI: exo api get-dbaas-kafka-acl-config

reveal-dbaas-kafka-connect-password

Reveal the secrets for DBaaS Kafka Connect

GET /dbaas-kafka/{service-name}/connect/password/reveal

null

Path parameters

• service-name in path (required)

Responses

• 200: 200
  • application/json
    • username (string): Kafka Connect username
    • password (string): Kafka Connect password

SDK reference for reveal-dbaas-kafka-connect-password: golang | Python | Java

CLI: exo api reveal-dbaas-kafka-connect-password

start-dbaas-kafka-maintenance

Initiate Kafka maintenance update

PUT /dbaas-kafka/{name}/maintenance/start

null

Path parameters

• name in path (required)

Responses

• 200: 200
  • application/json
    • id (string): Operation ID
    • reason (string): Operation failure reason
    • reference (object): Related resource reference - schema details
    • message (string): Operation message
    • state (string): Operation status

SDK reference for start-dbaas-kafka-maintenance: golang | Python | Java

CLI: exo api start-dbaas-kafka-maintenance

get-dbaas-settings-kafka

Get DBaaS Kafka settings

GET /dbaas-settings-kafka

Get DBaaS Kafka settings

Responses

• 200: 200
  • application/json
    • settings (object) - schema details

SDK reference for get-dbaas-settings-kafka: golang | Python | Java

CLI: exo api get-dbaas-settings-kafka