Viewing and Modifying Basic Information of a Kafka Instance

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 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. You can filter Kafka instances by tag, status, name, version, flavor, used/available storage space, maximum partitions, billing mode, and enterprise project. Only enterprise users can filter instances by enterprise projects. 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 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.

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 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 15, 2024 do not have this address.
   	Manager Username	Username for connecting to Kafka Manager. Instances created since May 15, 2024 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 15, 2024 do not have this address.
   	Intra-VPC Plaintext Access	Whether intra-VPC plaintext access is enabled.

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:

   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.
   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.
   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.
   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.
   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.	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 and Accessing Kafka in a Public Network Using DNAT.	The modification result is displayed in the upper right corner of the page.