API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (alikafka/2019-09-16) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Topic
|
API |
Title |
Description |
| GetTopicSubscribeStatus | GetTopicSubscribeStatus | Retrieves the subscription status of Groups for a topic. |
| CreateTopic | CreateTopic | Creates a topic. |
| DeleteTopic | DeleteTopic | Deletes a topic. |
| ModifyPartitionNum | ModifyPartitionNum | This operation modifies the number of partitions in a topic. |
| ModifyTopicRemark | ModifyTopicRemark | Modifies the remark of a topic. |
| UpdateTopicConfig | UpdateTopicConfig | After creating a topic, you can modify its message retention period and maximum message size. This topic describes how to use the API to modify topic configurations. |
| GetTopicList | GetTopicList | Retrieves information about topics. |
| GetTopicStatus | GetTopicStatus | Retrieves the message sending and receiving status of a topic. |
| GetQuotaTip | GetQuotaTip | Retrieves the usage quotas for topics and partitions. |
| QueryMessage | QueryMessage | Query messages stored in a topic by message creation time or offset. |
Consumer groups
|
API |
Title |
Description |
| CreateConsumerGroup | CreateConsumerGroup | You can call CreateConsumerGroup to create a consumer group. |
| DeleteConsumerGroup | DeleteConsumerGroup | Deletes a Group. |
| UpdateConsumerOffset | UpdateConsumerOffset | The UpdateConsumerOffset operation resets the consumer offset of a consumer group. |
| GetConsumerList | GetConsumerList | Retrieves a list of consumer groups. |
| GetConsumerProgress | GetConsumerProgress | Queries the consumption status of a consumer group. |
| ListRebalanceInfo | ListRebalanceInfo | Queries the details of rebalancing tasks. |
Labels
|
API |
Title |
Description |
| ListTagResources | ListTagResources | Queries the list of tags that are attached to resources. |
| UntagResources | UntagResources | You can call UntagResources to detach tags from resources. |
| TagResources | TagResources | You can call the TagResources operation to attach tags to resources. |
SASL users
|
API |
Title |
Description |
| CreateSaslUser | CreateSaslUser | This operation creates a SASL user. |
| DeleteSaslUser | DeleteSaslUser | You can call the DeleteSaslUser operation to delete a Simple Authentication and Security Layer (SASL) user. |
| DescribeSaslUsers | DescribeSaslUsers | You can call DescribeSaslUsers to query SASL users. |
Access control
|
API |
Title |
Description |
| CreateAcl | CreateAcl | This operation is used to create an access control list (ACL). |
| DeleteAcl | DeleteAcl | Deletes an access control list (ACL). |
| DescribeAcls | DescribeAcls | Queries access control lists (ACLs). |
| DescribeAclResourceName | DescribeAclResourceName | Queries access control list (ACL) resource names. |
Others
|
API |
Title |
Description |
| ChangeResourceGroup | ChangeResourceGroup | Moves a resource to a different resource group. |
| ConvertPostPayOrder | ConvertPostPayOrder | Changes the billing method of an instance from pay-as-you-go to subscription. |
| CreatePostPayInstance | CreatePostPayInstance | Creates a pay-as-you-go instance and returns the instance ID and order ID. |
| CreatePostPayOrder | CreatePostPayOrder | Pay-as-you-go instances are billed based on your actual usage and are ideal for testing or short-term scenarios with unpredictable traffic peaks. This topic describes how to call the CreatePostPayOrder operation to create a pay-as-you-go instance. |
| CreatePrePayInstance | CreatePrePayInstance | Creates a subscription instance and returns the instance ID and order ID. |
| CreatePrePayOrder | CreatePrePayOrder | Subscription instances require prepayment for resources and are ideal for long-term, stable business scenarios. This topic describes how to call the CreatePrePayOrder operation to create a subscription instance. |
| CreateScheduledScalingRule | CreateScheduledScalingRule | After you deploy a serverless instance, you can use this API to create a scheduled scaling rule for the instance. |
| DeleteInstance | DeleteInstance | This topic describes how to call the DeleteInstance operation to delete an instance after a subscription instance or a pay-as-you-go instance is released. |
| DeleteScheduledScalingRule | DeleteScheduledScalingRule | After a Serverless instance is deployed, you can call this API operation to delete its scheduled scaling policy configuration. |
| EnableAutoGroupCreation | EnableAutoGroupCreation | This topic describes how to call EnableAutoGroupCreation to enable or disable the free use of Groups. |
| EnableAutoTopicCreation | EnableAutoTopicCreation | This topic describes how to call the EnableAutoTopicCreation operation to enable or disable automatic topic creation and modify the default number of partitions for automatically created topics. |
| GetAllInstanceIdList | GetAllInstanceIdList | Queries the IDs of all instances in the current account. |
| GetAllowedIpList | GetAllowedIpList | Queries the IP address whitelist. |
| GetAutoScalingConfiguration | GetAutoScalingConfiguration | After a Serverless instance is deployed, you can call this API operation to query the auto scaling configuration of the instance. |
| GetInstanceList | GetInstanceList | Queries a list of instances in a specified region. |
| GetKafkaClientIp | GetKafkaClientIp | Retrieves the IP addresses of Kafka clients. |
| GetRiskList | GetRiskList | Queries the list of threats on an instance. |
| ModifyInstanceName | ModifyInstanceName | You can modify the name of an ApsaraMQ for Kafka instance after it is deployed. This topic describes how to call the ModifyInstanceName operation. |
| ModifyScheduledScalingRule | ModifyScheduledScalingRule | After you deploy Serverless instances, you can call this API operation to modify their scheduled scaling policy. |
| ReleaseInstance | ReleaseInstance | Releases a pay-as-you-go instance. |
| ReopenInstance | ReopenInstance | Starts an instance. |
| StartInstance | StartInstance | You must purchase and deploy an ApsaraMQ for Kafka instance before you can send and receive messages. This topic describes how to deploy an instance by calling the StartInstance operation. |
| StopInstance | StopInstance | Stops an instance. |
| UpdateAllowedIp | UpdateAllowedIp | You can call the UpdateAllowedIp operation to edit the IP whitelist for an ApsaraMQ for Kafka instance. The whitelist specifies the IP addresses and ports that are allowed to access the instance. |
| UpdateInstanceConfig | UpdateInstanceConfig | After an instance is deployed, you can modify configurations such as enabling Access Control List (ACL) and SSL, the message retention period, and the maximum message size. This topic describes how to call the UpdateInstanceConfig operation to modify the configuration of an instance. |
| UpgradeInstanceVersion | UpgradeInstanceVersion | Upgrades the version of an instance. |
| UpgradePostPayOrder | UpgradePostPayOrder | Upgrades a pay-as-you-go instance. |
| UpgradePrePayOrder | Upgrade Prepaid Instance | Upgrades a subscription instance. |