Docs

Message Queue for Kafka

V1（2018-01-01）

API overview

API overview

Message Queue for Kafka provides the following related API interfaces.

Instance management

API	DescriptionDescription
ListKafkaConf	Call the ListKafkaConf API to get the relevant configurations supported by Message Queue for Kafka.
CreateKafkaInstance	Call the CreateKafkaInstance API to create a Kafka instance.
DeleteKafkaInstance	Call the DeleteKafkaInstance API to delete a Kafka instance.
DescribeInstanceDetail	Call the DescribeInstanceDetail API to get details of the specified Kafka instance
DescribeInstancesSummary	Call the DescribeInstancesSummary API to get an overview list of instances under the current account.
ModifyInstanceDescription	Call the ModifyInstanceDescription API to modify the instance description.
ModifyInstanceName	Call the ModifyInstanceName API to change the Kafka instance name.
ModifyInstanceParams	Call the ModifyInstanceParams API to change Kafka instance configuration parameters.
ScaleKafkaInstance	Call the ScaleKafkaInstance API to change the Kafka instance specification
ModifyChargeToPrepaid	Call the ModifyChargeToPrepaid API to switch a pay-as-you-go instance to a subscription instance.
EnableInternetAccess	Call the EnableInternetAccess API to enable public network access.
DisableInternetAccess	Call the DisableInternetAccess API to revoke public network access.

Topic management

API	DescriptionDescription
CreateTopic	Call the CreateTopic API to create a topic.
DeleteTopic	Call the DeleteTopic API to delete a Topic.
DescribeTopicAuthorities	Call the DescribeTopicAuthorities API to obtain topic permission details.
DescribeTopicPartitions	Call the DescribeTopicPartitions API to get the topic's partition information.
DescribeTopics	Call the DescribeTopics API to get the topic list
ModifyTopic	Call the ModifyTopic API to update the topic's configuration.
ModifyTopicAuthorities	Call the ModifyTopicAuthorities API to change the permissions for the corresponding topic.
QueryMessageByMessageId	Call QueryMessageByMessageId to look up the message at the specified offset in the partition.

Group management

API	DescriptionDescription
DeleteGroup	Call the DeleteGroup API to remove the consumer group.
DescribeConsumedPartitions	Call the DescribeConsumedPartitions API to get partition information subscribed by the ConsumerGroup
DescribeConsumedTopics	Call the DescribeConsumedTopics API to get the names of topics subscribed by the consumer group.
DescribeGroups	Call the DescribeGroups API to get the ConsumerGroup list.
ResetConsumedOffsets	Call the ResetConsumedOffsets API to reset the consumer group’s consumed Offset.

User management

API	DescriptionDescription
CreateSaslUser	Call the CreateSaslUser API to create a SASL user
DeleteSaslUser	Call the DeleteSaslUser API to delete the SASL user with the SCRAM password type.
DescribeSaslUsers	Call the DescribeSaslUsers API to get the Kafka user list
ModifySaslPassword	Call the ModifySaslPassword API to reset the SCRAM user password.
ModifyUserAuthority	Call the ModifyUserAuthority API to change the default permissions of a SASL user.

Last updated: 2025.10.20 15:53:30