Updated on 2024-01-18 GMT+08:00

Collecting Connection Information

Required Kafka Instance Information

  • Instance connection address and port

    Obtain them from the Basic Information page of the Kafka instance console. Each Kafka instance is deployed as a cluster and has at least three connection addresses. Configure all of them on the client.

    For public network access, you can use the public network addresses displayed on the Basic Information page.

    Figure 1 Viewing the connection addresses and ports of brokers of a Kafka instance
  • Topic name

    Obtain the topic name from the Topics page of the Kafka instance console.

    Figure 2 Viewing the topic name
  • SASL information

    If SASL_SSL is enabled for the instance during instance creation, obtain the SASL_SSL username, password, SSL certificate, Kafka security protocol, and SASL authentication mechanism.

    • Obtain the username on the Users page of the Kafka instance console. If the password is lost, you can reset the SASL_SSL user password.
      Figure 3 Obtaining the SASL_SSL username
    • Download the SSL certificate on the Basic Information page of the Kafka instance console.

      JKS certificates are used for connecting to instances in Java and CRT certificates are used for connecting to instances in Python.

    • View the SASL mechanism on the Basic Information page of the Kafka instance console. If both SCRAM-SHA-512 and PLAIN are enabled, configure either of them for connections. If SASL Mechanism is not displayed, PLAIN is used by default.
      Figure 4 SASL mechanism in use
    • View Security Protocol on the Basic Information page of the Kafka instance console. If Security Protocol is not displayed, SASL_SSL is used by default.