Docs
EN
Docs
Console
Sign in
Message Queue for RocketMQ
Document
Message Queue for RocketMQ
Message Queue for RocketMQ
Document
What's New
Release Notes for New Features
Overview
What is Message Queue for RocketMQ
Benefits
Use cases
Features
Product specifications
Related concepts
Limits
Message Queue | MQ
Billing
Billing overview
Billable items
Billing method
Pay-as-you-go
Subscription
Switching to subscription
Renewal
Arrears and expiration
Unsubscription and configuration change
Taxes and invoices
Getting Started
Overview
Preparing your environment
Creating resources
Producing and consuming normal messages
User Guide
Instance management
Lifecycle
Creating instances
Upgrading instances
Deleting instances
Viewing instance details
Connections
Configuring public access and SSL authentication
Configuring public DNS resolution
Modifying domain prefixes of access points
Switching subnets
Accessing RocketMQ instances through PrivateLink
O&M
Configuring maintenance windows
Modifying TPS ratio
Tag
Tag overview
Binding tags
Filtering instances by tag
Editing or unbinding tags
Topic management
Creating topics
Importing topics in bulk
Exporting the topic list
Sending messages online
Configuring key permissions
Setting the number of the queues
Viewing consumption details
Deleting topics
Managing lite topics
Group management
Creating groups
Importing groups in bulk
Exporting the group list
Viewing consumption details
Resetting consumer offsets
Deleting groups
Key management
Creating keys
Configuring key permissions
Managing keys
Permission management
Managing ACL users
Managing ACL permissions
Message query
Message query
Message trace
Dead letter management
Dead-letter Message Overview
Dead-letter message management
Monitoring and alerting
View monitoring data
Set alarm policy
Recommended alarm rules
Risk inspection
Inspection overview
Start/Stop Risk Inspection
Inspection rules
Risk management
Background task management
View task management
Allowlist management
Create allowlist
Associate instances with the allowlist
disassociate instances from the allowlist
View allowlist information
Edit allowlist
Delete allowlist
Access control
Manage permissions based on IAM
Resources and actions for which the permissions can be granted
Cross-service access authorization
Terraform
Manage Message Queue for RocketMQ through Terraform
RocketMQ Agent
RocketMQ Agent Overview
Use RocketMQ Agent
API Reference
Usage note
How to call the API
Request structure
Service address
Signature method
Response
Common parameters
API overview
Resource check
DescribeRegions - Query Region
DescribeAvailabilityZones - Query the availability zone list
Instance management
Create Instance - Create instance
DescribeInstances - Query instances list
DescribeInstanceDetail - Query instance details
DeleteInstance - Delete instance
ModifyInstanceAttributes - Modify instance information
ModifyInstanceSpec - Modify instance specification
ModifyInstanceChargeType - change billing method
EnableInstanceBurstTps - Enable or disable instance burst TPS capability
EnableAutoCreateGroup - Enable or disable the instance's automatic group creation capability
Network management
CreatePublicAddress - Enable public network access
DeletePublicAddress - Disable public network access
Topic management
CreateTopic - Create topic
DeleteTopic - Delete Topic
DescribeTopicAccessPolicies - Query Topic permission list
ModifyTopicAccessPolicies - Modify topic permissions
DescribeTopicDetail - Query topic details
DescribeTopics - View topic list
DescribeTopicQueue - View Topic queue information
DescribeTopicGroups - View the list of groups under the topic
MessageSend - Send message
CreateTopicAsync - Create Topic asynchronously
DeleteTopicAsync - Delete Topic asynchronously
ModifyTopicDescription - Modify the topic description
DescribeProducers - Check producer connection status
Group management
CreateGroup - Create Group
DeleteGroup - Delete Group
DeleteGroups - Batch delete Groups
DescribeGroups - Retrieve instance group list
DescribeGroupsDetail - View Group details
DescribeConsumedTopics - View topics subscribed by the group
DescribeConsumedTopicDetail - View group consumption details
DescribeConsumedClients - View information about clients connected to the group
ResetConsumedOffsets - Reset consumption offsets
CreateGroupAsync - Create Group asynchronously
DeleteGroupAsync - Delete Group asynchronously
UpdateGroup - Edit Group
DescribeConsumerGroupLag - Query group consumption backlog details
DeleteConsumerGroupSubscription - Delete consumer group subscription
Message query
QueryMessageByMsgId - Query messages by message ID
QueryMessageByMsgKey - Query messages by MessageKey
QueryMessageByTimestamp - Query messages by time
QueryMessageTraceByMessageId - Query message trace
Dead letter queue
QueryDLQMessageById - Query Group dead-letter messages by Message ID
QueryDLQMessageByGroupId - Query dead letter messages for a specific group within a time range
ResendDLQMessageById - Resend specified dead-letter message
Key management
CreateAccessKey - Create AccessKey secret
DescribeSecretKey - View the SecretKey of AccessKey
DeleteAccessKey - Delete AccessKey
Modify AccessKey default permissions
ModifyAccessKeyAuthority - Edit custom AccessKey permissions
DescribeAccessKeys - Query key list
DescribeAccessKeyDetail - View access key details
Risk inspection
EnableInstanceInspect - Enable or disable the risk inspection function for an instance
GetInspectConfig - Query the configuration related to inspection rules
ManualTriggerInspect - Manually trigger inspection
ManualProcessResult - Manually process inspection results
GetInstanceInspectResult - Query abnormal results from instance inspection
Allowlist management
CreateAllowList - Create access allowlist
ModifyAllowList - Edit access allowlist
DeleteAllowList - Delete access allowlist
DescribeAllowLists - Query the allowlist access records
DescribeAllowListDetail - Query a single allowlist detail
AssociateAllowList - Bind the allowlist to the instance
DisassociateAllowList - Unbind the allowlist from the instance
Tag management
AddTagsToResource - Add tags to instance
RemoveTagsFromResource - Remove tags from instance
DescribeTagsByResource - Query instance tags
Endpoint service
AddPLWhitelist - Add endpoint service allowlist
CreatePrivateLink - Create a private network connection endpoint service
DeletePrivateLink - Delete private network connection endpoint service
RemovePLWhitelist - Delete endpoint service allowlist
DescribePLWhitelist - Query endpoint service allowlist
Appendix
Error code list
Request idempotency
SDK Reference
RocketMQ 5.x
Overview
Parameter description
JAVA 5.x SDK
Overview
Standard message
Ordered message
Transactional message
Delayed message
GO 5.x SDK
Overview
Standard message
Ordered message
Transactional message
Delayed message
C++ SDK
Overview
Standard message
Ordered message
Transactional message
Delayed message
PYTHON SDK
Standard message
Ordered message
Transactional message
Delayed message
RocketMQ 4.x
Overview
Java SDK
Overview
Preparations
Standard message
Ordered messages
Transaction Message
Scheduled messages and delayed messages
Parameter description
Go SDK
Overview
Preparations
Standard message
Ordered messages
Transactional messages
Scheduled messages and delayed messages
Parameter description
Python SDK
Overview
Preparations
Standard Message
Ordered message
Transactional message
Scheduled messages and delayed messages
Parameter description
C++ SDK
Overview
Preparations
Standard message
Ordered messages
Transactional Message
Delayed message
Parameter description
RocketMQ management SDK
Overview
Best Practices
Business migration
Migration overview
RocketMQ service migration
RocketMQ instance adaptation scenarios
RocketMQ producer usage recommendations
RocketMQ Consumer Usage Recommendations
RocketMQ client usage recommendations
Deploy RocketMQ instances across availability zones
Consume RocketMQ messages through Function Service
RocketMQ cluster scaling best practices
FAQ
Product inquiry
Common issues with message sending
Documentation
Message Queue for RocketMQ
SDK Reference
RocketMQ 5.x
Overview
Copy page
Download PDF
RocketMQ 5.x
Overview
Copy page
Download PDF
Overview
Last updated: 2026.04.17 18:40:30