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.

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

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 Middleware > 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.
   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.

5. Click the name of the desired Kafka instance and view detailed information about the instance on the Basic Information 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.
   		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	Indicates whether plaintext access is enabled.
   		Address (Public Network, Plaintext)	This parameter is displayed only after you enable Plaintext Access.
   		Ciphertext Access	Indicates whether ciphertext access is enabled.
   		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	-	Click Download to download the SSL certificate for accessing the instance.

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 Middleware > 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.)
   • Smart Connect
   • Description
   • Security Group
   • Private Network Access (For details about how to modify it, see Configuring Plaintext or Ciphertext Access to Kafka Instances.)
   • Public Network Access (For details about how to modify it, see Configuring Kafka Public Access.)
   • Capacity Threshold Policy (Changing does not require instance restart.)
   • Automatic Topic Creation For details about how to enable or disable this setting, see Configuring Automatic Topic Creation.
   • Cross-VPC Access (For more information, see Accessing Kafka Across VPCs Using VPCEP and Accessing Kafka in Public Networks Using DNAT.)

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

   • If Capacity Threshold Policy, Public Network Access,, Private Network Access, 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, Cross-VPC Access, or Security Group has been modified, the result will be displayed in the upper right corner of the page.
   • If Smart Connect has been modified, go to the Background Tasks page to view the task progress and result.