API overview

Updated at:

ApsaraMQ for Kafka API operations (ApsaraMQ for Kafka/2019-09-16) use the V3 request structure and signature method.

Before you begin

  1. Create an AccessKey pair for your Alibaba Cloud account.

  2. Download an SDK in your preferred language to call API operations without building request signatures manually.

If no SDK meets your requirements, build a custom signature. This process typically takes about five days. For assistance, join the DingTalk group (ID: 78410016550).

Instances

OperationDescription
CreatePrePayOrderCreates a subscription instance. Subscription instances require upfront payment and are designed for long-term, stable workloads.
StartInstanceDeploys a purchased instance. Deploy an instance before you send or receive messages.
ModifyInstanceNameRenames a deployed instance.
GetInstanceListQueries instance details in a specified region.
GetAllInstanceIdListLists all instance IDs in the current account.
UpgradePrePayOrderUpgrades the configurations of a subscription instance.

Tags

OperationDescription
ListTagResourcesQueries tags attached to resources.
UntagResourcesRemoves tags from resources.
TagResourcesAttaches tags to resources.

SASL users

OperationDescription
CreateSaslUserCreates a Simple Authentication and Security Layer (SASL) user.
DeleteSaslUserDeletes a SASL user.
DescribeSaslUsersQueries SASL users.