All Products
Search
Document Center

ApsaraMQ for Kafka:Configure and manage instance specifications

Last Updated:Feb 28, 2026

After deploying an ApsaraMQ for Kafka instance, adjust its traffic specifications, network type, message retention period, maximum message size, and consumer offset retention period to match your workload.

Prerequisites

An ApsaraMQ for Kafka instance is purchased, deployed, and in the Running state.

Configuration reference

The following table lists each configurable parameter, its behavior, and how to modify it.

Traffic specifications

ParameterDescriptionHow to modify
Reserved Capacity for Message PublishingThe reserved publishing throughput. Maximum elastic traffic equals twice this value. The instance is throttled when elastic traffic is exceeded.Option A: Click Upgrade or Downgrade in the upper-right corner of the Instance Details page. See Upgrade and downgrade instance configurations. Option B: On the Elasticity Policy tab of the Instance Details page, configure an elasticity policy. See Elasticity policies.
Reserved Capacity for Message SubscriptionThe reserved subscription throughput. Maximum elastic traffic equals twice this value. The instance is throttled when elastic traffic is exceeded.Same as above.

Network, message, and retention settings

ParameterDescriptionHow to modify
Network TypeControls network access. Options: Internet and VPC or VPC.Click Upgrade or Downgrade in the upper-right corner of the Instance Details page. See Upgrade and downgrade instance configurations.
Maximum Message SizeThe maximum size of a message that can be sent and received. Valid values: 1 MB to 10 MB. To request a larger size, please submit a ticket.Modify in the Configuration Information section of the Instance Details page.
Message Retention PeriodHow long messages are retained before deletion. Valid values: 24 to 8760 hours (up to 365 days). Default: 72 hours.Modify in the Configuration Information section of the Instance Details page.
Consumer Offset Retention PeriodHow long consumer offsets are retained after the last commit. Each new commit to a topic partition resets the countdown. Valid values: 24 to 720 hours (up to 30 days). Default: 7 days (10,080 minutes).Modify in the Configuration Information section of the Instance Details page.
Note

Before changing Maximum Message Size, verify that the new value matches your producer and consumer configurations.

Note

If a live consumer thread exists in a consumer group, its offsets are not deleted even after the Consumer Offset Retention Period expires. For details, see Why are expired consumer offsets retained?

Procedure

  1. Log on to the ApsaraMQ for Kafka console. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

  2. On the Instances page, click the name of the instance that you want to manage.

  3. On the Instance Details page, modify the parameters as described in the configuration reference above.

What to do next

View task execution records