Help Center/ Distributed Message Service for Kafka/ User Guide/ Managing Instances/ Viewing and Modifying Basic Information of a Kafka Instance
Updated on 2025-09-11 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.

Notes and Constraints

Single-node instances do not support reconfiguration of Smart Connect and private network access.

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 Kafka console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. 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.

      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 the recycle bin.

      Binned

      The instance is in the recycle bin.

      Recovering

      The instance is being recovered from the recycle bin.

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

    Table 2 and Table 3 describe 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 (SASL_SSL cannot be changed)

    Section

    Parameter

    Description

    Connection

    Username

    Username for accessing the instance with SASL_SSL enabled.

    Kafka SASL_SSL

    Whether SASL_SSL is enabled.

    This function is unavailable for single-node instances.

    Security Protocol

    Security protocol used by the instance with SASL_SSL 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 connecting to the instance when public access is disabled.

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

    Manager Address (Private Network)

    Address for connecting to Kafka Manager when public access is disabled.

    Instances created since May 17, 2023 do not have this address.

    Manager Username

    Username for connecting to Kafka Manager.

    Instances created since May 17, 2023 do not have this username.

    Public Access

    Indicates whether public access has been enabled for the instance.

    Instance Address (Public Network)

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

    This parameter is displayed only when public access is enabled.

    Manager Address (Public Network)

    Address for connecting to Kafka Manager when public access is enabled.

    This parameter is displayed only when public access is enabled.

    Instances created since May 17, 2023 do not have this address.

    Intra-VPC Plaintext Access

    Whether intra-VPC plaintext access is enabled.

    Table 3 Connection parameters (plaintext and ciphertext access)

    Section

    Parameter

    Sub-Parameter

    Description

    Connection

    Username

    -

    Username for accessing the instance with ciphertext access enabled.

    Private Network Access

    Plaintext Access

    Indicates whether plaintext access is enabled.

    Address (Private Network, Plaintext)

    This parameter is displayed only after you enable Plaintext Access.

    Ciphertext Access

    Indicates whether ciphertext access is enabled.

    This function is unavailable for single-node instances.

    Address (Private Network, Ciphertext)

    This parameter is displayed only after you enable Ciphertext Access.

    Security Protocol

    This parameter is displayed only after you enable Ciphertext Access.

    Public Network Access

    Toggle switch

    Indicates whether public access has been enabled.

    Plaintext Access

    This parameter is displayed only when Public Access is enabled.

    Indicates whether plaintext access is enabled.

    Address (Public Network, Plaintext)

    This parameter is displayed only after you enable Plaintext Access.

    Ciphertext Access

    This parameter is displayed only when Public Access is enabled.

    Indicates whether ciphertext access is enabled.

    This function is unavailable for single-node instances.

    Address (Public Network, Ciphertext)

    This parameter is displayed only after you enable Ciphertext Access.

    Security Protocol

    This parameter is displayed only after you enable Ciphertext Access.

    SASL Mechanism

    -

    This parameter is displayed only after you enable Ciphertext Access.

    SSL Certificate

    -

    This parameter is displayed only when SASL_SSL is enabled.

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

Modifying Basic Information of a Kafka Instance

  1. Log in to the Kafka console.
  2. Click in the upper left corner to select the region where your instance is located.
  3. Click the desired instance to go to the instance details page.
  4. Modify the following parameters if needed:

    Table 4 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.

    Smart Connect

    See Enabling Smart Connect and Disabling Smart Connect.

    To check the progress and result of the current task, go to the Instance > Background Tasks 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.

    Private Network Access

    See Configuring Plaintext or Ciphertext Access to Kafka Instances.

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

    Public Access

    See Configuring Kafka Public Access.

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

    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.

    Disk Autoscaling

    See Automatically Expanding the Storage Space of a Kafka Instance.

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

    Cross-VPC Access

    See Accessing Kafka Using a VPC Endpoint Across VPCs and Accessing Kafka in a Public Network Using DNAT.

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

Related Documents