A Message Queue for Apache RocketMQ instance is a virtual machine resource that stores topics and group IDs. Create a Message Queue for Apache RocketMQ instance before sending or receiving messages with Message Queue for Apache RocketMQ. You can create, release, edit, and view instances in the Message Queue for Apache RocketMQ console.
Background information
Message Queue for Apache RocketMQ instances support subscription, pay-as-you-go, and serverless billing. Choose specifications based on your needs. Compare options in Instance specifications and Billing overview.
Prerequisites
Create an instance
-
Log on to the Message Queue for Apache RocketMQ console, and in the left navigation bar, click Instances.
-
In the top navigation bar, select a region, such as China (Hangzhou).
-
On the Instances page, click Create Instance. In the Create Message Queue for Apache RocketMQ Instance panel, set Instance Version to V5.0, select a Product Type, and then click OK.
Message Queue for Apache RocketMQ supports the following product types:
-
Subscription: Monthly fee for instance compute specifications.
-
Pay-as-you-go: Hourly fee for instance compute specifications.
-
Serverless: Pay based on the total number of message requests.
NoteServerless instances are available in select regions. Check Available regions for current coverage. The regions that support shared and dedicated billing methods for serverless instances are China (Hangzhou), China (Zhangjiakou), China (Beijing), China (Shenzhen), Singapore (Singapore), Germany (Frankfurt), US (Virginia), and US (Silicon Valley).
-
-
On the product purchase page, select instance specifications, click Calculating, and then complete the payment as prompted.
The following tables show example values. Compare all parameters and valid values in Select product editions.
Serverless
Parameter
Example value
Primary Series Type
Standard
Billing Model
Defaults to Pay-by-request.
Message Storage Specification
No capacity selection required. Billed by actual storage usage.
VPC ID
vpc-bp1cg09dua6sgh0******
The ID of the VPC that you created in the "Prerequisites" section.
ImportantThe VPC cannot be changed after a Message Queue for Apache RocketMQ instance is created. To use a different VPC, release the Message Queue for Apache RocketMQ instance and create a new one.
vSwitch ID
vsw-bp1vqb0p9nz3irz******
The ID of the vSwitch that you created in the "Prerequisites" section.
You must specify two vSwitch ID values for a serverless instance.
ImportantThe vSwitch cannot be changed after a Message Queue for Apache RocketMQ instance is created. To use a different vSwitch, release the Message Queue for Apache RocketMQ instance and create a new one.
Internet Access
Disabled
NoteThis example uses VPC access to a Message Queue for Apache RocketMQ server. Public access is disabled by default. To access Message Queue for Apache RocketMQ over the internet, enable
Public Access Type.Intranet Access Type
Defaults to Pay-by-traffic.
Alibaba Cloud PrivateLink provides private VPC connectivity to Message Queue for Apache RocketMQ. PrivateLink incurs separate charges. Billing.
Resource Group
Select the default resource group.
Security Group
The security group that you created in the "Prerequisites" section.
-
Add an access policy that allows inbound TCP traffic on destination ports 8080 and 8081.
-
Managed security groups are not supported.
Subscription or pay-as-you-go
Parameter
Example value
Primary Series Type
Standard
Sub-series Type
Cluster High-availability Edition (Recommended for production environments)
Message Sending/Receiving Compute Specification
rmq.s2.2xlarge
VPC ID
vpc-bp1cg09dua6sgh0******
The ID of the VPC that you created in the "Prerequisites" section.
ImportantThe VPC cannot be changed after a Message Queue for Apache RocketMQ instance is created. To use a different VPC, release the Message Queue for Apache RocketMQ instance and create a new one.
vSwitch ID
vsw-bp1vqb0p9nz3irz******
The ID of the vSwitch that you created in the "Prerequisites" section.
ImportantThe vSwitch cannot be changed after a Message Queue for Apache RocketMQ instance is created. To use a different vSwitch, release the Message Queue for Apache RocketMQ instance and create a new one.
Public Access Type
Disabled
NoteThis example uses VPC access to the Message Queue for Apache RocketMQ server. Public access is disabled by default. To access Message Queue for Apache RocketMQ over the internet, enable Public Access Type.
Resource Group
Select the default resource group.
Disk Encryption
Disabled
NoteDisk encryption is supported only for Platinum Edition instances.
Disk Encryption Key
key-hzz66c8207****
NoteThe disk encryption key ID in the same region. Required only when Disk Encryption is set to Enable.
-
View instance list
-
Log on to the Message Queue for Apache RocketMQ console, and in the left navigation bar, click Instances.
-
In the top navigation bar, select a region, such as China (Hangzhou).
-
The Instances page lists all instances in the selected region.
View instance details
-
Go to the Instances page. In the instance list, click the name of the target instance.
-
The Instance Details page displays the instance configuration and status.
Edit an instance
-
Go to the Instances page. In the instance list, click the name of the target instance.
-
On the Instance Details page, click the Basic Information tab.
-
In the Overview section, click Edit. In the Modify Configuration panel, configure the following parameters and click Confirm.
Parameter
Description
Example value
Instance Name
The name of the instance.
rmq-cn-xxxx
Instance Description
The description of the instance.
test
Sending Percentage
Controls the send/receive throttling quota split. Defaults to 50% send and 50% receive. Adjust if your workload is read-heavy or write-heavy.
50
Receiving Percentage
50
Message Retention Period
Storage is fully serverless and elastic, billed by actual usage. Adjust the retention period to control costs. Minimum retention: 24 hours.
72
Release an instance
Releasing an instance permanently deletes all its topics, group IDs, and message data. This action cannot be undone.
Serverless and pay-as-you-go instances
Serverless and pay-as-you-go instances use postpaid billing and can be released directly in the console.
-
Go to the Instances page.
-
Find the instance that you want to release. In the Actions column, choose .
-
In the Note dialog box, click OK.
Subscription instances
Releasing a subscription instance triggers a partial refund based on actual usage duration. Unsubscribe from the instance to release it.
-
Go to the Instances page.
-
Find the instance that you want to release and click Details in the Actions column.
-
On the Instance Details page, click the Basic Information tab. In the Overview section, click Unsubscribe and follow the prompts.
Dashboard
The dashboard shows producer, billing, and throttling metrics for the instance. Metric details are covered in Dashboard.
-
Go to the Instances page. In the instance list, click the name of the target instance.
-
On the Instance Details page, click the Dashboard tab.
Related APIs
You can also manage instances with these API operations:
> Release