Configure parameters for a Message Queue for Apache Kafka instance - Data Transmission Service

When the destination instance of a Data Transmission Service (DTS) task is an ApsaraMQ for Kafka instance connected over Express Connect, VPN Gateway, or Smart Access Gateway, you must configure a set of special parameters. This page describes each parameter and where to find its value.

Usage notes

When an ApsaraMQ for Kafka instance is connected via Express Connect, VPN Gateway, or Smart Access Gateway, DTS writes data to the specified nodes.
If the source database is MySQL, set the Access Method parameter to Alibaba Cloud Instance for the destination ApsaraMQ for Kafka instance.

Important

Some DTS tasks do not support selecting ApsaraMQ for Kafka directly as the database type. In those cases, configure the ApsaraMQ for Kafka instance as a self-managed Kafka cluster.

Prerequisites

Before you begin, ensure that you have:

An ApsaraMQ for Kafka instance accessible from the DTS task network via Express Connect, VPN Gateway, or Smart Access Gateway
Access to the Message Queue for Apache Kafka console

Find parameter values in the Kafka console

Most parameter values come from the Instance Details page. To open it:

Log in to the Message Queue for Apache Kafka console.
In the top navigation bar, select the region where your destination instance resides.
On the Instances page, click the name of the destination instance.

Parameters

Parameter	Value	Where to find it
Access Method	Select Express Connect, VPN Gateway, or Smart Access Gateway.	N/A
Connected VPC	The ID of the VPC to which the ApsaraMQ for Kafka instance belongs.	On the Instance Information tab, go to the Configuration Information section and copy the VPC ID value.
IP Address or Domain Name	The IP address of the ApsaraMQ for Kafka instance. Enter one of the IP addresses and the port number.	On the Instance Information tab, go to the Endpoint Information section. Find the row where Type is Default Endpoint, then hover over the domain name to view the IP Address.
Port Number	The service port of the ApsaraMQ for Kafka instance. Default: `9092`.	N/A
Database Account	The SASL username used to access the destination instance. Required only if the access control list (ACL) feature is enabled. For more information about enabling ACL, see Grant permissions to SASL users.	On the Manage SASL Users tab, view the Username column.
Database Password	The password for the database account above. Required only if ACL is enabled. This field and Database Account must be filled in together — leave both blank if ACL is disabled.	On the Manage SASL Users tab, find the account and click Copy Password.
Kafka Version	Select based on your instance's major version: Instance version 0.10.2 → select 0.10 Instance version 2.6.2 or 2.2.0 → select Later Than 1.0	On the Instance Information tab, go to the Basic Information section and check the Major Version field.
Encryption	Select based on your ACL configuration: ACL disabled → select Non-encrypted ACL enabled and User Type is SCRAM → select SCRAM-SHA-256 ACL enabled and User Type is not SCRAM → select Non-encrypted	On the Manage SASL Users tab, check the User Type column. This tab appears only if ACL is enabled.