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 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
- Log in to the console.
- Click
in the upper left corner to select a region. Select the region where your Kafka instance is located.
- Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
- 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.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.
- 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
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
- Log in to the console.
- Click in the upper left corner to select a region.
Select the region where your Kafka instance is located.
- Click Service List and choose Application > Distributed Message Service. The Kafka instance list is displayed.
- Click the desired Kafka instance to view its details.
- 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.
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
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.