文档中心

API 概览

最近更新时间：2023.02.03 15:25:21

首次发布时间：2021.06.30 22:06:41

消息队列 Kafka版提供以下相关API 接口。

实例管理

API	说明
ListKafkaConf	调用 ListKafkaConf 接口获取消息队列 Kafka版支持的相关配置。
CreateKafkaInstance	调用 CreateKafkaInstance 接口创建Kafka实例。
DeleteKafkaInstance	调用 DeleteKafkaInstance 接口删除Kafka实例。
DescribeInstanceDetail	调用 DescribeInstanceDetail 接口获取指定Kafka实例的详细信息。
DescribeInstancesSummary	调用 DescribeInstancesSummary 接口获取当前账户下的实例概览列表。
ModifyInstanceDescription	调用 ModifyInstanceDescription 接口修改实例描述信息。
ModifyInstanceName	调用 ModifyInstanceName 接口修改Kafka实例名称。
ModifyInstanceParams	调用 ModifyInstanceParams 接口修改Kafka实例的配置参数。
ScaleKafkaInstance	调用 ScaleKafkaInstance 接口更改Kafka实例规格。
ModifyChargeToPrepaid	调用 ModifyChargeToPrepaid 接口将按量付费实例转为包年包月实例。
EnableInternetAccess	调用 EnableInternetAccess 接口开启公网访问权限。
DisableInternetAccess	调用 DisableInternetAccess 接口关闭公网访问权限。

Topic管理

API	说明
CreateTopic	调用 CreateTopic 接口创建 Topic。
DeleteTopic	调用 DeleteTopic 接口删除 Topic。
DescribeTopicAuthorities	调用 DescribeTopicAuthorities 接口获取 Topic 的权限信息。
DescribeTopicPartitions	调用 DescribeTopicPartitions 接口获取 Topic 的 Partition 信息。
DescribeTopics	调用 DescribeTopics 接口获取 Topic 列表。
ModifyTopic	调用 ModifyTopic 接口修改 Topic 的配置。
ModifyTopicAuthorities	调用 ModifyTopicAuthorities 接口更改对应 Topic 的权限。
QueryMessageByMessageId	调用 QueryMessageByMessageId 可以查询 Partition 中指定 Offset 的消息。

Group管理

API	说明
DeleteGroup	调用 DeleteGroup 接口删除 ConsumerGroup。
DescribeConsumedPartitions	调用 DescribeConsumedPartitions 接口获取 ConsumerGroup 订阅的 Partition 信息。
DescribeConsumedTopics	调用 DescribeConsumedTopics 接口获取 ConsumerGroup 订阅的 Topic 名称。
DescribeGroups	调用 DescribeGroups 接口获取 ConsumerGroup 列表。
ResetConsumedOffsets	调用 ResetConsumedOffsets 接口重置消费者组消费的 Offset。

用户管理

API	说明
CreateSaslUser	调用 CreateSaslUser 接口删创建 SASL 用户。
DeleteSaslUser	调用 DeleteSaslUser 接口删除密码类型为 SCRAM 的 SASL 用户。
DescribeSaslUsers	调用 DescribeSaslUsers 接口获取 Kafka 用户列表。
ModifySaslPassword	调用 ModifySaslPassword 接口重置 SCRAM 用户密码。
ModifyUserAuthority	调用 ModifyUserAuthority 接口更改 SASL 用户的默认权限。

实例管理

Topic管理

Group管理

用户管理