消息队列RocketMQ版提供以下相关API接口。
地域管理接口
API | 描述 |
---|---|
OnsRegionList | 使用OnsRegionList获取消息队列RocketMQ版目前开放服务的地域(Region)信息列表。 |
服务开通接口
API | 描述 |
---|---|
OpenOnsService | 调用OpenOnsService开通消息队列RocketMQ版服务。 |
实例管理接口
API | 描述 |
---|---|
OnsInstanceBaseInfo | 使用OnsInstanceBaseInfo查询实例基本信息和收发消息的接入点。 |
OnsInstanceCreate | 使用OnsInstanceCreate创建实例。 |
OnsInstanceDelete | 使用OnsInstanceDelete删除实例。 |
OnsInstanceInServiceList | 使用OnsInstanceInServiceList查询当前用户账号下某地域所有实例的信息。 |
OnsInstanceUpdate | 使用OnsInstanceUpdate更新实例名称和描述。 |
Topic管理接口
API | 描述 |
---|---|
OnsTopicCreate | 使用OnsTopicCreate创建Topic。 |
OnsTopicDelete | 使用OnsTopicDelete删除您账号下指定的Topic。 |
OnsTopicList | 使用OnsTopicList查询账号下所有Topic的信息列表。 |
OnsTopicStatus | 使用OnsTopicStatus查询当前Topic下的消息总量以及Topic的最后更新时间。 |
OnsTopicSubDetail | 使用OnsTopicSubDetail查看有哪些在线订阅组订阅了这个Topic。 |
Group管理接口
API | 描述 |
---|---|
OnsGroupCreate | 使用OnsGroupCreate创建客户端Group ID。 |
OnsGroupDelete | 使用OnsGroupDelete删除之前使用OnsGroupCreate接口创建的Group。 |
OnsGroupList | 使用OnsGroupList展示您的Group ID资源的列表,并不用于具体的信息查询。 |
OnsGroupSubDetail | 使用OnsGroupSubDetail查看Group订阅了哪些Topic,如果Group ID对应的消费者实例不在线则查不到数据。 |
OnsGroupConsumerUpdate | 使用OnsGroupConsumerUpdate配置指定Group ID对应的消费集群的消息读取权限。 |
标签管理接口
API | 描述 |
---|---|
TagResources | 使用TagResources为资源绑定标签。 |
ListTagResources | 使用ListTagResources查询资源绑定的标签列表。 |
UntagResources | 使用UntagResources为资源解绑并删除标签。 |
消费管理接口
API | 描述 |
---|---|
OnsConsumerAccumulate | 使用OnsConsumerAccumulate查询指定Group ID的消息消费堆积情况,包括当前消息堆积数量和消费延迟时间等。 |
OnsConsumerStatus | 使用OnsConsumerStatus查询指定Group ID的详细状态数据,包含订阅关系检查、消费TPS统计、负载均衡状态、消费端连接等。 |
OnsConsumerGetConnection | 使用OnsConsumerGetConnection查询指定Group ID下当前客户端的连接情况。 |
OnsConsumerResetOffset | 使用OnsConsumerResetOffset重置指定的Group ID的消费位点到指定时间戳。 |
OnsConsumerTimeSpan | 使用OnsConsumerTimeSpan查询当前Group ID订阅的Topic的最新消息时间戳以及消费的最新时间。 |
OnsMessagePush | 使用OnsMessagePush向指定的消费者推送消息。 |
消息查询接口
API | 描述 |
---|---|
OnsMessageTrace | 使用OnsMessageTrace根据Message ID来判断目标消息是否曾被消费过。 |
OnsMessageGetByMsgId | 使用OnsMessageGetByMsgId通过传入Message ID查询指定消息的信息以及判断该指定的消息是否曾被消费过。查询到的信息包括发送时间、存储服务器和消息的Key和Tag等属性。 |
OnsMessageGetByKey | 使用OnsMessageGetByKey通过传入Topic名称和Message Key进行模糊查询,得到符合条件的消息的信息列表。 |
OnsMessagePageQueryByTopic | 使用OnsMessagePageQueryByTopic通过传入Topic名称和时间段,分页查询指定时间段内该Topic内存在的所有消息。 |
发布订阅统计接口
API | 描述 |
---|---|
OnsTrendTopicInputTps | 使用OnsTrendTopicInputTps查询一段时间内指定的Topic的消息写入报表数据。 |
OnsTrendGroupOutputTps | 使用OnsTrendGroupOutputTps查询指定的Group ID在一段时间内消费消息的统计信息。 |
消息轨迹接口
API | 描述 |
---|---|
OnsTraceGetResult | 使用OnsTraceGetResult通过传入轨迹查询任务的ID获取之前的轨迹查询结果。 |
OnsTraceQueryByMsgId | 使用OnsTraceQueryByMsgId通过传入Topic名称和Message ID创建轨迹查询任务,得到该查询任务的ID。 |
OnsTraceQueryByMsgKey | 使用OnsTraceQueryByMsgKey通过传入Topic名称和Message Key创建轨迹查询任务,得到该查询任务的ID。 |
死信队列接口
API | 描述 |
---|---|
OnsDLQMessageGetById | 使用OnsDLQMessageGetById通过传入Message ID查询指定的死信消息。查询到的信息包括死信消息的存储时间、消息体、Key和Tag等属性。 |
OnsDLQMessagePageQueryByGroupId | 使用OnsDLQMessagePageQueryByGroupId通过传入Group ID和时间段,分页查询指定时间段内该Group ID内存在的所有死信消息。 |
OnsDLQMessageResendById | 使用OnsDLQMessageResendById通过传入Message ID重发指定的死信消息,使该消息能够被Consumer再次消费。 |