tencent cloud

APIs

Introduction

Download
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-08-03 10:13:11

Overview

CKafka, Message Queue (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 enables message decoupling, allowing producers and consumers to interact asynchronously without the need to wait for each other. With advantages such as high availability, data compression, and simultaneous support for offline and real-time data processing, CKafka is suitable for scenarios like collection of compressed logs, monitoring data aggregation, and seamless integration of streaming data.
All TDMQ for CKafka APIs introduced in this chapter comply with the OpenAPI 3.0 specification.
You can call APIs to operate CKafka, such as create instance, create Topic, and send/receive messages.
For all APIs supported by CKafka, see API overview.

Glossary

Common terminology for the CKafka API interface is listed in the table below:

Term Description
Instance In Message Queue CKafka, an Instance is the unit for purchasing CKafka. According to different peak throughput (MB/s) and disk capacity (GB), instances are divided into varying specifications. Purchase instances of different specifications to ensure high reliability and availability of CKafka. By default, the purchased cluster service is highly available, containing multiple Broker servers in service, and customers do not need to worry about hardware devices.
Topic is a logical concept used to store messages, which can be seen as a message collection. Each topic can have multiple producers pushing messages to it, and any number of consumers can consume the messages.
Producer A producer refers to a role that transmits messages in a message queue.
Consumer 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.
Consumer Group 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 each partition of the subscribed Topic is assigned to 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 description in each API document.

Getting Started with APIs

You can use the API Explorer tool to call APIs online.
This document uses creating CKafka instance and other resources as an example. The steps for API call via API Explorer Tool are as follows:

  1. Go to the API Explorer tool page. For more API Explorer tool usage information, see Using API Explorer.
  2. Call the CreateTopic API to create a topic under the instance.
  3. Call the CreateRoute api to add VPC routing to the instance.
  4. Call the CreateUser api to create a user.
  5. Call the CreateAcl API (https://www.tencentcloud.com/document/product/597/40860?from_cn_redirect=1) to add an ACL policy.
  6. Use client to send/receive messages (this operation does not support through API interface).
  7. Call the FetchMessageByOffset api to query messages.

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan