Docs
EN
Docs
Console
Sign in
Cloud Native Message Engine
Document
Cloud Native Message Engine
Cloud Native Message Engine
Document
Product Billing
Billing description
Renewal description
Description of arrears or expiration
Costs for unsubscribing or configuration change
BMQ Instance User Guide
BMQ overview
What is BMQ
Use cases
Instance specifications
Glossary of terms
Regions and availability zones
Message Queue | MQ
Getting started
Create BMQ resources
Send and receive messages using the Java SDK
Console guide
Instance management
Instance lifecycle management
Create a BMQ instance
View BMQ instance details
Change instance specification
Delete a BMQ instance
Instance configuration management
Switching subnets and security groups
Modify global message retention period
Instance connection management
Configure private network access
Configure public network parsing
Configure public network access
Topic management
Create topic
Expand topic number of partitions
Preview Topic data
View topic details
Modify message retention period
Delete Topic
Group management
Create Group
Reset consumption offsets
View Group details
Delete Group
Message query
Message query
Download messages
SASL user management
Create SASL user
Configure the All Permitted function for a user
View SASL user password
Delete SASL user
ACL management
Create ACL
Delete ACL
Monitoring and alarm
View monitoring data
Configure alarm strategies
Best practices
Monitoring single partition traffic for Topic
Consuming BMQ through veFaaS
Best practices for consumer
SDK reference
Java SDK
Go SDK
Python SDK
API reference
Read before you start development
API overview
How to call an API
Request structure
Common parameters
Authentication and authorization
Response
Instance specifications
ListSpecifications - Query BMQ specifications available for sale
Instance management
Create Instance - Create instance
DeleteInstance - Delete instance
ModifyInstanceTag - Edit instance tags
DescribeInstance - Query instance details
SearchInstances - Query instances
UpdateInstanceMessageRetention - Modify instance message retention period
ListInstanceResourceStats - Query multiple instance resources
DescribeInstanceResourceStat - Query a single instance resource
Instance connection management
EnableOverlayAccess - Enable private network access
DisableOverlayAccess - Disable private network access
ModifyOverlayAccess - Modify private network
ListAvailableVPCForBMQ - Query available VPC list
ListAvailableSecurityGroupsForBMQ - Query the list of available security groups
EnablePublicAccess - Enable public network access
DisablePublicAccess - Disable public network access
ListAvailableVPCForBMQ - Retrieve the list of VPCs available for BMQ
ListAvailableSubnetsForBMQ - Retrieve the list of subnets available for BMQ
DescribeAvailableZones - Availability zone list
ListAvailableSecurityGroupsForBMQ - Retrieve the list of security groups available for BMQ
Topic management
CreateTopic - Create Topic
DeleteTopic - Delete Topic
ScaleUpTopic - Increase the number of topic partitions
DescribeTopic - Query Topic details
SearchTopics - Query Topic
DescribePartitionsInTopic - Query Topic partitions
DescribeGroupsInTopic - Query the list of subscribed consumer groups
UpdateTopicMessageRetention - Modify topic message retention period
PreviewTopicData - Preview Topic data
DescribeTopicTimeRange - Query the time range of Topic message production
TopicExist - Determine whether the Topic exists
Group management
CreateGroup - Create consumer group
DeleteGroup - Delete consumer group
GroupExist - Determine whether the consumer group exists
DescribeGroup - Query consumer group details
SearchGroups - Query consumer group list
DescribeTopicsInGroup - Query the list of subscribed Topics
DescribeSubscription - Query subscription partition list
ResetSubscriptionOffset - Reset consumption offset
FAQ
MQTT Instance User Guide
MQTT introduction
Cloud native message engine for MQTT
Features
Glossary of terms
Notice regarding MQTT scaling and upgrade risks
Message Queue | MQ
Console guides
MQTT instance management
Create an MQTT instance
View MQTT instance information
Scale up MQTT instance
Delete MQTT instance
Listener management
Add a public network listener
Add a private network listener
Delete listener
User management
Create users
Edit user
Change user password
Delete user
API key management
Create API keys
Enable or disable API keys
Edit API key
Delete API keys
MQTT Agent
MQTT Agent overview
Use MQTT Agent
API reference
MQTT listener
CreateDashboardEndpoint - Create a dashboard access endpoint
DeleteDashboardEndpoint - Delete dashboard access endpoint
MQTT key
UnRegisterDeviceCredential - Delete MQTT user device access credentials
RefreshDeviceCredential - Update MQTT user device access credentials
DescribeDeviceCredential - Query MQTT user device access credentials
RegisterDeviceCredential - Register MQTT user device access credentials
MQTT public API
DescribeMQTTClients - Query EMQX client connection information list
Dashboard guide
Log in to Dashboard
Monitoring
Cluster overview
Client
Subscription management
Retained messages
Delayed publishing
Access control
Client authentication
Client authentication overview
Create client authentication
Create password-based authentication
Create JWT authentication
Create SCRAM authentication
Manage client authentication
User management
View authentication overview
Client authorization
Client authorization overview
Create client authorization
Manage client authorization
Configure built-in database authorization rules
View the authorization overview
Configure authorization
Blocklist
Create a denylist
Delete denylist
Connection jitter
Configure connection jitter
Integrate
Flow Designer
Create flow
View Flow
Rules
Create a rule
Manage rules
View rules
Connector
Create a connector
Manage connector
Management
Cluster configuration
MQTT configuration
Logs
Monitoring
MQTT advanced features
Topic rewrite
Automatic subscription
Delayed publish
Problem analysis
Topic monitoring
Slow subscription
Log tracing
System settings
Audit log
Backup and restore
Best practices
Quickly build your first MQTT connection
Testing EMQX with MQTTX CLI
eMQTT-Bench testing EMQX
Implement P2P command delivery through automatic subscription
Device status reporting to Kafka
Export OpenTelemetry data
Modify cluster status using REST API
Proxy Protocol passthrough
Real-time retrieval of the number of discarded messages for a topic
Detect abnormal device disconnection using Last Will message
Migrating from EMQX v5 to MQTT Cloud Service
MQTT integration of Trace into TLS
Documentation
Cloud Native Message Engine
MQTT Instance User Guide
Console guides
Listener management
Delete listener
Copy page
Download PDF
Listener management
Delete listener
Copy page
Download PDF
Delete listener
Last updated: 2026.01.26 16:05:27