文档

API概览

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

服务

API标题API概述
OpenOnsService开通服务调用OpenOnsService开通云消息队列 RocketMQ 版服务。

消息

API标题API概述
OnsMessageTrace查看消息消费结果调用OnsMessageTrace根据Message ID来判断目标消息是否曾被消费过。
OnsMessageGetByMsgId通过MsgId查询消息通过传入 Message ID 查询指定消息的信息以及判断该指定的消息是否曾被消费过。
OnsMessageGetByKey根据Message Key查询消息根据 Topic 和 Message Key 模糊查询消息信息列表。
OnsMessagePageQueryByTopic查询Topic内所有消息分页查询指定时间段内指定Topic内存在的所有消息。
OnsMessageDetail查询消息详细信息调用OnsMessageDetail查询某条消息的具体信息。

地域

API标题API概述
OnsRegionList获取地域信息列表调用OnsRegionList获取云消息队列 RocketMQ 版目前开放服务的地域(Region)信息列表。

实例

API标题API概述
OnsInstanceCreate创建实例调用OnsInstanceCreate接口创建实例。
OnsInstanceBaseInfo查询实例基本信息和收发消息的接入点调用OnsInstanceBaseInfo接口查询实例基本信息和收发消息的接入点。
OnsInstanceUpdate更新实例名称和描述调用OnsInstanceUpdate接口更新实例名称和描述。
OnsInstanceInServiceList查询指定地域下实例列表查询当前账号在指定地域(Region)下所有的云消息队列 RocketMQ 版4.x实例信息。
OnsInstanceDelete删除实例调用OnsInstanceDelete接口删除云消息队列 RocketMQ 版实例。

Topic

API标题API概述
OnsTopicCreate创建Topic调用OnsTopicCreate接口创建Topic。
OnsTopicStatus查询Topic状态查询当前Topic下的消息总量以及Topic的状态。
OnsTopicList获取Topic列表信息查询账号下所有Topic的信息列表。
OnsTopicSubDetail查看Topic的订阅信息查看有哪些在线订阅组订阅了这个Topic。
OnsTopicDelete删除Topic调用OnsTopicDelete接口删除指定的Topic。

Group

API标题API概述
OnsGroupCreate创建客户端Group ID调用OnsGroupCreate创建客户端Group ID。
OnsGroupConsumerUpdate配置消费集群的消息读取权限配置指定Group ID对应的消费集群的消息读取权限。本接口一般用于禁止特定Group ID读取消息的场景。
OnsGroupList获取Group ID列表信息查询指定实例下所有的Group ID信息。
OnsGroupSubDetail查看Group ID的订阅信息查看Group订阅了哪些Topic,如果Group ID对应的消费者实例不在线则查不到数据。
OnsGroupDelete删除Group调用OnsGroupDelete删除Group。

标签

API标题API概述
ListTagResources查询资源绑定的标签列表调用ListTagResources查询资源绑定的标签列表。
TagResources为资源绑定标签调用TagResources为资源绑定标签。
UntagResources为资源解绑并删除标签调用UntagResources为资源解绑并删除标签。

消费

API标题API概述
OnsConsumerStatus查询Group ID消费状态查询指定Group ID详细状态数据:订阅关系检查、消费TPS统计、负载均衡状态、消费端连接。
OnsConsumerAccumulate查询消息消费堆积情况查询指定Group ID的消息消费堆积情况,包括当前消息堆积数量和消费延迟时间等。
OnsConsumerGetConnection查询Group ID客户端连接情况查询指定 Group ID 下当前客户端的连接情况。
OnsConsumerResetOffset重置Group ID消费位点重置指定的Group ID的消费位点到指定时间戳。
OnsConsumerTimeSpan查询Topic可重置时间范围查询Topic可重置的时间范围,即该Topic中储存的最早的和最晚的消息的生产时间。
OnsMessagePush向指定的消费者推送消息调用OnsMessagePush向指定的消费者推送消息。

消息收发数据统计

API标题API概述
OnsTrendTopicInputTps统计消息生产数据查询一段时间内指定的Topic的消息写入报表数据。
OnsTrendGroupOutputTps统计消息消费数据查询指定的Group ID在一段时间内消费消息的统计信息。

轨迹

API标题API概述
OnsTraceQueryByMsgId根据MsgId创建轨迹查询任务通过传入Topic名称和Message ID创建轨迹查询任务,得到该查询任务的ID。您需要再调用OnsTraceGetResult接口,传入返回的查询任务ID,获取消息轨迹的详细结果。
OnsTraceQueryByMsgKey根据Message Key创建轨迹查询任务通过传入Topic名称和Message Key创建轨迹查询任务,得到该查询任务的ID。您需要再调用OnsTraceGetResult接口,传入返回的查询任务ID,获取消息轨迹的详细结果。
OnsTraceGetResult获取轨迹查询结果通过传入轨迹查询任务的ID获取之前的轨迹查询结果。

死信

API标题API概述
OnsDLQMessagePageQueryByGroupId查询Group ID内所有死信消息通过传入Group ID和时间段,分页查询指定时间段内该Group ID内存在的所有死信消息。
OnsDLQMessageGetById根据Message ID查询死信消息通过传入Message ID查询指定的死信消息。包括存储时间、消息体、Key和Tag。
OnsDLQMessageResendById重发指定的死信消息重发指定Message ID的死信消息,使该消息能够被Consumer再次消费。