ApsaraMQ for RocketMQ:Usage notes

Step 1: Create a task

1. Log on to the ApsaraMQ for RocketMQ console.

2. In the left-side navigation pane, click Global Replicator. On the page that appears, click Create Task.

3. On the Create Task page, follow the on-screen instructions to configure the parameters and click Create.

   

   The following tables describe the parameters.

   ApsaraMQ for RocketMQ

   Parameter	Description	Example
   Version	The version of the ApsaraMQ for RocketMQ instance. ApsaraMQ for RocketMQ 4.0 Instance ApsaraMQ for RocketMQ 5.0 Instance	ApsaraMQ for RocketMQ 5.0 Instance
   Region	The region where the ApsaraMQ for RocketMQ instance resides.	China (Hangzhou)
   Instance	The ApsaraMQ for RocketMQ instance.	rmq-cn-778***
   Authentication Mode	No Configuration Required ACL-based Authentication	ACL-based Authentication
   User Name	The username.	yS8x01****
   Security Group ID	The security group of the Elastic Compute Service (ECS) instance with which the ApsaraMQ for RocketMQ instance is associated. This parameter is required only if you set Version to ApsaraMQ for RocketMQ 5.0 Instance. Inbound: no requirements. Outbound: Action: Allow Protocol: Custom TCP Destination: The specified CIDR blocks must include all CIDR blocks of the cluster vSwitches. The specified ports must include 8080 and 8081.	sg-2ze4jlbqy2s40pc4****
   System Configurations of Filter Conditions	(Optional) You can add custom attributes (UserProperty) to a message. Consumers can define subscription policies based on the SQL-92 syntax to filter messages. Key: the key of UserProperty Source Cluster Value: the value of UserProperty added to the message from the source cluster Destination Cluster Value: the value of UserProperty added to the message from the destination cluster Sample code for defining subscription policies based on the SQL-92 syntax: String sqlStr = "{Key} IS NOT NULL AND {Key} = {Source/Destination Cluster Value}"; consumer.subscribe(MqConfig.TOPIC, MessageSelector.bySql(sqlStr));	None

   Apache RocketMQ

   Parameter	Description	Example
   Access Point	The access point. Format: {Domain name/IP address}:{Port number}.	XX.XX.XX.XX:8080
   Authentication Mode	No Configuration Required ACL-based Authentication	ACL-based Authentication
   User Name	The username. Specify the value based on the actual scenario.	yS8x01****
   Password	The password. Specify the value based on the actual scenario.	F17R4to****
   Network Settings	Internet VPC	Internet
   Region	The region of the ECS instance with which the Apache RocketMQ cluster is associated. This parameter is required only if you set Network Settings to VPC. The region where the Elastic Compute Service (ECS) instance on which the Apache RocketMQ cluster is deployed is located. This parameter is required only if you set Network Settings to VPC.	China (Hangzhou)
   VPC	The VPC of the ECS instance with which the Apache RocketMQ cluster is associated. This parameter is required only if you set Network Settings to VPC. The virtual private cloud (VPC) of the ECS instance on which the Apache RocketMQ cluster is deployed. This parameter is required only if you set Network Settings to VPC.	vpc-bp17fapfdj0dwzjkd****
   vSwitch	The vSwitch of the ECS instance with which the Apache RocketMQ cluster is associated. This parameter is only required if you set Network Settings to VPC. The vSwitch of the ECS instance on which the Apache RocketMQ cluster is deployed. This parameter is required only if you set Network Settings to VPC.	vsw-bp1gbjhj53hdjdkg****
   Security Group ID	The security group of the ECS instance with which the Apache RocketMQ cluster is associated. This parameter is required only if you set Network Settings to VPC. The security group of the ECS instance on which the Apache RocketMQ cluster is deployed. Inbound: no requirements. Outbound: Action: Allow Protocol: Custom TCP Destination: The specified CIDR blocks must include all CIDR blocks where the Apache RocketMQ broker resides. The specified ports must include all ports of the Apache RocketMQ broker. The default ports are 9876, 10911, and 10909. If you changed the nameserver or the ports of the broker, specify the changed ports.	sg-2ze4jlbqy2s40pc4****
   System Configurations of Filter Conditions	(Optional) You can add custom attributes (UserProperty) to a message. Consumers can then define subscription policies based on the SQL-92 syntax to filter messages. Key: the key of UserProperty Source Cluster Value: the value of UserProperty added to the message from the source cluster Destination Cluster Value: the value of UserProperty added to the message from the destination cluster Sample code for defining subscription policies based on the SQL-92 syntax: String sqlStr = "{Key} IS NOT NULL AND {Key} = {Source/Destination Cluster Value}"; consumer.subscribe(MqConfig.TOPIC, MessageSelector.bySql(sqlStr));	None

Step 2: Configure topic mappings

1. In the left-side navigation pane of the Basic Task Information page, click Message Synchronization.

2. Click Batch Mapping or Add Mapping. In the dialog box that appears, configure the topic mappings.

   • Batch Mapping: Select the topic mappings. Then, click OK.

   • Add Mapping: Configure the topic mapping. Then, click OK.

   Note

   • If the source cluster is an Apache RocketMQ cluster, you must specify a group that is not in use for message synchronization.

   • Messages are synchronized only after you configure topic mappings.

(Optional) Step 3: Enable consumer progress synchronization

You can enable consumer progress synchronization to synchronize the consumer progress of a group to the destination cluster. For more information, see Consumer progress synchronization.