本产品（
云消息队列 RocketMQ 5.0 版/2022-08-01）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
实例
| API | 标题 | API概述 |
|---|---|---|
| CreateInstance | 创建实例 | 创建云消息队列 RocketMQ 版5.x系列实例。 |
| UpdateInstance | 更新实例 | 更新云消息队列 RocketMQ 版实例的基本信息和规格配置。 |
| DeleteInstance | 删除实例 | 释放实例 |
| ListInstances | 查询实例列表 | 查询指定地域下，所有的云消息队列 RocketMQ 版实例的列表信息。 |
| GetInstance | 获取指定实例的详情 | 获取某个指定实例的详细信息。 |
主题
| API | 标题 | API概述 |
|---|---|---|
| CreateTopic | 创建主题 | 创建云消息队列 RocketMQ 版的主题（Topic）。主题是云消息队列 RocketMQ 版中消息传输和存储的顶层容器，用于标识同一类业务逻辑的消息。在消息收发模型中，生产者将消息发送至主题，消费者通过订阅指定的主题来消费其中的消息。 |
| UpdateTopic | 更新主题 | 更新主题的备注信息。 |
| DeleteTopic | 删除主题 | 删除指定主题。 |
| ListTopics | 查询主题列表 | 查询指定实例下的主题列表信息。 |
| GetTopic | 获取指定主题的详情 | 获取某个指定主题的详细信息。 |
消费者分组
| API | 标题 | API概述 |
|---|---|---|
| CreateConsumerGroup | 创建消费者分组 | 创建云消息队列 RocketMQ 版的消费者分组（ConsumerGroup）。消费者分组是云消息队列 RocketMQ 版系统中承载多个消费行为一致的消费者的负载均衡分组。消费者需要通过指定消费者分组订阅相关的主题来实现消息订阅。 |
| UpdateConsumerGroup | 更新消费者分组 | 更新消费者分组的基础信息和消费重试策略。 |
| DeleteConsumerGroup | 删除消费者分组 | 删除指定的消费者分组。 |
| ListConsumerGroups | 查询消费者分组列表 | 查询指定实例下消费者分组的列表信息。 |
| GetConsumerGroup | 获取指定消费者分组详情 | 获取某个指定消费者分组的详细信息。 |
订阅关系
| API | 标题 | API概述 |
|---|---|---|
| ListTopicSubscriptions | 查询主题订阅关系列表 | 查询主题订阅关系列表。 |
| DeleteConsumerGroupSubscription | 删除消费者组订阅关系 | 删除消费者组订阅关系。 |
| ListConsumerGroupSubscriptions | 查询消费者组订阅关系列表 | 查询消费组订阅关系列表。 |
| GetConsumerGroupSubscription | 获取消费者组订阅关系详情 | 获取消费组订阅关系详情，包括客户端分布等信息。 |
消费
| API | 标题 | API概述 |
|---|---|---|
| ResetConsumeOffset | 重置消费位点 | 重置指定消费者分组的消费位点。重置消费位点是指改变订阅者当前的消费位置。当消费者出现故障或者消费错误数据时，您可通过重置消费位点将消费位置回滚到之前的某个位点重新开始消费，您也可以将消费位置移动至最新位点，暂时不处理堆积的消息。 |
| GetConsumerGroupLag | 查询消费者组堆积信息 | 查询消费者组堆积信息。 |
| GetConsumerStack | 获取消费者堆栈信息 | 获取消费者堆栈信息。 |
| ListConsumerConnections | 获取消费者客户端连接信息 | 获取指定消费者客户端的连接信息。 |
消息
| API | 标题 | API概述 |
|---|---|---|
| VerifySendMessage | 消息发送验证 | 验证指定实例下指定主题的消息发送功能。 |
| VerifyConsumeMessage | 消息消费验证 | 验证指定实例下指定主题的消息消费状态。 |
| ListMessages | 查询消息列表 | 查询消息列表。 |
| GetMessageDetail | 获取消息详情 | 获取指定消息的详情。 |
轨迹
| API | 标题 | API概述 |
|---|---|---|
| ListTraces | 查询轨迹消息列表 | 查询指定主题下的轨迹消息列表。 |
| GetTrace | 获取消息轨迹 | 获取指定主题下的指定消息轨迹。 |
ACL
| API | 标题 | API概述 |
|---|---|---|
| CreateInstanceAccount | 创建访问账号 | 创建实例的访问账号。 |
| CreateInstanceAcl | 创建访问权限 | 在指定实例下创建访问的权限信息。 |
| DeleteInstanceAccount | 删除访问账号 | 删除指定实例下的访问账号信息。 |
| CreateInstanceIpWhitelist | 创建IP白名单 | 创建访问控制IP白名单。 |
| DeleteInstanceAcl | 删除访问权限 | 删除指定实例下，指定账号和资源的权限。 |
| DeleteInstanceIpWhitelist | 删除IP白名单 | 删除指定实例下的指定全局IP白名单。 |
| UpdateInstanceAcl | 更新访问权限 | 更新指定实例下，指定用户和资源的访问权限。 |
| UpdateInstanceAccount | 更新访问账号 | 更新指定实例下指定账号的信息。 |
| ListInstanceIpWhitelist | 查询IP白名单列表 | 查询访问控制IP白名单列表。 |
| ListInstanceAcl | 查询访问权限列表 | 查询指定实例下的访问权限列表。 |
| ListInstanceAccount | 查询访问账号列表 | 查询指定实例下访问账号的列表。 |
| GetInstanceAccount | 获取实例账号 | 获取指定实例的账号。 |
标签
| API | 标题 | API概述 |
|---|---|---|
| ListTagResources | 查询资源标签关系 | 查询可见的资源标签关系。 |
| UntagResources | 删除标签资源关系 | 用户删除标签资源关系。 |
| TagResources | 创建标签资源关系 | 用户创建标签资源关系。 |
资源组
| API | 标题 | API概述 |
|---|---|---|
| ChangeResourceGroup | 修改资源组 | 修改实例所属的资源组。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| ListRegions | 查询地域列表 | 查询地域列表。 |
| ListAvailableZones | 查询支持的可用区 | 查询支持的可用区。 |