Help Center/ Distributed Message Service for RocketMQ/ User Guide/ Managing Instances/ Viewing and Modifying Basic Information of a RocketMQ Instance
Updated on 2024-09-20 GMT+08:00

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

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

    Select the region where your RocketMQ instance is located.

  3. Click and choose Middleware > Distributed Message Service for RocketMQ to open the console of DMS for RocketMQ.
  4. 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, 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.

    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 public access configurations or instance specifications are being modified.

    Change failed

    The public access configurations or instance specifications failed to be modified.

    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.

  5. Click a RocketMQ instance name to go to the instance details page.

    Parameters for connecting to an instance are listed in Table 2 and Table 3. For details about other parameters, see the Basic Information tab page of the instance on the console.

    Table 2 Connection information (DMS for RocketMQ 4.8.0)

    Parameter

    Description

    Instance Address

    Address for connecting to the instance when public access is disabled.

    SSL

    SSL status of the instance.

    Public Access

    Indicates whether public access is enabled. Click to enable or disable public access.

    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.

    ACL

    ACL status of the instance. Click to enable ACL.

    When ACL is enabled, message production and consumption require authentication.

    NOTE:

    This parameter can be configured only for instances purchased after August 21, 2021.

    Table 3 Connection information (DMS for RocketMQ 5.x)

    Parameter

    Description

    Instance Address

    Address for connecting to the instance over TCP when public access is disabled.

    gRPC Connection Address

    Address for connecting to the instance over gRPC when public access is disabled.

    Public Access

    Indicates whether public access is enabled. Click to enable or disable public access.

    Instance Address (Public Network)

    This parameter is displayed only when public access is enabled.

    Address for connecting to the instance over TCP when public access is enabled.

    gRPC Connection Address (Public Network)

    This parameter is displayed only when public access is enabled.

    Address for connecting to the instance over gRPC when public access is enabled.

    ACL

    ACL status of the instance. Click to enable ACL.

    When ACL is enabled, message production and consumption require authentication.

Modifying Basic Information of a RocketMQ Instance

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

    Select the region where your RocketMQ instance is located.

  3. Click and choose Middleware > Distributed Message Service for RocketMQ to open the console of DMS for RocketMQ.
  4. Click a RocketMQ instance name to go to the instance details page.
  5. Modify the following parameters if needed:

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

    After you change Instance Name, Description, Public Access, ACL, Message Retention, Enterprise Project, and Security Group, the result is displayed in the upper right corner.