Quick Audience:Workspace API Configuration

Create a Kafka API

Procedure

1. In the upper-right corner of the page, choose Workspace > Workspace> Workspace API Configuration.

   

2. In the upper-right corner, click Create Kafka API.

3. Configure the port information as shown in the following figure.

   

   Item	Example value
   API name	Enter the display name of the API.
   API types	Select Alibaba Cloud Message Queue for Apache Kafka or Open Source Kafka. Note You can obtain information such as the End Point of Alibaba Cloud Message Queue for Apache Kafka from its instance details page.
   Supported versions	The version of Kafka. Select 0.10 or 2.x.
   End Point	Enter the address of the terminal that receives the message.
   The username.	enter the username.
   Password	enter the password.
   Topic	Enter a display name for the project.
   Encrypted Transmission	For open source Kafka in the , the encrypted transmission switch appears. You can turn on the switch, upload the encrypted file used by your Kafka, and enter your SSL truststore password, as shown in the following figure. For Alibaba Cloud Message Queue for Apache Kafka, encryption is performed during transmission by default. You do not need to configure this parameter.

4. Click Test Connectivity. After the connection is successful, click Save to complete the configuration.

Management APIs

The Kafka, Data Bank, and Damengpan APIs are displayed. You can click an API name to view the API information. For more information about how to configure a data bank and a Damengpan API, see Bind Data Bank and Bind Damengpan

For Kafka APIs, you can perform the following operations:

• Obtain an API ID: The system assigns an API ID to each Kafka API. You can use the API to create a Kafka push task. Click the name of a Kafka API. The API information, including the API ID, is displayed on the right.

• Authorize: Move the pointer over the name of the Kafka API and click the icon. In the dialog box that appears, authorize other members to use the Kafka API.

  Note

  If you are not authorized, only the administrator can use this API to push.

  The authorization method supports authorization by member, authorization by member group, and removal of authorized members or member groups, as shown in the following figure.

  

• Edit: Modify the original configuration and click Test Connectivity. After the connection is successful, click Save to complete the configuration.

• Remove: Move the pointer over the API name, click the icon that appears, and then confirm to remove the API.