本产品（
消息队列 Kafka/2019-09-16）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
实例
| API | 标题 | API概述 |
|---|---|---|
| CreatePostPayOrder | 创建后付费实例 | 调用CreatePostPayOrder创建后付费实例。 |
| CreatePrePayOrder | 创建预付费实例 | 调用CreatePrePayOrder创建预付费实例。 |
| DeleteInstance | 删除实例 | 调用DeleteInstance删除实例。 |
| StartInstance | 部署实例 | 调用StartInstance部署实例。 |
| ModifyInstanceName | 修改实例的名称 | 调用ModifyInstanceName修改实例的名称。 |
| UpdateAllowedIp | 变更IP白名单 | 调用UpdateAllowedIp变更IP白名单。 |
| UpdateInstanceConfig | 修改实例的配置 | 调用UpdateInstanceConfig接口更新实例配置。 |
| ChangeResourceGroup | 更改实例所在的资源组 | 调用ChangeResourceGroup进行资源转组。 |
| GetInstanceList | 查询指定地域的实例信息 | 调用GetInstanceList查询指定地域的实例信息。 |
| GetAllowedIpList | 获取IP白名单 | 调用GetAllowedIpList获取IP白名单。 |
| GetAllInstanceIdList | 查询所有地域的实例ID | 调用GetAllInstanceIdList查询当前用户下所有实例ID集合。 |
| UpgradePostPayOrder | 升配后付费实例 | 调用UpgradePostPayOrder升配后付费实例。 |
| UpgradePrePayOrder | 升配预付费实例 | 调用UpgradePrePayOrder升配预付费实例。 |
| ConvertPostPayOrder | 将后付费实例转为预付费实例 | 调用ConvertPostPayOrder将后付费实例转为预付费实例。 |
| UpgradeInstanceVersion | 升级实例版本 | 调用UpgradeInstanceVersion接口升级实例版本。 |
| ReleaseInstance | 释放后付费实例 | 调用ReleaseInstance接口释放后付费实例。 |
Topic
| API | 标题 | API概述 |
|---|---|---|
| CreateTopic | 创建Topic | 调用CreateTopic创建Topic。 |
| DeleteTopic | 删除Topic | 调用DeleteTopic删除Topic。 |
| ModifyPartitionNum | 修改Topic的分区数 | 调用ModifyPartitionNum修改Topic的分区数。 |
| ModifyTopicRemark | 修改Topic的备注 | 调用ModifyTopicRemark修改Topic的备注。 |
| GetTopicList | 获取Topic信息 | 调用GetTopicList获取Topic信息。 |
| GetTopicStatus | 获取消息收发状态 | 调用GetTopicStatus获取Topic的消息收发状态。 |
| GetQuotaTip | 获取Topic和分区的使用配额 | 调用GetQuotaTip获取Topic和分区的使用配额。 |
消费组
| API | 标题 | API概述 |
|---|---|---|
| CreateConsumerGroup | 创建消费组 | 调用CreateConsumerGroup创建Group。 |
| DeleteConsumerGroup | 删除消费组 | 调用DeleteConsumerGroup删除Group。 |
| 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。 |