Updated on 2024-03-18 GMT+08:00

API Overview

Table 1 APIs



Lifecycle management APIs

Create an instance, list all instances, query an instance, delete an instance, modify instance information, restart or delete instances in batches, and obtain or modify instance specifications.

Instance management APIs

Reset the password, reset Kafka Manager password, restart Kafka Manager, configure automatic topic creation, modify the private IP address for cross-VPC access, query Kafka cluster metadata, query consumer group details, query coordinator details of a Kafka instance, reassign replicas of a topic for a Kafka instance, query the disk usage status of topics, query all consumer groups, batch delete consumer groups of a Kafka instance, create a consumer group, edit a consumer group, initiate partition reassigning for a Kafka instance, disable Kafka Manager, delete a user or client quota, query user or client quotas, create user or client quotas, modify user or client quotas, and reset consumer group offset to the specified position.

Smart Connect APIs

Enable Smart Connect (pay-per-use instance), disable Smart Connect (pay-per-use instance), create a Smart Connect task, query Smart Connect tasks, query Smart Connect task details, delete a Smart Connect task, pause a Smart Connect task, restart a Smart Connect task, and start a Smart Connect task or restart a paused or running Smart Connect task.

Specification modification management APIs

Query product information for instance specification modification, and increasing instance specifications.

Topic management APIs

Create a topic for a Kafka instance, produce messages to Kafka, list topics of a Kafka instance, modify topics of a Kafka instance, batch delete topics of a Kafka instance, query the partition list of a topic, query the current producer list of a topic, and query topic details.

User management APIs

List users, create a user, batch delete users, reset the user password, modify user parameters, query user permissions, and configure user permissions.

Message query APIs

Query messages, query a message with a specified offset, query a message with a specified time period, query offset of the earliest message in a partition, and query offset of the latest message in a partition.

Background task management APIs

List background tasks, query a background task, and delete a background task.

Tag management APIs

Add or delete tags in batches, list tags of an instance, and list tags of a project.

Other APIs

List AZ information, query product specifications, query Kafka instance monitoring dimensions, and list maintenance time windows.