本产品（
云消息队列 Kafka 版/2019-09-16）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
实例
| API | 标题 | API概述 |
|---|---|---|
| CreatePostPayOrder | 创建后付费实例 | 后付费实例根据所购资源规格的实际使用量计费，先使用，后计费。主要适用于测试或者流量峰值不确定的短期场景。本文介绍如何调用CreatePostPayOrder创建后付费实例。 |
| CreatePrePayOrder | 创建预付费实例 | 预付费实例需要先付费才能使用资源，主要适用于长期稳定的业务运行场景。本文介绍调用CreatePrePayOrder创建预付费实例。 |
| DeleteInstance | 删除实例 | 当预付费实例或后付费实例被释放后可删除实例，本文介绍如何调用DeleteInstance删除实例。 |
| StartInstance | 部署实例 | 如需使用云消息队列 Kafka 版收发消息，需要购买并部署才可使用，本文介绍如何调用StartInstance部署实例。 |
| ModifyInstanceName | 修改实例的名称 | 实例部署完成后，云消息队列 Kafka 版支持修改实例的名称。本文介绍如何调用ModifyInstanceName修改实例的名称。 |
| EnableAutoGroupCreation | 开启自由使用 Group | 本文介绍如何调用EnableAutoGroupCreation开启和关闭自由使用Group。 |
| EnableAutoTopicCreation | 开启自动创建 Topic | 本文介绍如何调用 EnableAutoTopicCreation 开启和关闭自动创建Topic，以及修改自动创建 Topic 默认分区数。 |
| UpdateAllowedIp | 变更IP白名单 | 您可以编辑访问云消息队列 Kafka 版的白名单，配置在白名单中的IP地址与端口才允许访问云消息队列 Kafka 版实例，本文介绍如何调用UpdateAllowedIp变更IP白名单。 |
| UpdateInstanceConfig | 修改实例的配置 | 实例部署后，允许修改实例是否开启ACL、SSL、消息保留时长及最大消息大小，本文介绍如何调用UpdateInstanceConfig修改实例配置。 |
| ChangeResourceGroup | 更改实例所在的资源组 | 进行资源转组。 |
| GetInstanceList | 查询指定地域的实例信息 | 查询指定地域的实例信息。 |
| GetAllowedIpList | 获取IP白名单 | 获取IP白名单。 |
| GetAllInstanceIdList | 查询所有地域的实例ID | 查询当前用户下所有实例ID集合。 |
| UpgradePostPayOrder | 升配后付费实例 | 升配后付费实例。 |
| UpgradePrePayOrder | 升配预付费实例 | 升配预付费实例。 |
| ConvertPostPayOrder | 将后付费实例转为预付费实例 | 将后付费实例转为预付费实例。 |
| UpgradeInstanceVersion | 升级实例版本 | 升级实例版本。 |
| ReleaseInstance | 释放后付费实例 | 释放后付费实例。 |
| StopInstance | 停机实例 | 调用StopInstance以停机实例。 |
| ReopenInstance | 启用实例 | 启用实例。 |
| CreateScheduledScalingRule | 创建弹性定时策略 | Serverless 系列实例部署后，允许通过该接口创建实例弹性定时策略配置。 |
| DeleteScheduledScalingRule | 删除弹性定时策略 | Serverless 系列实例部署后，允许通过该接口删除实例弹性定时策略配置。 |
| ModifyScheduledScalingRule | 修改弹性定时策略 | Serverless 系列实例部署后，允许通过该接口修改实例弹性定时策略。 |
| GetAutoScalingConfiguration | 查询弹性定时策略配置 | Serverless 系列实例部署后，允许通过该接口查询实例弹性定时策略配置。 |
| GetKafkaClientIp | 查询 Kafka 客户端IP | 获取kafka客户端ip |
Topic
| API | 标题 | API概述 |
|---|---|---|
| GetTopicSubscribeStatus | 获取订阅 Topic 的 Group 信息 | 获取订阅 Topic 的 Group 信息。 |
| CreateTopic | 创建Topic | 创建Topic。 |
| DeleteTopic | 删除Topic | 删除Topic。 |
| ModifyPartitionNum | 修改Topic的分区数 | 修改Topic的分区数。 |
| ModifyTopicRemark | 修改Topic的备注 | 修改Topic的备注。 |
| UpdateTopicConfig | 修改Topic配置 | Topic创建后，允许修改Topic的消息保留时长以及最大消息大小，本文介绍如何调用接口来修改Topic的配置。 |
| GetTopicList | 获取Topic信息 | 获取Topic信息。 |
| GetTopicStatus | 获取消息收发状态 | 获取Topic的消息收发状态。 |
| GetQuotaTip | 获取Topic和分区的使用配额 | 获取Topic和分区的使用配额。 |
| QueryMessage | 查询 Topic 消息 | 查询 Topic 中存储的消息，可通过消息创建时间或者位点来进行查询。 |
消费组
| API | 标题 | API概述 |
|---|---|---|
| CreateConsumerGroup | 创建消费组 | 调用CreateConsumerGroup创建Group。 |
| DeleteConsumerGroup | 删除消费组 | 调用DeleteConsumerGroup删除Group。 |
| UpdateConsumerOffset | 重置消费者组的消费位点 | 通过 UpdateConsumerOffset 重置消费者组的消费位点。 |
| GetConsumerList | 获取Consumer Group信息 | 调用GetConsumerList获取Group信息。 |
| GetConsumerProgress | 查询消费组消费状态 | 查询Consumer Group的消费状态。 |
标签
| API | 标题 | API概述 |
|---|---|---|
| ListTagResources | 查询资源绑定的标签列表 | 调用ListTagResources查询资源绑定的标签列表。 |
| UntagResources | 为资源解绑标签 | 调用UntagResources为资源解绑标签。 |
| TagResources | 为资源绑定标签 | 调用TagResources为资源绑定标签。 |
SASL用户
| API | 标题 | API概述 |
|---|---|---|
| CreateSaslUser | 创建SASL用户 | 调用CreateSaslUser创建SASL用户。 |
| DeleteSaslUser | 删除SASL用户 | 调用DeleteSaslUser删除SASL用户。 |
| DescribeSaslUsers | 查询SASL用户 | 调用DescribeSaslUsers查询SASL用户。 |
访问控制
| API | 标题 | API概述 |
|---|---|---|
| CreateAcl | 创建ACL | 调用CreateAcl创建ACL。 |
| DeleteAcl | 删除ACL | 调用DeleteAcl删除ACL。 |
| DescribeAcls | 查询ACL | 调用DescribeAcls查询ACL。 |