Manage Apache Kafka® connectors

Connectors perform continuous migration between Apache Kafka® topics and other clusters or data storage systems.

These instructions show you how to:

Get a list of connectors

To get a list of connectors for your Apache Kafka® cluster:

  1. Go to the Clusters page in the console.

  2. Select the Apache Kafka® cluster for which you want to see the available connectors.

  3. Open the Connectors tab. You'll see the list of all the connectors.

Use the ConnectorService list method and pass the cluster_id in the request parameter.

To find the cluster_id, get a list of clusters in the project.

Get detailed information on a connector

To get detailed information on a connector in your Apache Kafka® cluster:

  1. Go to the Clusters page in the console.

  2. Select the Apache Kafka® cluster for which you want to see the available connectors.

  3. Open the Connectors tab.

  4. Click the connector on which you want to get detailed information.

Use the ConnectorService get method and pass the following parameters:

  • cluster_id

    To find the cluster_id, get a list of clusters in the project.

  • connector_name

    To get the connector_name, from ConnectorService, get a list of available connectors.

Pause a connector

To pause a connector in your Apache Kafka® cluster:

  1. Go to the Clusters page in the console.

  2. Select the Apache Kafka® cluster for which you want to see the available connectors.

  3. Open the Connectors tab.

  4. Find the connector you want to pause and click → Pause.

Use the ConnectorService pause method and pass the following parameters:

  • cluster_id

    To find the cluster_id, get a list of clusters in the project.

  • connector_name

    To get the connector_name, from ConnectorService, get a list of available connectors.

Resume a connector

To resume a connector in your Apache Kafka® cluster:

  1. Go to the Clusters page in the console.

  2. Select the Apache Kafka® cluster for which you want to see the available connectors.

  3. Open the Connectors tab.

  4. Find the PAUSED connector you want to restart and click → Resume.

Use the ConnectorService resume method and pass the following parameters:

  • cluster_id

    To find the cluster_id, get a list of clusters in the project.

  • connector_name

    To get the connector_name, from ConnectorService, get a list of available connectors.

Update a connector

To update a connector in your Apache Kafka® cluster:

Use the ConnectorService update method and pass the following parameters:

See also

Previous
Configure cluster maintenance
Next
Delete connector
In this article: