Viewing and Modifying Basic Cluster Information
Last updated:2026-01-23 17:34:04
Scenarios
After successfully creating a TDMQ for RocketMQ cluster, you can view and adjust its basic information in the console at any time, including the cluster name, description, and resource tag, ensuring that the cluster configuration always meets your business requirements. This document describes how to view basic cluster information in the console and modify or manage these basic configuration items.
Viewing Basic Cluster Information
1. Log in to the TDMQ for RocketMQ console.
2. In the left sidebar, choose Cluster Resource > Cluster and select a region to view the cluster list information.
The lifecycle of a TDMQ for RocketMQ cluster refers to the statuses it undergoes from startup to release. Proper management of the cluster from startup to deletion ensures that applications running on it can provide services efficiently and cost-effectively. The following table describes the cluster statuses.
Status Name | Status Property | Status Description |
Creating | Intermediate status | Status after a cluster is created but before it enters the running status. |
Running (healthy/alarm) | Steady status | Status in which the cluster is running normally, with the cluster status, disk utilization, and other metrics within normal ranges. |
Migrating | Intermediate status | Status during which data migration occurs as the cluster configuration is being adjusted. |
Deleting | Intermediate status | Status during which the cluster is being deleted through the console or using an API. |
Isolated | Intermediate status | Status in which the cluster has been isolated due to overdue payment. During this 7-day isolation period, the cluster cannot produce or consume messages, and any stored or unconsumed messages will not be retained. However, cluster configurations remain intact and are not deleted. |
Creation failed | Intermediate status | Status in which fees are deducted successfully, but cluster assignment fails when a cluster is purchased through the console or using an API. If this occurs, contact online customer service for assistance. |
Deletion failed | Steady status | Status in which the cluster has been manually deleted or has not been renewed within 7 days after expiration, and TDMQ for RocketMQ failed to release the resources. |
3. Click the ID of the target cluster. On the Basic Information page, you can view the health status, basic information, access information, resource overview, top resource consumption, and other details of the cluster.
Parameter | Description |
Basic Information | Includes the cluster name/ID, region, creation time, description, and resource tags. You can adjust certain parameters under this module based on actual business requirements. |
Cluster Data Statistics | Displays the transactions per second (TPS) upper limits for sending/receiving messages, the number of backlogged messages, the number of messages produced per second, and the number of messages consumed per second in the cluster. These metrics help you monitor the overall operation status of the cluster. If the number of backlogged messages increases significantly or the production/consumption rate fluctuates abnormally, the cluster may undergo performance pressure or have potential issues. Timely scaling or troubleshooting is required in such cases. |
Access Information | Displays the public network and private network access points of the cluster. For details, see Network Connection Description. |
Cluster Overview | Displays the quantities of various resources, resource quota usage, message type distribution, and other information within the cluster. |
Top Resource Consumption | Ranks groups and topics consuming major resources in the cluster, including the number of backlogged messages, production/consumption rates, storage space, traffic throttling, and retry/dead letter messages. Through top group/topic rankings of these key metrics, you can quickly and precisely identify critical issues affecting cluster stability and performance, ensuring proactive discovery and intervention of system bottlenecks and abnormal consumption behaviors. Note: The collection and ranking of top groups/topics for cluster resource consumption data have minute-level latency. Therefore, the data is for reference only. The accurate rates and backlogged data displayed in the Monitoring module prevail. |
Modifying Basic Cluster Information
On the Cluster Overview and Basic Information pages, you can modify the following parameters.
Parameter | Modification Method |
Name | Click the editing icon next to Name, enter a cluster name, and click Submit. The name must be 3 to 64 characters in length and can contain only letters, digits, hyphens (-), and underscores (_). |
Description | Click the editing icon next to Description, enter the description information, and click Submit. The cluster description cannot exceed 128 characters. |
Resource Tag | Click the editing icon next to Resource Tag to bind or modify tags for the cluster. For detailed tag usage, see Configuring Resource Tags. |
Instance Deletion Protection | Click the editing icon next to Deletion Protection to enable or disable the deletion protection switch for the cluster. For details, see Configuring Deletion Protection. |
Public Network | Click the editing icon next to Public Network Access Bandwidth under the Access Information module to manually enable or disable public network bandwidth. For details, see Configuring Public Network Access. |
Elastic TPS | (Only supported in 5.x clusters) You can click the Elastic TPS switch under the Cluster Overview module to enable or disable elastic TPS for the cluster. Elastic TPS is used to handle traffic spikes. For billing rules, see 5.x Cluster Pricing Description. |
Transmit/Receive TPS Proportion | (Only supported in 5.x clusters) Click the editing icon next to Message TPS Proportion under the Cluster Overview module, and drag the slider below to configure the TPS read/write throttling ratio. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback