ApsaraMQ for RocketMQ:Manage instances

Create an instance

1. Log on to the Message Queue for Apache RocketMQ console, and in the left navigation bar, click Instances.

2. In the top navigation bar, select a region, such as China (Hangzhou).

3. 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 Billing Method, and then click OK.

   Message Queue for Apache RocketMQ supports the following billing methods:

   • 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.

     Note

     Serverless 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).

4. 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. Important The 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. Important The 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 Note This 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. Important The 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. Important The 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 Note This 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 Note Disk encryption is supported only for Platinum Edition instances.
   Disk Encryption Key	key-hzz66c8207**** Note The disk encryption key ID in the same region. Required only when Disk Encryption is set to Enable.

View instance list

1. Log on to the Message Queue for Apache RocketMQ console, and in the left navigation bar, click Instances.

2. In the top navigation bar, select a region, such as China (Hangzhou).

3. The Instances page lists all instances in the selected region.

Troubleshoot missing instances in the console

If you cannot find your instance on the Instances page, troubleshoot the issue by following these steps:

1. Check the region: In the top navigation bar of the console, select the region where you purchased the instance, such as China (Hangzhou). Instances in different regions are isolated from each other. Switching the region changes the instances shown in the list.

2. Check your orders: Go to the order list in the User Center, and filter by product name Message Queue for Apache RocketMQ. If no ApsaraMQ for RocketMQ order is found, no instance has been purchased under the current account.

3. Check your account: If no ApsaraMQ for RocketMQ order is found in the order list, go to the account recovery page to verify that you are logged on with the account used to purchase the instance.

4. Check RAM permissions: If you are using a RAM user, make sure that the RAM user is granted access to ApsaraMQ for RocketMQ. Instances of the ApsaraMQ for RocketMQ 5.x series use RAM authorization. Grant the RAM user the appropriate ApsaraMQ for RocketMQ permission policy. Do not use permission policies of other messaging products (such as ApsaraMQ for RabbitMQ). Grant the RAM user the permission policy for ApsaraMQ for RocketMQ.

View instance details

1. Go to the Instances page. In the instance list, click the name of the target instance.

2. The Instance Details page displays the instance configuration and status.

Edit an instance

1. Go to the Instances page. In the instance list, click the name of the target instance.

2. On the Instance Details page, click the Basic Information tab.

3. In the Overview section, click Edit. In the Modify Configurations 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
   Proportion Sent	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
   Proportion Received		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

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.

1. Go to the Instances page.

2. Find the instance that you want to release. In the Actions column, choose > Release.

3. 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.

1. Go to the Instances page.

2. Find the instance that you want to release and click Details in the Actions column.

3. 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.

1. Go to the Instances page. In the instance list, click the name of the target instance.

2. On the Instance Details page, click the Dashboard tab.

Related APIs

You can also manage instances with these API operations:

• CreateInstance

• UpdateInstance

• DeleteInstance

• ListInstances

• GetInstance