Viewing Instance
Last updated: 2025-09-19 10:43:14
Scenarios
After successfully creating a CKafka instance, you can view the instance status or adjust basic information of the instance in the console at any time, including instance name, description, resource tags, and access address, to ensure the instance configuration always meets your business requirements. This document describes how to view basic information of the instance in the console and modify and manage these basic configuration items.
Viewing Instance Basic Info
1. Log in to the CKafka console.
2. Select Instance List in the left sidebar. On the instance list page, you can view the lifecycle status of the instance.
The lifecycle of a CKafka instance refers to all statuses from the start of the instance to its release. Proper management of instances from startup to termination ensures that applications running on instances can provide services efficiently and economically. The statuses of an instance are as follows:
State | Status Attribute | Status Description |
Creating | Intermediate status | After the instance is created, it enters the status before it is running. |
Running (Healthy/Alarm) | Steady status | The normal running status of the instance indicates that your disk, traffic, and number of connections are within the planned range. |
Migrating | Intermediate status | Instances migrate data during configuration upgrades, downgrades, or AZ modifications. |
Deleting | Intermediate status | Instances are deleted by the console or through the API. |
Isolated. | Intermediate status | Instances in annual and monthly payment mode are terminated by the console or your instance is in arrears and enters the 7-day isolation status. Instances in pay-as-you-go mode do not have this state. |
Failed to create. | Intermediate status | The instance purchase is successfully charged via the console or API, but the instance allocation fails. If this happens, please contact Online Customer Service for assistance. |
Deletion Failed | Steady status | The instance is manually deleted or not renewed 7 days after expiration (including the 7th day), and CKafka fails to release resources. |
3. After selecting a region, click the ID of the target instance. On the Basic Information page, you can view instance health status, configuration message, access method, message retention, and automatic creation Topic information.
Parameter | Description |
Basic Information | Show the basic information of the instance, such as name, version, and region. You can adjust some parameters in this module based on actual business needs. |
Connection Method | Show the public IP address of an instance and intranet access point information. For details, refer to Configure Network Connection. |
Monitor instances with Prometheus | Provides open source standard-based Prometheus Exporter access method, including instance-level metrics and node-level metrics, a series of open-source Kafka monitorable metrics, supporting seamless integration with user self-owned ops platform. For details, refer to Integrate Prometheus Monitoring. |
Configuration Information | Show instance specifications, such as bandwidth, number of topics, and number of partitions. You can learn about the usage of instance quota in this module. If there is insufficient resources, you can scale up in a timely manner. For details, refer to Change Instance Specification. |
Instance Billing Info | Show the billing mode and start time of the instance, elastic scaling enabled, elastic bandwidth, and storage capacity. |
Topic global field settings | Global field settings are for configuration of the default initial value when creating a new topic under an instance. For details, refer to Configure Topic Global Field Settings. |
Auto create Topic | Once enabled, when a client produces or consumes messages to/from a non-existing topic, it will automatically use the configured number of replicas and partitions to create one. For details, refer to Create Topic. |
Consumer Group Configuration | Supports enabling/disabling auto creation of consumer groups and configuring auto cleanup duration for empty consumer groups. For details, refer to Create Consumer Group and Configure Auto Cleanup Duration for Empty Consumer Groups. |
Modifying Instance Basic Info
On the cluster basic information page, you can modify the following parameters.
Parameter | Modification Method |
Name | Click the Edit Button next to "Name", enter the instance name, then click Submit. The name must comply with the naming convention: it cannot exceed 128 characters. |
Instance Version Table | Click Upgrade next to Instance Version to upgrade the kernel minor version. For details, see Upgrading Instance Kernel Minor Version. |
AZ | Click the Edit Button next to "AZ" to modify the instance availability zone or upgrade from single availability zone to multi-availability zone. For details, see Modifying Instance Availability Zone. |
Tag | Click the Edit Button next to "Resource Tag" to bind or modify tags for the cluster. For detailed usage about tags, refer to Configure Resource Tag. |
System maintenance time | Click the Edit Button next to "System Maintenance Time" to set the system's maintenance time and period. For details, see Set System Maintenance Time. |
Instance destruction protection | Click the Edit Button next to "Instance destruction protection" to enable or disable termination protection of the instance. Once the switch is turned on, the instance cannot be accessed through console or API. For details, see Configure Instance Destruction Protection. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No
Feedback