Overview
TDMQ for CKafka is a distributed, high I/O throughput, highly scalable messaging system, 100% compatible with open-source Kafka API versions 2.4, 2.8, and 3.2. Based on the publish/subscribe model, CKafka decouples messages, allowing producers and consumers to interact asynchronously without the need to wait. With high availability, data compression, and simultaneous support for offline and real-time data processing, CKafka is suitable for scenarios such as log compression collection, monitoring data aggregation, and streaming data integration.
This section introduces TDMQ for CKafka API interfaces, which are all API 3.0 interfaces.
You can call APIs to operate CKafka, such as create instance, create Topic, and send/receive messages.
For all APIs supported by CKafka, please refer to the API overview.
Glossary
Common terminology for CKafka API interface see the table below:
| Term | Description |
|---|---|
| In TDMQ for CKafka, an Instance is the unit of purchase. Instances are divided into different specifications by peak throughput (MB/s) and disk capacity (GB). Purchase instances of varying specifications to ensure high reliability and availability of CKafka. By default, the purchased cluster service is highly available, containing multiple Broker servers, and customers do not need to worry about hardware devices. | |
| A Topic is a logical concept used to store messages, which can be viewed as a message collection. Each Topic can have multiple producers pushing messages to it, and any number of consumers can consume the messages. | |
| Producer (Producer) refers to the role that sends messages in a message queue. | |
| A Consumer is a service that pulls messages from a Topic and consumes them. The Consumer maintains the relevant information of the offset it consumes to the Partition. | |
| A Consumer Group is a collection of consumers. In CKafka, multiple consumers can form a Consumer Group, and a Consumer can only belong to one Consumer Group. A Consumer Group ensures that each partition of the subscribed Topic is assigned to only one Consumer in the Group for processing. |
For other relevant terminology, see the glossary (https://www.tencentcloud.com/document/product/597/32544?from_cn_redirect=1).
Usage limits
-For CKafka usage limits, please refer to CKafka Usage Limits.
-For specific parameter limits, refer to the parameter descriptions in each API document.
Getting Started with APIs
You can use the API Explorer tool to call APIs online.
This document uses creating a CKafka instance and other resources as an example. The steps for API calls via the API Explorer Tool are as follows:
- Go to the API Explorer tool page. For more information about API Explorer tool usage, see Using API Explorer.
Call the CreateTopic API (https://www.tencentcloud.com/document/product/597/40851?from_cn_redirect=1) to create a topic under the instance. - Call the CreateRoute API to add VPC routing to the instance.
- Call the CreateUser API to create a user.
- Call the CreateAcl API to add an ACL policy.
- Use client to send/receive messages (This operation cannot be performed through API interface).
- Call the FetchMessageByOffset API to query messages.
Feedback