Skip to Main Content

Restrictions

Overview​

To prevent various edge cases in production caused by unclear behavior definitions, AutoMQ Cloud enforces and standardizes parameters, quotas, and behaviors across its products. Users should ensure they do not violate these constraints while using the system. If these constraints do not align with actual usage scenarios, please promptly submit a support ticket for assistance, as referenced in Obtaining Services▸.

Limitations on Parameters​

The names and descriptions of resources within the following parameters have restricted values that cannot be adjusted. Please adhere strictly to the specifications to prevent system processing anomalies caused by special characters or excessive length.

Public Parameter Limitations​

Parameter Items

Limit Value


Description


Instance Name


  • Character Restrictions: Supports only Chinese characters, letters a-z or A-Z, numbers 0-9, underscores (_), and hyphens (-).
  • Length Restrictions: 3-64 characters.

Names and notes should preferably use simple, common phrases and abbreviations. Avoid using special characters that may cause display issues.


Instance Notes


  • Character Restrictions: Supports only Chinese characters, letters a-z or A-Z, numbers 0-9, underscores (_), and hyphens (-).
  • Length limit: 0 to 128 characters.

Environment Member Name


  • Character Restrictions: Only supports letters a-z or A-Z, digits 0-9, underscores (_), and hyphens (-).
  • Length Restrictions: 3-64 characters.

Environment Member Password


  • Character Restrictions: Only supports visible characters.
  • Length restriction: 8 to 16 characters.

Integration Name


  • Character Restrictions: Supports only Chinese characters, letters a-z or A-Z, numbers 0-9, underscores (_), and hyphens (-).
  • Length Restrictions: 3-64 characters.

Reassignment Name


  • Character Restrictions: Supports only Chinese characters, letters a-z or A-Z, numbers 0-9, underscores (_), and hyphens (-).
  • Length Restrictions: 3-64 characters.

Instance-Level Configuration​

Parameter Items

Limit Value


Description


log.retention.ms

Message Retention Period


  • Default value: 7 days
  • Range: 1 hour ~ 60 days
  • Can be customized and modified

The message retention period affects storage space consumption and cost. It is advisable for businesses to assess this carefully. If unsatisfactory, please Obtaining Services▸ Seek assistance.


message.max.bytes

Maximum message size


  • Default: 20 MiB
  • Constraint Value: 0 B ~ 50 MiB
  • Custom modification supported

If the current parameter limit does not meet your needs, please Obtaining Services▸ seek assistance.


offsets.retention.minutes

Consumption Progress Retention Duration


  • Limit: 7 days
  • Customization not supported
fetch.max.bytes

Single Data Fetch Limit


  • Limit: 55 MB
  • Custom modifications are not supported.

Single partition write throughput limit


  • Limit: 4 MBps
  • Custom modifications are not supported.

There are limitations on single partition read/write throughput. It is recommended that applications use different message keys to distribute the read/write load across different partitions to avoid partition hotspots. Please Obtaining Services▸ Seeking Assistance.


Single Partition Read Throughput Limit


  • Limit: 4 MBps
  • Customization not supported
auto.create.topics.enable

Auto-create Topic Switch


  • Default value: true
  • Constraint range: true/false
  • Can be customized and modified

It is recommended to disable the automatic creation of topics and instead manage all topics through the control system and Admin API to prevent them from becoming unmanageable.


num.partitions

Default number of partitions for created topics


  • Default value: 1

    • Limit range: 1-1024

  • Can be customized and modified

The default number of partitions to create for a topic when using automatic topic creation should be set reasonably at the cluster level to avoid consuming too many of the partition quota with automatically created topics.


automq.zone.cidr.blocks


Client source CIDR availability zone identification


    • Default value: None

    • Limit range: None

  • Can be customized and modified

The server matches the CIDR set in the current rule with the client's source IP to determine the client's corresponding availability zone. This configuration is used to optimize and eliminate cross-availability zone traffic for clients. The format specification for CIDR is {zoneId}@{cidr}<>{zoneId}@{cidr}. Different availability zones are separated by "<>", while multiple CIDR segments under the same availability zone are separated by ",".


Example:


  • Configuring multiple availability zones: az-1@10.0.0.1/30<>az-2@10.0.0.2/30.
  • Multiple CIDR segments under the same availability zone: az-1@10.0.0.1/30,10.0.0.2/30

Note: In the AWS environment, the availability zone identifier should be set as ZoneID rather than ZoneName. Regarding the difference between the two Reference Documentation 。



Topic-Level Configuration​

Parameter Items

Limit Value


Description


compression.type
  • Default value: producer
  • Constraint Value:
    • Zstd
    • lz4
    • Producer
    • Uncompressed
    • Snappy
    • gzip
      • Custom modification supported

Set the final compression type for the Topic. This configuration supports ('gzip', 'snappy', 'lz4', 'zstd'); in addition to these options, it also supports 'uncompressed', meaning no compression is applied. The 'producer' configuration value refers to retaining the compression type set by the producer.


cleanup.policy

Message cleanup policy


  • Default value: delete
  • Range limitation:
    • delete: Periodically remove the oldest messages based on the retention time.
    • compact: Periodically merge messages based on their keys, retaining only the latest version.
      • Can be customized and modified

In most business scenarios, it is recommended to use the delete type, and only use the compact type in scenarios where preserving state data is required.


retention.ms
  • Default Value: Uses current cluster configuration
  • Limit value: 1 hour to 60 days.
  • Custom modification supported

Configure a custom retention period for messages in a topic, applicable only to topics with a deletion clean-up policy. This configuration will override the default cluster settings.


max.message.bytes
  • Default Value: Uses current cluster configuration
  • Constraint Value: 0 B ~ 50 MiB
  • Custom modification supported

Set the maximum allowable record batch size for the current topic, and any messages exceeding this limit will be rejected.


message.timestamp.type
  • Default value: CreateTime
  • Constraint Value:
    • LogAppendTime
    • CreateTime
      • Can be customized and modified

Define whether the timestamp in the message corresponds to the message's creation time or the log append time. This value should be either 'create time' or 'log append time'.


retention.bytes
  • Default value: -1
  • Custom modification supported

This setting applies to topics with a delete cleanup policy and controls the maximum retention space for each partition. By default, there is no size limit, only a time limit. This restriction is at the partition level, so multiply it by the number of partitions to compute the topic-level retention space. This configuration overrides the cluster's default settings.


delete.retention.ms
  • Default value: 1 day
  • Limit value: 0 hours ~ 60 days
  • Custom modification supported

Set the retention time for deletion tombstones for Compact-type Topics, applicable only to Compact-type Topics. This configuration requires consumers to read messages within this timeframe to obtain the last valid snapshot; otherwise, they may read incomplete data.


Topic Naming


  • Character Restrictions: Only supports letters az or AZ, numbers 0~9, underscores (_), hyphens (-), and dots (.).
  • Length Limit: 1~250 characters.
  • Other restrictions: Cannot start with an underscore (_).

None.


Topic Notes


  • Character restrictions: Only supports Chinese characters, letters az or AZ, numbers 0~9, and underscore (_).
  • Length restrictions: 1~256 characters.

automq.table.topic.enable


  • Default value: false
  • Limit value: Boolean
  • Custom modification supported

Configure whether to enable AutoMQ Table Topic. When enabled, an Iceberg Table will be created for storing AutoMQ Table data.


automq.table.topic.commit.interval.ms


  • Default value: 5 min
  • Limit values: 10s, 15min
  • Custom modification supported

Set the data submission interval for AutoMQ Table Topic. A shorter submission interval increases data real-time performance but also raises processing costs, and vice versa.


automq.table.topic.namespace


  • Default: None
  • Limit values: This value must comply with the namespace/database naming requirements of the Catalog used by the current cluster
  • Modification not supported

Table Topic is within the Namespace in the Catalog.


automq.table.topic.upsert.enable


  • Default value: false
  • Limit value: Boolean
  • Custom modification supported

Control whether the Upsert feature of the Table Topic is enabled. Once enabled, the system automatically determines whether to insert a new record or update an existing record based on the primary key.


automq.table.topic.partition.by


  • Default: None
  • Constraint Value: String
  • Custom modification supported

Define the partitioning rules of the Table Topic by partitioning the data through fields or functions. For example, [bucket(name, 3), month(timestamp)] indicates hashing and bucketing by the name field, followed by partitioning by the month of timestamp.


