文档

API概览

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

实例

API标题API概述
CreateInstance创建实例创建云消息队列 RocketMQ 版5.x系列实例。
UpdateInstance更新实例更新云消息队列 RocketMQ 版实例的基本信息和规格配置。
ChangeResourceGroup修改资源组修改实例所属的资源组。
DeleteInstance删除实例删除云消息队列 RocketMQ 版实例。
ListInstances查询实例列表查询指定地域下,所有的云消息队列 RocketMQ 版实例的列表信息。
GetInstance获取指定实例的详情获取某个指定实例的详细信息。

主题

API标题API概述
CreateTopic创建主题创建云消息队列 RocketMQ 版的主题(Topic)。主题是云消息队列 RocketMQ 版中消息传输和存储的顶层容器,用于标识同一类业务逻辑的消息。在消息收发模型中,生产者将消息发送至主题,消费者通过订阅指定的主题来消费其中的消息。
UpdateTopic更新主题更新主题的备注信息。
DeleteTopic删除主题删除指定主题。
ListTopics查询主题列表查询指定实例下的主题列表信息。
GetTopic获取指定主题的详情获取某个指定主题的详细信息。

消费者分组

API标题API概述
CreateConsumerGroup创建消费者分组创建云消息队列 RocketMQ 版的消费者分组(ConsumerGroup)。消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。消费者需要通过指定消费者分组订阅相关的主题来实现消息订阅。
UpdateConsumerGroup更新消费者分组更新消费者分组的基础信息和消费重试策略。
DeleteConsumerGroup删除消费者分组删除指定的消费者分组。
ListConsumerGroups查询消费者分组列表查询指定实例下消费者分组的列表信息。
GetConsumerGroup获取指定消费者分组详情获取某个指定消费者分组的详细信息。
ResetConsumeOffset重置消费位点重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时,您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费,您也可以将消费位置移动至最新位点,暂时不处理堆积的消息。
ListConsumerGroupSubscriptions查询消费者组订阅关系列表查询指定消费者组的订阅关系。

其他

API标题API概述
ListTopicSubscriptions查询主题订阅关系列表查询指定主题的订阅关系列表。
ListRegions查询地域列表查询地域列表。
ListConsumerConnections获取消费者客户端连接信息获取指定消费者客户端的连接信息。
ListAvailableZones查询支持的可用区查询支持的可用区。