Viewing and Modifying Basic Information of a RocketMQ Instance

This section describes how to view the details, and modify the basic information of a RocketMQ instance on the console.

After creating a RocketMQ instance, you can modify some configurations of it as required, including the instance name, description, and security group.

Prerequisite

A RocketMQ instance has been purchased.

Viewing Basic Information of a RocketMQ Instance

Log in to the console.
Click in the upper left corner to select a region.

DMS for RocketMQ instances in different regions cannot communicate with each other over an intranet. Select a nearest location for low latency and fast access.
Click and choose Middleware > Distributed Message Service for RocketMQ to open the console of DMS for RocketMQ.

Search for a RocketMQ instance by specifying the filters. Current filters include the status, name, version, instance type, specification, used/available storage space, billing mode, AZ, private connection address, public connection address, enterprise project, and tag. For RocketMQ instance statuses, see Table 1.

**Table 1** RocketMQ instance status description
Status	Description
Creating	The instance is being created.
Creation failed	The instance failed to be created.
Running	The instance is running properly. Only instances in the Running state can provide services.
Faulty	The instance is not running properly.
Starting	The status between Frozen and Running.
Restarting	The instance is being restarted.
Changing	The instance specifications or public access configurations are being modified.
Change failed	The instance specifications or public access configurations failed to be modified. You cannot restart, delete, or modify an instance in the Change failed state. Contact customer service.
Frozen	The instance is frozen.
Freezing	The status between Running and Frozen.
Upgrading	The instance is being upgraded.
Rolling back	The instance is being rolled back.
Binning	The instance is being moved to Recycle Bin.
Binned	The instance is in Recycle Bin.
Recovering	The instance is being recovered from Recycle Bin.

Click a RocketMQ instance name to go to the instance overview page.

RocketMQ instance details include instance, storage, connection, network, and payment information.

Modifying Basic Information of a RocketMQ Instance

Log in to the console.
Click in the upper left corner to select a region.

DMS for RocketMQ instances in different regions cannot communicate with each other over an intranet. Select a nearest location for low latency and fast access.
Click and choose Middleware > Distributed Message Service for RocketMQ to open the console of DMS for RocketMQ.
Click a RocketMQ instance name to go to the instance overview page.

Modify parameters.

**Table 2** Connection information
Parameter	Description
Instance Name	To modify the instance name, click . You can customize a name that complies with the rules: 4–64 characters; starts with a letter; can contain only letters, digits, hyphens (-), and underscores (_). Services are not affected.
Enterprise Project	To modify the enterprise project, click . Services are not affected.
Description	To modify the description, click . Services are not affected.
Public Access	Click to enable or disable public access. For details, see Configuring Public Access for a RocketMQ Instance. Disable the public access setting of a connected RocketMQ instance interrupts the connection. As a result, messages fail to be produced and consumed.
Instance Address (Public Network)	This parameter is displayed only when public access is enabled. Address for connecting to the instance when public access is enabled. Instances with IPv6 enabled temporarily do not support public access in the CN East2 region. Modify the public connection address of a connected RocketMQ instance interrupts the connection. As a result, messages fail to be produced and consumed.
SSL	Access mode of the instance, can be changed as required. For details, see Configuring SSL of a RocketMQ Instance. Options: SSL: Ciphertext access with high security, but lower performance. PLAINTEXT: Plaintext access with high performance, but lower security. PERMISSIVE: Both ciphertext and plaintext access, depending on the client. Modifying the access mode may have impact. For more information, see Table 1.
ACL	ACL status of the instance. Click to enable ACL. For details, see Enabling RocketMQ ACL. When ACL is enabled, message production and consumption require authentication. Enabling ACL of a connected RocketMQ instance causes message production and consumption failures. NOTE: This parameter can be configured only for instances purchased after August 21, 2021.
Flexible TPS	This parameter is mandatory for a RocketMQ 5.x professional edition instance. Flexible TPS status of the instance. Click to enable it as prompted. For details, see Enabling Flexible TPS for a RocketMQ Instance. When flexible TPS is disabled, if the total message production and consumption throughput per second of an instance exceeds the basic TPS upper limit, the traffic will be limited. As a result, message production and consumption fail.
Message Retention	Click to modify message retention. For details, see Changing RocketMQ Message Retention Period. Modifying message retention does not restart the instance. But messages whose retention expires will be deleted and cannot be consumed.
Security Group	To modify the security group, click . Modifying the security group to exclude the IP address of the RocketMQ instance will interrupt the connected instance, causing message production and consumption failures.

After the parameters are modified, view the result in the following ways:

After you change Instance Name, Description, Public Access, Flexible TPS, ACL, Message Retention, Enterprise Project, and Security Group, the result is displayed in the upper right corner.
If SSL has been modified, go to the Background Tasks page to view the task progress and result.