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 2024-05-30 GMT+08:00

Viewing and Modifying Basic Information of a Kafka Instance

Scenario

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

After creating a Kafka instance, you can modify some parameters of it as required, including the instance name, description, security group, and capacity threshold policy.

Viewing Kafka Instance Details

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

    Select the region where your Kafka instance is located.

  3. Click and choose Application > Distributed Message Service for Kafka to open the console of DMS for Kafka.
  4. Search for a Kafka instance by specifying filters. You can filter instances by tag, status, name, version, flavor, used/available storage space, maximum partitions, billing mode, and enterprise project. For Kafka instance statuses, see Table 1.

    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.

  5. Click the name of the desired Kafka instance and view detailed information about the instance on the Basic Information 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.

    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.

    Manager Address (Private Network)

    Address for connecting to Kafka Manager.

    Manager Username

    Username 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 a region.

    Select the region where your Kafka instance is located.

  3. Click and choose Application > Distributed Message Service for Kafka to open the console of DMS for Kafka.
  4. Click the desired Kafka instance to view its details.
  5. Modify the following parameters if needed:

    • Instance Name
    • Enterprise Project (Changing does not require instance restart.)
    • Description
    • Security Group
    • Capacity Threshold Policy (Changing does not require instance restart.)
    • Automatic Topic Creation (Changing requires instance restart.)

    After modifying them, view the result in one of the following ways:

    • If Capacity Threshold Policy or Automatic Topic Creation has been modified, the Background Tasks page will be displayed and you can view the task progress and result there.
    • If Instance Name, Description, Enterprise Project, or Security Group has been modified, the result will be displayed in the upper right corner of the page.