Viewing and Modifying Cluster Basic Information
Last updated:2026-01-30 14:55:29
Scenarios
After successfully creating an MQTT cluster, you can view and adjust basic cluster information at any time via the console, including the cluster name, description, resource Tags, access endpoints, and so on, ensuring the cluster configuration consistently meets your business requirements. This document explains how to view basic cluster information in the console and modify or manage these fundamental configuration items.
Viewing Basic Cluster Information
1. Log in to the MQTT Console.
2. In the left sidebar, choose Resource > Cluster. After the region is selected, you can view the cluster list information.
The lifecycle of a TDMQ for MQTT cluster refers to the statuses it undergoes from startup to release. By properly managing the cluster from startup to deletion, you can ensure that applications running on the cluster provide services efficiently and cost-effectively. A cluster can have the following 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 | The status in which the cluster is running normally, with node health, 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 | The status during which the cluster is being deleted through the console or an API. |
Isolated | Intermediate status | The cluster has incurred arrears and entered isolation status. Clusters in isolation status cannot produce or consume data. Data and configurations saved in the cluster will not be deleted. |
Creation Failed | Intermediate status | The status occurs when the fee is successfully deducted but cluster allocation fails during purchase through the console or an API. If this occurs, contact Online Customer Service for assistance. |
Deletion Failed | Steady status | The cluster failed to deallocate resources when manually deleted or not renewed within 7 days after expiration. |
3. Click the ID of the target cluster. On the Basic Information page, you can view the cluster's basic information, overview, health status, access information, and client configurations.
Category | Description |
Basic Information | Displays the basic configuration information of the cluster. You can adjust some parameters in this module according to actual business needs. |
Cluster Overview | Displays the current overall resource usage and message production/consumption status of the cluster. These metrics help you understand the cluster's operational status. If abnormal fluctuations in production/consumption rates are detected, it may indicate performance pressure or potential issues. Timely cluster scaling, optimization, or troubleshooting is required to ensure the stability and availability of the messaging service. |
Access Information | Displays the public network and private network access points of the cluster. For details, see Network Connection Description. |
Client Configuration | In this module, you can adjust the client throttling configuration. |
Modifying Basic Cluster Information
On the basic information page of the cluster, you can modify the following parameters:
Parameter | Modification Method |
Cluster Name and Description | Click the Edit button next to "Description", enter the cluster name and description, then click Submit. Cluster Name: The name must comply with naming rules: 3-64 characters, containing only letters, numbers, hyphens (-), and underscores (_). Cluster Description: The description cannot exceed 128 characters. |
Resource Tag | Click Edit next to Resource Tag to bind or modify tags for the cluster. For detailed usage of tags, see Configuring Resource Tags. |
Client Rate Limiting Rule Configuration
The cluster's basic information page includes a client configuration module that supports throttling rules for configuring the message publishing rate of clients, enabling fine-grained configuration and management of cluster specifications. Specific operations are as shown in the following figure.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback