Skip to Main Content

Restrictions

Overview​

In order to avoid various edge cases in the production environment due to undefined behavior, AutoMQ Cloud places constraints and specifications on parameters, quotas, and behaviors within the product scope. Users need to ensure they do not violate these constraints during usage. If any constraint does not meet the actual usage scenario, please promptly submit a ticket for assistance. Refer to Obtaining Services▸.

Parameter Limitations​

The naming and annotation limitation values for the following parameters and resources cannot be adjusted. Please strictly adhere to the specifications to avoid system processing anomalies caused by special characters or length overflows.

Public Parameter Limitations​

Parameter
Constraint Value
Description

Instance Name


  • Character limit: Only Chinese characters, letters a to z or A to Z, digits 0 to 9, underscores (_), and hyphens (-) are supported.
  • Length limit: 3 to 64 characters.

Names and notes should preferably use concise, common phrases and abbreviations, avoiding special characters that may cause display anomalies.


Instance Notes


  • Character limit: Only supports Chinese characters, letters a–z or A–Z, numbers 0–9, underscores (_), and hyphens (-).
  • Length limit: 0–128 characters.

Environment Member Name


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

Environment Member Password


  • Character limit: Only visible characters are supported.
  • Length limit: 8 to 16 characters.

Integration Name


  • Character limit: Only Chinese characters, letters a to z or A to Z, digits 0 to 9, underscores (_), and hyphens (-) are supported.
  • Length limit: 3 to 64 characters.

Reassignment Name


  • Character limit: Only Chinese characters, letters a to z or A to Z, digits 0 to 9, underscores (_), and hyphens (-) are supported.
  • Length limit: 3 to 64 characters.

Instance-Level Configuration​

Parameter
Constraint Value
Description
log.retention.ms

Message Retention Duration


  • Default value: 7 days
  • Restriction range: 1 hour ~ 60 days
  • Customizable

The message retention duration affects storage space consumption and costs. It is recommended to evaluate your business needs accordingly. If it cannot be met, please seek help by referring to Obtaining Services▸.


message.max.bytes

Maximum message size


  • Default value: 20 MiB
  • Range: 0 B ~ 50 MiB
  • Custom modification supported

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


offsets.retention.minutes

Retention period for consumer offsets


  • Limit: 7 days
  • Custom modification not supported
fetch.max.bytes

Limit for a single fetch


  • Limit: 55 MB
  • Custom modifications are not supported

Single partition write throughput limit


  • Limit: 4 MBps
  • Custom modifications are not supported

Single partition read/write throughput has limitations. 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▸ for assistance.


Single Partition Read Throughput Limit


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

Auto Create Topics Switch


  • Default: true
  • Valid values: true/false
  • Customizable

It is recommended to disable the auto creation of topics and manage all topics via the control system and Admin API to avoid unmanaged topics.


num.partitions

Default number of partitions created for a Topic


  • Default value: 1
  • Range: 1~1024
  • Customizable

The default number of partitions created for a Topic is used when automatically creating topics. It is recommended to set this at the cluster level reasonably to avoid excessive resource consumption due to automatic topic creation.


Topic-level Configuration​

Parameter
Constraint Value
Description
compression.type
  • Default value: producer
  • Allowed values:
    • Zstd
    • LZ4
    • Producer
    • Uncompressed
    • Snappy
    • gzip
    • Customizable

Set the final compression type for the Topic. This configuration supports ('gzip', 'snappy', 'lz4', 'zstd'). Besides these options, 'uncompressed' is supported, which means no compression. The 'producer' value indicates retaining the producer's configured compression type.


cleanup.policy

Message cleanup policy


  • Default value: delete
  • Restriction range:
    • delete: Periodically cleans up the earliest messages based on retention time.
    • compact: Periodically merges messages based on their key, retaining only the latest version.
      • Custom modification is allowed

The delete type is recommended for most business scenarios. Use the compact type only when retaining state data.


retention.ms
  • Default value: follow the current cluster configuration
  • Restriction value: 1 hour to 60 days
  • Custom modification is supported

Set the custom retention time for topic messages. This is only effective for topics with a cleanup policy of type "delete". This configuration will override the cluster default configuration.


max.message.bytes
  • Default value: Follows the current cluster configuration
  • Limit value: 0 B ~ 50 MiB
  • Supports custom modification

Set the maximum allowed size for record batches in the current topic. Messages exceeding this limit will be rejected.


message.timestamp.type
  • Default value: CreateTime
  • Limit value:
    • LogAppendTime
    • CreateTime
      • Can be customized

Define whether the timestamp in the message is the message creation time or the log append time. This value should be 'CreateTime' or 'LogAppendTime'.


retention.bytes
  • Default value: -1
  • Customizable

This setting is effective for topics with the delete cleanup policy, controlling the upper limit of retained data space per partition. By default, there is no size limit, only a time limit. This constraint is on the partition level, so multiply it by the number of partitions to calculate the topic-level retention space. This configuration overrides the cluster default settings.


delete.retention.ms
  • Default value: 1 day
  • Limits: 0 hours ~ 60 days
  • Customizable

This setting specifies the retention time for deletion tombstone records for compacted topics. It is only effective for compacted topics. Consumers must read the messages within this time frame to possibly obtain the latest valid snapshot; otherwise, consumers may read incomplete data.


Topic Naming


  • Character limit: Only supports letters az or AZ, numbers 0~9, underscore (_), hyphen (-), and dot (.).
  • Length limit: 1~250 characters.
  • Other restrictions: Underscore (_) cannot be at the beginning.

None.


Topic notes


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

automq.table.topic.enable


  • Default value: false
  • Limit value: Boolean
  • Supports custom modification.

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


automq.table.topic.commit.interval.ms


  • Default value: 5 min
  • Limit value: 10 s to 15 min
  • Supports custom modifications

Set the data submission interval for the AutoMQ Table Topic. The shorter the submission interval, the higher the data real-time processing accuracy, but it will also increase the processing cost, and vice versa.


automq.table.topic.namespace


  • Default value: None
  • Limit value: This value must comply with the naming requirements of the namespace/database in the current cluster's catalog
  • Cannot be modified

Namespace of the Table Topic within the catalog.


automq.table.topic.upsert.enable


  • Default: false
  • Restrictions: Boolean
  • Supports custom modification

Controls whether to enable the Upsert feature for the Table Topic. When enabled, the system will automatically decide whether to insert a new record or update an existing one based on the primary key.


automq.table.topic.partition.by


  • Default: 1 day
  • Restrictions: String
  • Supports custom modification

Defines the partitioning rules for the Table Topic using fields or functions to partition the data. For example, [bucket(name), month(timestamp)] means partition first by hashing the name field, then by the month of the timestamp field.


automq.table.topic.id.columns


  • Default: None
  • Restrictions: String
  • Supports custom modification

Specify the unique primary key column(s) of the table (composite primary key), used to identify row-level data. The value is a combination of columns separated by commas, such as [region, name] which indicates that the composite primary key consists of the region and name columns.


automq.table.topic.cdc.field


  • Default value: none
  • Constraint: string
  • Supports custom modification

Specify the field name that records the CDC (Change Data Capture) operation type. This field identifies the type of database change operation, with values such as I , U , or D corresponding to insert, update, and delete actions respectively.


automq.table.topic.schema.type


  • Default value: schemaless
  • Constraint:
    • schema
    • schemaless
      • Configure at creation, no modification supported thereafter

Supports two modes: schemaless (does not parse message content, writes based only on the Kafka message schema) and schema (requires pre-defining the message value schema in a schema registry and writes to Iceberg based on this schema).


Resource Quota Limitations​

AutoMQ Cloud, leveraging operational experience from large-scale production environments, imposes initial constraints on certain performance metrics and parameters within the product. In most cases, the default constraints meet the requirements; however, if there are special circumstances where they do not, please promptly submit a support ticket for assistance.

Environmental Public Resource Quota Limits​

Constraint Item
Constraint Value
Description

Total number of product instances allowed within a single environment


Refer to subscription plan constraints


If the current limitations are unsatisfactory, seek help through a work order Obtaining Services▸ .


Number of member accounts in a single environment


100 accounts


Instance Quota Limitations​

AutoMQ Cloud, leveraging operational experience from large-scale production environments, imposes initial constraints on certain performance metrics and parameters within the product. In most cases, the default constraints meet the requirements; however, if there are special circumstances where they do not, please promptly submit a support ticket for assistance.

Constraint Item
Constraint Value
Description

Single instance (cluster) computing specifications


3AKU ~ 500AKU, offering the following capabilities:


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

Instance computing specifications represent the maximum throughput capacity for receiving and processing messages in a single instance (cluster).


For larger cluster demands, please Obtaining Services▸ to apply for higher specifications.


Maximum Number of Topics per Single Instance


Determined by the compute specifications of the created instance. Please refer to the specific specification restrictions Billing Instructions for BYOC▸ .


For security and stability, it is recommended to distribute different businesses across separate instances to avoid concentrating all businesses in a single instance.


Maximum Number of Partitions per Single Instance (Cluster)


Maximum QPS per Single Instance (Cluster)


BYOC 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)