SDK Overview
Last updated:2026-01-23 17:52:23
TDMQ for RocketMQ is a code branch independently maintained by Tencent Cloud and is 100% compatible with the RocketMQ protocol, featuring high performance, high availability (HA), high reliability, high elasticity, and high security. This document mainly introduces the compatibility description for different SDK versions of TDMQ for RocketMQ clusters and the collection of connection information before using a client to send and receive messages, such as obtaining the cluster access point and the role and token for accessing the cluster.
Compatibility Description
TDMQ for RocketMQ 5.0 provides a brand new 5.x SDK based on the gRPC protocol. The new SDK version is more lightweight and offers better multi-language support. Therefore, it is recommended that it be used preferentially. In addition, the TDMQ for RocketMQ 5.x series also supports using a 4.x SDK to access existing businesses. Compatibility details are as follows:
Server Version | Client Version | Compatibility | |
5.x | 5.x SDK | | Fully compatible. |
| 4.x SDK | Version 4.9.5 or later | PushConsumer CONSUME_FROM_TIMESTAMP is not effective. (The offset can be reset in the console.) The maximum setPullBatchSize value for the consumer is 32. (The server will ultimately limit it to 32.) |
| | Versions earlier than 4.9.5 | PushConsumer CONSUME_FROM_TIMESTAMP is not effective. (The offset can be reset in the console.) The maximum setPullBatchSize value for the consumer is 32. (The server will ultimately limit it to 32.) PullConsumer consumption is not supported. |
Client Network Environment Description
A client can connect to and access a TDMQ for RocketMQ cluster through the following three network methods:
1. Direct access within the same Virtual Private Cloud (VPC) network
The client and TDMQ for RocketMQ cluster are deployed within the same VPC network, and can be interconnected by default. The client can directly access the TDMQ for RocketMQ cluster through a VPC network access point.
2. Cross-VPC communication through Cloud Connect Network (CCN)
If the client and the TDMQ for RocketMQ cluster are deployed in different VPC networks, they cannot communicate with each other directly because different VPC networks are logically isolated. To enable VPC networks in different regions under the same account to communicate with each other, use CCN.
3. Public network access
If the client is deployed in other network environments or in a different region from the TDMQ for RocketMQ cluster, a public network route can be configured, and the client can access the TDMQ for RocketMQ cluster through a public network access point.
Obtaining Connection Information
1. Cluster access point address and port information
The cluster access point address can be obtained from the Access Information module on the Basic Information page of the cluster. Select an access point based on the network type.
2. Namespace name (required only for 4.x exclusive clusters and virtual clusters)
It can be obtained from the Namespace List page in the console.
3. Role and role token for accessing the cluster. Ensure that the user has been granted the access permissions.
It can be obtained on the Cluster Permissions (5.x cluster) or Role Management (4.x cluster) page in the console.
4. Topic name
It can be obtained on the Topic List page in the console.
5. Group name
It can be obtained on the Group List page in the console.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback