All Products
Search

This Product

    ApsaraMQ for Kafka:Manage connectors

    Document Center

    ApsaraMQ for Kafka:Manage connectors

    Last Updated:Jul 17, 2026

    You can view connector configurations and logs, suspend or enable connectors, modify configurations, test connectors, view consumption progress, and delete connectors in the Message Queue for Apache Kafka console.

    Prerequisites

    You have created one of the following connectors:

    Note

    You can modify configurations only for Function Compute sink connectors and MySQL source connectors.

    Notes

    • You can modify configurations only for Function Compute sink connectors and MySQL source connectors.

    • You can suspend a connector only when it is in the Running state. You can enable a connector only when it is in the Suspended state.

    View connector configurations

    View a connector's basic information, source information, and destination information.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the connector in the list and click Details in the Actions column.

      On the connector details page, you can view the Basic Information, Source Information, and Destination Information of the connector.

    View connector logs

    If you need to troubleshoot a connector issue, you can view its logs in the Message Queue for Apache Kafka console.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the target connector in the list. In the Actions column, choose More > View Logs.

      Alternatively, click the name of the target connector, or click Details in the Actions column. On the connector details page, click View Logs in the upper-right corner.

      Note

      The location of View Logs in the Actions column depends on the task status. The actual UI display prevails.

      On the connector logs page, you can view the logs of the connector.

    Modify connector configurations

    After you create a Function Compute sink connector or a MySQL source connector, you can modify its configuration in the Message Queue for Apache Kafka console.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the target connector in the list. In the Actions column, choose More > Modify Configuration.

      Alternatively, click the name of the target connector, or click Details in the Actions column. On the connector details page, click Modify Configuration in the upper-right corner.

    5. In the Modify Configuration panel, change the configuration parameters as needed, and then click OK.

      • Modify configurations for a Function Compute sink connector

        Parameter

        Description

        Consumer Thread Concurrency

        The number of concurrent consumer threads for the source topic. The default value is 6. Valid values:

        • 1

        • 2

        • 3

        • 6

        • 12

        Failure Handling Policy

        Determines the action to take when message delivery to a topic partition fails. Valid values:

        • Continue Subscription: Continues consuming from the partition where the error occurred and logs the error.

        • Stop Subscription: Stops consuming from the partition where the error occurred and logs the error.

        Note

        • For more information about how to view logs, see Manage connectors.

        • For more information about how to find solutions based on error codes, see Error code list.

        Transmission Mode

        The mode for sending messages. Valid values:

        • Synchronous: The sender and receiver must be running at the same time and ready for communication.

        • Asynchronous: After sending a message, the sender can proceed with other tasks without waiting for a response from the server.

        Data Size

        The number of messages to send in a batch.

        The default value is 20. The value range is [1, 5000].

        Retries

        The number of retry attempts after a message fails to be sent. The default value is 2. The value range is 1 to 3. Retries are not supported for some errors that cause message sending to fail. For more information about error codes, see Error code list. The retry support for different error codes is described as follows:

        • 4xx: Retries are not supported, except for the 429 error code.

        • 5xx: Retries are supported.

        Note

        The connector calls the InvokeFunction API to send messages to Function Compute.

      • Modify configurations for a MySQL source connector

        Parameter

        Description

        Database Table

        The name of one or more tables in an ApsaraDB RDS for MySQL instance to synchronize. Separate multiple table names with commas (,).

        A one-to-one mapping exists between a database table and a destination topic.

        Note

        If you add or modify tables for an existing task, you must create a corresponding Topic in the Message Queue for Apache Kafka console in advance. The Topic name must be in the Topic prefix_table name format. Otherwise, a runtime error will occur. For more information, see Step 1: Create a Topic.

      After the modification is complete, on the Connectors page, find the target Connector. In its Actions column, click Details. On the Connector Details page, you can view the updated Connector configuration.

    Suspend or enable a connector

    You can suspend a running connector to temporarily stop it, or enable a suspended connector to resume it, in the Message Queue for Apache Kafka console.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the target connector in the list, and then suspend or enable it as needed.

      • To suspend a connector: In the Actions column, choose More > Suspend. In the Note dialog box, confirm the suspension and click OK.

      • To enable a connector: In the Actions column, click Enable. In the Note dialog box, confirm the startup and click OK.

      Alternatively, click the name of the target connector, or click Details in the Actions column. On the connector details page, click Suspend or Enable in the upper-right corner.

      On the Connectors page, find the connector that you suspended or enabled. The Status changes to Suspended or Running.

      Note

      If a MySQL source connector task has been suspended for an extended period, it may fail to restart. In this case, find the task and click Task Configurations in the Actions column. On the DataWorks page, find the row of the target synchronization task and click Start. In the Start dialog box, select Reset Offset, configure the Start Time Point, and then click OK.

    Test a connector

    You can send a test message to verify a connector from the Message Queue for Apache Kafka console.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the target connector in the list, and then click Test in the Actions column.

      Alternatively, click the name of the target connector, or click Details in the Actions column. On the connector details page, click Test in the upper-right corner.

      Note

      The position of Test in the Actions column may vary depending on the task's status.

    5. In the Send Message panel, send a test message.

      1. In the Message Key text box, enter a key for the message, such as demo.

      2. In the Message Content text box, enter the content for the test message, such as {"key": "test"}.

      3. Use the Send to Specified Partition option to control whether the message is sent to a specific partition.

        • Click Yes and enter a partition ID in the Partition ID text box, such as 0. To query the partition ID, see View partition status.

        • Click No if you do not want to specify a partition.

    View consumption progress

    After a connector starts running, you can view the consumption status of its consumer group for the source topic. The name of the consumer group is connect-{task_name}.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the target connector in the list, and then click Consumption Progress in the Actions column.

      Alternatively, click the name of the target connector, or click Details in the Actions column. On the connector details page, click Consumption Progress in the upper-right corner.

      In the consumer group consumption details panel, you can view the consumption details of the consumer group used by the connector task in the source topic.

    Delete a connector

    Each Message Queue for Apache Kafka instance has a limit on the number of connectors. If you no longer need a connector, you can delete it in the Message Queue for Apache Kafka console.

    Important

    • If a MySQL source connector task is in the Running state, you cannot directly delete it in the Message Queue for Apache Kafka console. You must log on to the DataWorks console to stop and unpublish the connector task, and then submit a ticket to remove the Message Queue for Apache Kafka connector task's metadata. Other connectors, such as Function Compute sink connectors, MaxCompute sink connectors, OSS sink connectors, and Elasticsearch sink connectors, can be directly deleted in the Message Queue for Apache Kafka console.

    • When you delete a connector, the system also deletes its 5 dependent topics and 2 dependent consumer groups, regardless of whether these resources were created automatically or manually.

    1. Log on to the ApsaraMQ for Kafka console.

    2. In the Resource Distribution section of the Overview page, select the region where the ApsaraMQ for Kafka instance that you want to manage resides.

    3. In the left-side navigation pane, click Connectors.

    4. On the Connectors page, select the instance that the connector belongs to from the Select Instance drop-down list. Find the target connector in the list. In the Actions column, choose More > Delete.

      Alternatively, click the name of the target connector, or click Details in the Actions column. On the connector details page, click Delete in the upper-right corner.

    5. In the Note dialog box, click OK to delete the connector.