ApsaraMQ for RocketMQ:Manage instances

Create an instance

1. Log on to the ApsaraMQ for RocketMQ console. In the left-side navigation pane, 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 the Instance Version parameter to V5.0 and configure the Billing Method parameter. Then, click OK.

   ApsaraMQ for RocketMQ supports the following billing methods:

   • Subscription: An upfront payment is required based on the computing specification and subscription duration (in months) that you select for an instance.

   • Pay-as-you-go: Fees are post-paid based on the computing specification that you select for an instance and the actual usage duration (in hours) of the instance.

   • Serverless: Fees are calculated based on the total number of messaging requests.

     Note

     Serverless ApsaraMQ for RocketMQ instances are only available in specific regions. For more information, see Supported regions. Serverless instances that use shared or dedicated billing methods are available in the following regions: China (Hangzhou), China (Zhangjiakou), China (Beijing), China (Shenzhen), Singapore, Germany (Frankfurt), US (Virginia), and US (Silicon Valley).

4. On the buy page, select the specifications of the instance and click Buy Now. Then, follow the on-screen instructions to complete the payment.

   The following table describes how to configure the parameters on the buy page. For information about the specifications that are displayed on the buy page, see Instance selection.

   Parameters configured for a serverless instance

   Parameter	Example
   Primary Edition	Standard Edition
   Billing Method	Pay-by-Request is automatically specified.
   Message Storage Capacity	You do not need to specify the storage capacity. The system charges you based on actual storage usage.
   VPC ID	vpc-bp1cg09dua6sgh0****** The value of this parameter is the ID of the VPC that you created in the "Before you begin" section of this topic. Important After you create an instance, you cannot change the VPC in which the instance is deployed. If you want to change the VPC, you must release the instance and purchase a new instance.
   VSwitch ID	vsw-bp1vqb0p9nz3irz****** The value of this parameter is the ID of the vSwitch that you created in the "Before you begin" section of this topic. You must select two vSwitch IDs for a serverless ApsaraMQ for RocketMQ instance. Important After you create an instance, you cannot change the vSwitch with which the instance is associated. If you want to change the vSwitch, you must release the instance and purchase a new instance.
   Internet Access	Disable Note In this example, the client is connected to the RocketMQ broker in a VPC. By default, Internet access is disabled. If you want to access RocketMQ over the Internet, set this parameter to Enable.
   Internal Network Metering Method	Pay-by-Traffic is automatically specified. You can use PrivateLink to establish private connections between a VPC and RocketMQ. Internal network traffic fees are billed to PrivateLink. For more information, see Billing overview.
   Resource Group	Default Resource Group
   Security Group	The security group that you created in the "Before you begin" section of this topic. You can specify an access policy that allows inbound traffic over the TCP protocol and uses 8080 and 8081 as the destination ports. Managed security groups are not supported.

   Parameters configured for a subscription or pay-as-you-go instance

   Parameter	Example
   Primary Edition	Standard Edition
   Sub-category Edition	Cluster High-availability Edition (Recommended for Production Environments)
   Computing Specification	rmq.s2.2xlarge
   VPC ID	vpc-bp1cg09dua6sgh0****** The value of this parameter is the ID of the VPC that you created in the "Before you begin" section of this topic. Important After you create an instance, you cannot change the VPC in which the instance is deployed. If you want to change the VPC, you must release the instance and purchase a new instance.
   VSwitch ID	vsw-bp1vqb0p9nz3irz****** The value of this parameter is the ID of the vSwitch that you created in the "Before you begin" section of this topic. Important After you create an instance, you cannot change the vSwitch with which the instance is associated. If you want to change the vSwitch, you must release the instance and purchase a new one.
   Internet Access	Disable Note In this example, the client is connected to the RocketMQ broker in a VPC. By default, Internet access is disabled. If you want to access RocketMQ over the Internet, set this parameter to Enable.
   Resource Group	Default Resource Group
   Disk Encryption	Disable Note Only ApsaraMQ for RocketMQ 5.x Enterprise Platinum Edition instances support the disk encryption feature.
   Disk Encryption Key	key-hzz66c8207**** Note The ID of the key that is used for disk encryption in the region where the instance is deployed. This parameter is required only if you set the Disk Encryption parameter to Enable.

View the list of instances

1. Log on to the ApsaraMQ for RocketMQ console. In the left-side navigation pane, click Instances.

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

3. On the Instances page, view all instances that are created in the region.

View the details of an instance

1. On the Instances page, click the name of the instance that you want to manage.

2. On the Instance Details page, view the details of the instance.

Modify the configurations of an instance

1. On the Instances page, click the name of the instance that you want to manage.

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

3. In the upper-right corner of the Overview section, click Edit. In the Modify Configurations panel, configure the parameters and click OK. The following table describes the parameters.

   Parameter	Description	Example
   Instance Name	The name of the instance.	rmq-cn-xxxx
   Instance Description	The description of the instance.	test
   Proportion Sent	These percentages limit the traffic quotas for sending and receiving messages on an instance. When you create an instance, the default value is 50% for both. Adjust based on your workload. For example, decrease the sending percentage if you have fewer write requests than read requests.	50
   Proportion Received		50
   Message Retention Period	RocketMQ features serverless and flexible message storage. You are charged for message storage based on the occupied storage space. You can change the message retention period to control the storage space occupied by messages. To ensure secure production and stability, you must retain messages for at least 24 hours.	72

Release an instance

Release a serverless or pay-as-you-go instance

Serverless and pay-as-you-go instances use the pay-as-you-go billing method. If you no longer require a serverless or pay-as-you-go instance, you can release the instance in the console.

1. Go to the Instances page.

2. In the instance list, find the instance that you want to manage and choose > Release in the Actions column.

3. In the Note message, click OK.

Release a subscription instance

For subscription instances, refunds are involved. If you no longer require a subscription instance, you can unsubscribe from the instance. The system refunds you a portion of your payment based on the remaining usage duration.

1. Go to the Instances page.

2. In the instance list, find the instance that you want to manage and click Details in the Actions column.

3. On the Instance Details page, click the Basic Information tab. In upper-right corner of the Overview section of the tab, click Unsubscribe. Then, follow the on-screen instructions to complete the unsubscription.

View the dashboard of an instance

The dashboard displays the producer overview, billing metrics, and throttling metrics of a specific instance. For more information, see Dashboard.

1. Go to the Instances page, click the name of the instance that you want to manage.

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

References

You can also call the following API operations to manage instances:

• CreateInstance

• UpdateInstance

• DeleteInstance

• ListInstances

• GetInstance