automq.table.topic.id.columns


  • Default: None
  • Constraint Value: String
  • Custom modification supported

Specify the unique primary key column (composite primary key) of the table used to identify row-level data. The value is a comma-separated combination of columns, for example, [region, name] indicates the composite primary key consists of the region and name columns.


automq.table.topic.cdc.field


  • Default: None
  • Constraint Value: String
  • Custom modification supported

Specifies the field name for recording CDC (Change Data Capture) operation types. It identifies the type of database change operations, with values being a single character: I, U, or D, corresponding to data insert, update, and delete actions respectively.


automq.table.topic.schema.type


  • Default Value: schemaless
  • Constraint Value:
    • schema
    • schemaless
      • Configuration at creation, no modifications supported afterward

Supports two modes: schemaless (does not parse message content; writes are solely based on the Kafka message's own schema) and schema (requires predefining the schema of the message value in the schema registry and writes to Iceberg based on that schema).


Resource Quota Limits​

AutoMQ Cloud has established initial constraints on certain performance metrics and parameters based on its operational experience in large-scale production environments. In most cases, the default constraint range will meet your needs. However, if there are special circumstances where these do not suffice, please promptly submit a support ticket for assistance.

Environmental Public Resource Quota Limits​

Limit Item


Limit Value


Description


Total number of product instances allowed within a single environment


Refer to subscription plan version constraints


If current constraints are not met, seek help through a support ticket. Obtaining Services▸ 。


Number of member accounts in a single environment:


100


Instance Quota Limitations:​

AutoMQ Cloud has established initial constraints on certain performance metrics and parameters based on its operational experience in large-scale production environments. In most cases, the default constraint range will meet your needs. However, if there are special circumstances where these do not suffice, please promptly submit a support ticket for assistance.

Limit Item


Limit Value


Description


Single Instance (Cluster) Computing Specification


3AKU to 500AKU, offering the following capabilities:


  • Write Throughput: 60MBps~10000MBps
  • Read Throughput: 60MBps~10000MBps

The instance's compute specification denotes the maximum throughput capacity for sending and receiving messages on a single instance (cluster).


If there's a need for larger-scale clusters, please Obtaining Services▸ apply to raise the specification limits.


Limits on the Number of Topics per Instance


Defined by the compute specifications of the instance; see specification limits for further details. Billing Instructions for BYOC▸ 。


For security and stability purposes, it's advisable to separate different business operations into distinct instances to avoid consolidating all operations into one instance.


Maximum Number of Partitions per Single Instance (Cluster)


Maximum Request QPS per Single Instance (Cluster)


BYOC Version Deployment Region Restrictions​

Code
Name
us-east-1
US East (N. Virginia)
us-east-2
US East (Ohio)
us-west-1
US West (N. California)
us-west-2
US West (Oregon)
af-south-1
Africa (Cape Town)
ap-east-1
Asia Pacific (Hong Kong)
ap-south-2
Asia Pacific (Hyderabad)
ap-southeast-3
Asia Pacific (Jakarta)
ap-southeast-5
Asia Pacific (Malaysia)
ap-southeast-4
Asia Pacific (Melbourne)
ap-south-1
Asia Pacific (Mumbai)
ap-northeast-3
Asia Pacific (Osaka)
ap-northeast-2
Asia Pacific (Seoul)
ap-southeast-1
Asia Pacific (Singapore)
ap-southeast-2
Asia Pacific (Sydney)
ap-northeast-1
Asia Pacific (Tokyo)
ca-central-1
Canada (Central)
ca-west-1
Canada West (Calgary)
cn-north-1
China (Beijing)
cn-northwest-1
China (Ningxia)
eu-central-1
Europe (Frankfurt)
eu-west-1
Europe (Ireland)
eu-west-2
Europe (London)
eu-south-1
Europe (Milan)
eu-west-3
Europe (Paris)
eu-south-2
Europe (Spain)
eu-north-1
Europe (Stockholm)
eu-central-2
Europe (Zurich)
il-central-1
Israel (Tel Aviv)
me-south-1
Middle East (Bahrain)
me-central-1
Middle East (UAE)
sa-east-1
South America (São Paulo)