Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Situation Awareness
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive

Modifying Kafka Instance Configuration Parameters

Updated on 2024-05-30 GMT+08:00

Scenario

Your Kafka instances, topics, and consumers come with default configuration parameter settings. You can modify common parameters on the Kafka console. For details about parameters that are not listed on the console, see the Kafka official website.

Kafka instances have dynamic and static parameters:

  • Dynamic parameters: Modifying dynamic parameters will not restart the instance.
  • Static parameters: After static parameters are modified, you must manually restart the instance.
NOTE:

Configuration parameters of some old instances cannot be modified. Check whether your instance parameters can be modified on the console. If they cannot be modified, contact customer service.

Prerequisites

You can modify configuration parameters of a Kafka instance when the instance is in the Running state.

Modifying Kafka Instance Configuration Parameters

  1. Log in to the console.
  2. Click in the upper left corner to select a region.

    NOTE:

    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 the instance details.
  5. On the Parameters page, click Edit in the row containing the parameter to modify.

    Parameters of v1.1.0 instances are described in Table 2 and Table 1. Parameters of v2.3.0/v2.7 instances are described in Table 3 and Table 4.

    Table 1 Dynamic parameters (v1.1.0 instances)

    Parameter

    Description

    Value Range

    Default Value

    auto.create.groups.enable

    Whether to automatically create consumer groups.

    true/false

    true

    offsets.retention.minutes

    The longest period a consumption position can be retained starts from the time of submission. Positions retained beyond this duration will be deleted. Each time a consumption position is submitted to a topic partition, its retention period resets to 0. The unit is minute.

    This is a static parameter for instances created before May 1, 2023.

    1440–30240

    20160

    Table 2 Static parameters (v1.1.0 instances)

    Parameter

    Description

    Value Range

    Default Value

    min.insync.replicas

    If a producer sets the acks parameter to all (or -1), the min.insync.replicas parameter specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

    1–3

    1

    message.max.bytes

    Maximum length of a single message, in bytes.

    0–10,485,760

    10,485,760

    unclean.leader.election.enable

    Indicates whether to allow replicas not in the ISR set to be elected as the leader as a last resort, even though doing so may result in data loss.

    true or false

    true

    connections.max.idle.ms

    Idle connection timeout (in ms). Connections that are idle for the duration specified by this parameter will be closed.

    5000–600,000

    600,000

    log.retention.hours

    Duration (in hours) for retaining a log file.

    This parameter takes effect only for topics that have no aging time configured. If there is aging time configured for topics, it overrides this parameter.

    1–168

    72

    max.connections.per.ip

    The maximum number of connections allowed from each IP address. Request for new connections will be rejected once the limit is reached.

    100–20,000

    1000

    group.max.session.timeout.ms

    The maximum session timeout (in ms) for consumers. A longer timeout gives consumers more time to process messages between heartbeats but results in a longer time to detect failures.

    6000–1,800,000

    1,800,000

    default.replication.factor

    The default number of replicas configured for an automatically created topic.

    1–3

    3

    allow.everyone.if.no.acl.found

    When this parameter is set to true, all users can access resources without ACL rules.

    This parameter is displayed only when SASL is enabled for the instance.

    This parameter cannot be modified for instances created before September 15, 2023.

    true/false

    true

    num.partitions

    The default number of partitions configured for each automatically created topic.

    1–200

    3

    group.min.session.timeout.ms

    The minimum session timeout (in ms) for consumers. A shorter timeout enables quicker failure detection but results in more frequent consumer heartbeating, which can overwhelm broker resources.

    6000–300,000

    6000

    Table 3 Dynamic parameters (2.3.0/2.7 instances)

    Parameter

    Description

    Value Range

    Default Value

    min.insync.replicas

    If a producer sets the acks parameter to all (or -1), the min.insync.replicas parameter specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful.

    1–3

    1

    message.max.bytes

    Maximum length of a single message, in bytes.

    0–10,485,760

    10,485,760

    auto.create.groups.enable

    Whether to automatically create consumer groups.

    true/false

    true

    max.connections.per.ip

    The maximum number of connections allowed from each IP address. Request for new connections will be rejected once the limit is reached.

    100–20,000

    1000

    unclean.leader.election.enable

    Indicates whether to allow replicas not in the ISR set to be elected as the leader as a last resort, even though doing so may result in data loss.

    true or false

    true

    offsets.retention.minutes

    The longest period a consumption position can be retained starts from the time of submission. Positions retained beyond this duration will be deleted. Each time a consumption position is submitted to a topic partition, its retention period resets to 0. The unit is minute.

    This is a static parameter for instances created before May 1, 2023.

    1440–30240

    20160

    Table 4 Static parameters (2.3.0/2.7 instances)

    Parameter

    Description

    Value Range

    Default Value

    connections.max.idle.ms

    Idle connection timeout (in ms). Connections that are idle for the duration specified by this parameter will be closed.

    5000–600,000

    600,000

    log.retention.hours

    Duration (in hours) for retaining a log file.

    This parameter takes effect only for topics that have no aging time configured. If there is aging time configured for topics, it overrides this parameter.

    1–168

    72

    group.max.session.timeout.ms

    The maximum session timeout (in ms) for consumers. A longer timeout gives consumers more time to process messages between heartbeats but results in a longer time to detect failures.

    6000–1,800,000

    1,800,000

    default.replication.factor

    The default number of replicas configured for an automatically created topic.

    1–3

    3

    allow.everyone.if.no.acl.found

    When this parameter is set to true, all users can access resources without ACL rules.

    This parameter is displayed only when SASL is enabled for the instance.

    This parameter cannot be modified for instances created before September 15, 2023.

    true/false

    true

    num.partitions

    The default number of partitions configured for each automatically created topic.

    1–200

    3

    group.min.session.timeout.ms

    The minimum session timeout (in ms) for consumers. A shorter timeout enables quicker failure detection but results in more frequent consumer heartbeating, which can overwhelm broker resources.

    6000–300,000

    6000

    NOTE:
    • To modify multiple dynamic or static parameters at a time, click Modify above the parameter list.
    • If you want to restore the default values, click Restore Default in the row containing the desired parameter.

  6. Click Save.

    NOTE:

    Modifying dynamic parameters will not restart the instance. Static parameter modification requires manual restart of the instance.

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback