文档

API概览

更新时间:
本产品(云消息队列 Kafka 版/2019-09-16)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

实例

API标题API概述
EnableAutoGroupCreation开启自由使用 Group本文介绍如何调用 EnableAutoGroupCreation 开启和关闭自由使用 Gopic。
EnableAutoTopicCreation开启自动创建 Topic本文介绍如何调用 EnableAutoTopicCreation 开启和关闭自动创建Topic,以及修改自动创建 Topic 默认分区数。
CreatePostPayOrder创建后付费实例后付费实例根据所购资源规格的实际使用量计费,先使用,后计费。主要适用于测试或者流量峰值不确定的短期场景。本文介绍如何调用CreatePostPayOrder创建后付费实例。
CreatePrePayOrder创建预付费实例预付费实例需要先付费才能使用资源,主要适用于长期稳定的业务运行场景。本文介绍调用CreatePrePayOrder创建预付费实例。
DeleteInstance删除实例当预付费实例或后付费实例被释放后可删除实例,本文介绍如何调用DeleteInstance删除实例。
StartInstance部署实例如需使用云消息队列 Kafka 版收发消息,需要购买并部署才可使用,本文介绍如何调用StartInstance部署实例。
ModifyInstanceName修改实例的名称实例部署完成后,云消息队列 Kafka 版支持修改实例的名称。本文介绍如何调用ModifyInstanceName修改实例的名称。
UpdateAllowedIp变更IP白名单您可以编辑访问云消息队列 Kafka 版的白名单,配置在白名单中的IP地址与端口才允许访问云消息队列 Kafka 版实例,本文介绍如何调用UpdateAllowedIp变更IP白名单。
UpdateInstanceConfig修改实例的配置实例部署后,允许修改实例是否开启ACL、SSL、消息保留时长及最大消息大小,本文介绍如何调用UpdateInstanceConfig修改实例配置。
ChangeResourceGroup更改实例所在的资源组进行资源转组。
GetInstanceList查询指定地域的实例信息查询指定地域的实例信息。
GetAllowedIpList获取IP白名单获取IP白名单。
GetAllInstanceIdList查询所有地域的实例ID查询当前用户下所有实例ID集合。
UpgradePostPayOrder升配后付费实例升配后付费实例。
UpgradePrePayOrder升配预付费实例升配预付费实例。
ConvertPostPayOrder将后付费实例转为预付费实例将后付费实例转为预付费实例。
UpgradeInstanceVersion升级实例版本升级实例版本。
ReleaseInstance释放后付费实例释放后付费实例。

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。
  • 本页导读 (1)
文档反馈