文档中心

消息队列 Kafka版

V2（2022-05-01）

API 概览

API 概览

本文介绍消息队列 Kafka 版提供的 API 接口信息。

资源检查

API	说明
DescribeRegions	调用 DescribeRegions 接口查看 Region 列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查看可用区列表。

实例管理

API	说明
CreateInstance	调用 CreateInstance 创建消息队列 Kafka 版实例。
ModifyInstanceParameters	调用 ModifyInstanceParameters 接口修改对应实例的参数配置。
ModifyInstanceAttributes	调用 ModifyInstanceAttributes 接口修改对应实例名称、描述等实例信息。
ModifyInstanceSpec	调用 ModifyInstanceSpec 接口修改实例的计算规格、存储规格、增配分区数等产品规格。
ModifyInstanceChargeType	调用 ModifyInstanceChargeType 接口变更实例的计费类型。
DescribeInstances	调用 DescribeInstances 接口获取当前账户下的实例列表。
DescribeInstanceDetail	调用 DescribeInstanceDetail 接口查看指定实例的详情。
DeleteInstance	调用 DeleteInstance 接口释放按量付费实例。

网络管理

API	说明
CreatePublicAddress	调用 CreatePublicAddress 接口开启 Kafka 实例的公网访问方式。
DeletePublicAddress	调用 DeletePublicAddress 接口关闭公网访问方式。

Topic 管理

API	说明
CreateTopic	调用 CreateTopic 接口创建 Kafka Topic。
DeleteTopic	调用 DeleteTopic 接口删除 Kafka Topic。
ModifyTopicAttributes	调用 ModifyTopicAttributes 接口修改 Topic 的描述。
ModifyTopicParameters	调用 ModifyTopicParameters 接口修改 Topic 的参数配置。
ModifyTopicAccessPolicies	调用 ModifyTopicAccessPolicies 接口更改指定 Topic 的用户权限。
DescribeTopics	调用 DescribeTopics 接口查看 Topic 列表。
DescribeTopicParameters	调用 DescribeTopicParameters 查看指定 Topic 的参数配置。
DescribeTopicPartitions	调用 DescribeTopicPartitions 接口获取 Topic 的 Partition 信息。
DescribeTopicAccessPolicies	调用 DescribeTopicAccessPolicies 接口查看 Topic 的权限列表。

Group 管理

API	说明
CreateGroup	调用 CreateGroup 接口创建消费组（ConsumerGroup）。
ModifyGroup	调用 ModifyGroup 接口修改消费组描述信息。
DeleteGroup	调用 DeleteGroup 接口删除消费组。
DescribeGroups	调用 DescribeGroups 接口获取消费组列表。
DescribeConsumedTopics	调用 DescribeConsumedTopics 接口查看消费组订阅的 Topic 信息。
DescribeConsumedPartitions	调用 DescribeConsumedPartitions 接口查看消费组订阅的指定 Topic 的分区信息。
ResetConsumedOffsets	调用 ResetConsumedOffsets 重置消费者组的消费位点。

消息查询

API	说明
QueryMessageByTimestamp	调用 QueryMessageByTimestamp 接口，查询分区中指定时间范围内的消息元数据。

SASL 用户管理

API	说明
CreateUser	调用 CreateUser 接口创建 Kafka SASL 用户。
DeleteUser	调用 DeleteUser 接口删除 Kafka SASL 用户。
ModifyUserAuthority	调用 ModifyUserAuthority 接口更改指定 SASL 用户对于所有用户的默认权限。
DescribeUsers	调用 DescribeUsers 接口获取 Kafka SASL 用户列表。

ACL 策略管理

API	说明
CreateAcl	调用 CreateAcl 接口创建 ACL 策略。
DescribeAcls	调用 DescribeAcls 接口查询已创建的 ACL 规则策略。
DeleteAcl	调用 DeleteAcl 接口删除 ACL 策略。

操作审计

API	说明
DescribeTopicAuditInfo	调用 DescribeTopicAuditInfo 接口查询指定主题的生产或消费记录。

标签管理

API	说明
AddTagsToResource	调用 AddTagsToResource 接口为指定实例绑定标签。
RemoveTagsFromResource	调用 RemoveTagsFromResource 接口为一个或多个实例解绑标签。
DescribeTagsByResource	调用 DescribeTagsByResource 接口查询已绑定标签的资源。

白名单管理

API	说明
CreateAllowList	调用 CreateAllowList 接口创建一个新的 IP 白名单规则。
ModifyAllowList	调用 ModifyAllowList 修改一个已经创建的白名单规则。
DeleteAllowList	调用 DeleteAllowList 删除一个已经创建的白名单规则。
DescribeAllowLists	调用 DescribeAllowLists 查询白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 查询指定白名单的详细信息。
AssociateAllowList	调用 AssociateAllowList 绑定实例与白名单。
DisassociateAllowList	调用 DisassociateAllowList 解绑实例与白名单。

最近更新时间：2026.09.22 15:07:40

这个页面对您有帮助吗？

有用

有用

无用

无用