Help Center/ Distributed Message Service for Kafka/ User Guide (Kuala Lumpur Region)/ Managing Instances/ Viewing and Modifying Basic Information of a Kafka Instance
Updated on 2025-09-03 GMT+08:00

Viewing and Modifying Basic Information of a Kafka Instance

After creating a Kafka instance, you can view the details or modify some parameters of it on the console as required. These parameters include the instance name, description, security group, and capacity threshold policy.

Prerequisite

You can modify basic information of a Kafka instance when the instance is in the Running state.

Viewing Kafka Instance Details

  1. Log in to the console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. Click in the upper left corner and choose Application > Distributed Message Service for Kafka to open the Kafka instance list.
  4. Specific Kafka instances can be queried using filters. You can filter instances by name, status, version, instance type, flavor, used/available space, maximum partitions, billing mode, AZ, instance ID, private connection address, public connection address, enterprise project, and resource tag.

    • Only enterprise users can filter instances by enterprise projects.
    • Table 1 describes the various possible statuses of a Kafka instance.
      Table 1 Kafka 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.

      Restarting

      The instance is being restarted.

      Changing

      The instance specifications are being changed.

      Change failed

      The instance specifications failed to be changed.

      You cannot restart, delete, or modify an instance in the Change failed state. Contact customer service.

      Binning

      The instance is being moved to the recycle bin.

      Binned

      The instance is in the recycle bin.

      Recovering

      The instance is being recovered from the recycle bin.

  5. Click the name of the desired Kafka instance and view detailed information about the instance on the Overview tab page.

    Table 2 describes the parameters for connecting to a Kafka instance. For details about other parameters, see the Basic Information tab page of the Kafka instance on the console.

    Table 2 Connection parameters

    Section

    Parameter

    Description

    Connection

    Username

    Username for accessing the instance with SASL_SSL enabled.

    Kafka SASL_SSL

    Whether SASL_SSL is enabled.

    Security Protocol

    This parameter is displayed only after you enable Ciphertext Access.

    SASL Mechanism

    SASL mechanism used by the instance with SASL_SSL enabled.

    SSL Certificate

    Click Download to download the SSL certificate for accessing the instance.

    Instance Address (Private Network)

    Address for accessing the instance.

    The number of connection addresses is the same as that of brokers.

    Kafka Manager

    Indicates whether to disable Kafka Manager.

    After Kafka Manager is disabled, the Kafka Manager connection address will not be displayed on the console, the Kafka Manager password cannot be reset, and Kafka Manager cannot be restarted.

    Manager Username

    Username for connecting to Kafka Manager.

    Manager Address (Private Network)

    Address for connecting to Kafka Manager.

Modifying Basic Information of a Kafka Instance

  1. Log in to the console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. Click in the upper left corner and choose Application > Distributed Message Service for Kafka to open the Kafka instance list.
  4. Click the desired instance to go to the instance details page.
  5. Modify the following parameters if needed:

    Table 3 Modifiable Kafka parameters

    Parameter

    How to Modify

    Result

    Instance Name

    Click , enter a new name, and click .

    Naming rules: 4–64 characters; starts with a letter; can contain only letters, digits, hyphens (-), and underscores (_).

    The modification result is displayed in the upper right corner of the page.

    Description

    Click , enter a new description, and click .

    0 to 1024 characters.

    The modification result is displayed in the upper right corner of the page.

    Enterprise Project

    Click , select a new enterprise project from the drop-down list, and click .

    Only for enterprise users. Modifying this parameter does not restart the instance.

    The modification result is displayed in the upper right corner of the page.

    Security Group

    Click , select a new security group from the drop-down list, and click .

    Modifying this parameter does not restart the instance.

    The modification result is displayed in the upper right corner of the page.

    Capacity Threshold Policy

    Click the desired policy. In the displayed Confirm dialog box, click OK.

    Modifying this parameter does not restart the instance.

    When the policies are triggered, messages may be deleted or cannot be produced.

    You will be redirected to the Background Tasks page, which displays the modification progress and result.

    Automatic Topic Creation

    Enable/Disable this Automatic Topic Creation. In the displayed Confirm dialog box, click OK.

    Changing this option may restart the instance.

    You will be redirected to the Background Tasks page, which displays the modification progress and result.

    Cross-VPC Access

    See Accessing Kafka Using a VPC Endpoint Across VPCs.

    The modification result is displayed in the upper right corner of the page.