阿里云OpenAPI开发者门户

云消息队列 RocketMQ 4.0 版 - OpenAPI 概览2019-02-14
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
服务
OpenAPI 名称描述操作
OpenOnsServicehot开通云消息队列 RocketMQ 版服务查看文档去调试
消息
OpenAPI 名称描述操作
OnsMessageTracehot根据Message ID来判断目标消息是否曾被消费过查看文档去调试
OnsMessageGetByMsgIdhot通过传入 Message ID 查询指定消息的信息以及判断该指定的消息是否曾被消费过查看文档去调试
OnsMessageGetByKey根据 Topic 和 Message Key 模糊查询消息信息列表查看文档去调试
OnsMessagePageQueryByTopic分页查询指定时间段内指定Topic内存在的所有消息查看文档去调试
OnsMessageDetail查询某条消息的具体信息查看文档去调试
地域
OpenAPI 名称描述操作
OnsRegionList获取云消息队列 RocketMQ 版目前开放服务的地域(Region)信息列表查看文档去调试
实例
OpenAPI 名称描述操作
OnsInstanceCreate创建实例查看文档去调试
OnsInstanceBaseInfohot查询实例基本信息和收发消息的接入点查看文档去调试
OnsInstanceUpdate更新实例名称和描述查看文档去调试
OnsInstanceInServiceListhot查询当前账号在指定地域(Region)下所有的云消息队列 RocketMQ 版4.x实例信息查看文档去调试
OnsInstanceDelete删除云消息队列 RocketMQ 版实例查看文档去调试
Topic
OpenAPI 名称描述操作
OnsTopicCreatehot创建Topic查看文档去调试
OnsTopicStatus查询当前Topic下的消息总量以及Topic的状态查看文档去调试
OnsTopicListhot查询账号下所有Topic的信息列表查看文档去调试
OnsTopicSubDetail查看有哪些在线订阅组订阅了这个Topic查看文档去调试
OnsTopicDelete删除指定的Topic查看文档去调试
Group
OpenAPI 名称描述操作
OnsGroupCreatehot创建客户端Group ID查看文档去调试
OnsGroupConsumerUpdate配置指定Group ID对应的消费集群的消息读取权限。本接口一般用于禁止特定Group ID读取消息的场景查看文档去调试
OnsGroupListhot查询指定实例下所有的Group ID信息查看文档去调试
OnsGroupSubDetail查看Group订阅了哪些Topic,如果Group ID对应的消费者实例不在线则查不到数据查看文档去调试
OnsGroupDelete删除Group查看文档去调试
标签
OpenAPI 名称描述操作
ListTagResources查询资源绑定的标签列表查看文档去调试
TagResources为资源绑定标签查看文档去调试
UntagResources为资源解绑并删除标签查看文档去调试
消费
OpenAPI 名称描述操作
OnsConsumerStatus查询指定Group ID详细状态数据:订阅关系检查、消费TPS统计、负载均衡状态、消费端连接查看文档去调试
OnsConsumerAccumulatehot查询指定Group ID的消息消费堆积情况,包括当前消息堆积数量和消费延迟时间等查看文档去调试
OnsConsumerGetConnection查询指定 Group ID 下当前客户端的连接情况查看文档去调试
OnsConsumerResetOffset重置指定的Group ID的消费位点到指定时间戳查看文档去调试
OnsConsumerTimeSpan查询Topic可重置的时间范围,即该Topic中储存的最早的和最晚的消息的生产时间查看文档去调试
OnsMessagePush向指定的消费者推送消息查看文档去调试
消息收发数据统计
OpenAPI 名称描述操作
OnsTrendTopicInputTps查询一段时间内指定的Topic的消息写入报表数据查看文档去调试
OnsTrendGroupOutputTps查询指定的Group ID在一段时间内消费消息的统计信息查看文档去调试
轨迹
OpenAPI 名称描述操作
OnsTraceQueryByMsgId通过传入Topic名称和Message ID创建轨迹查询任务,得到该查询任务的ID。您需要再调用OnsTraceGetResult接口,传入返回的查询任务ID,获取消息轨迹的详细结果查看文档去调试
OnsTraceQueryByMsgKey通过传入Topic名称和Message Key创建轨迹查询任务,得到该查询任务的ID。您需要再调用OnsTraceGetResult接口,传入返回的查询任务ID,获取消息轨迹的详细结果查看文档去调试
OnsTraceGetResult通过传入轨迹查询任务的ID获取之前的轨迹查询结果查看文档去调试
死信
OpenAPI 名称描述操作
OnsDLQMessagePageQueryByGroupId通过传入Group ID和时间段,分页查询指定时间段内该Group ID内存在的所有死信消息查看文档去调试
OnsDLQMessageGetById通过传入Message ID查询指定的死信消息。包括存储时间、消息体、Key和Tag查看文档去调试
OnsDLQMessageResendById重发指定Message ID的死信消息,使该消息能够被Consumer再次消费查看文档去调试
其他
OpenAPI 名称描述操作
deprecatedOnsTopicUpdate配置Topic的读写模式查看文档去调试