全部产品
云市场

API 概览

更新时间:2019-09-13 22:07:09

地域管理

API 描述
OnsRegionList 获取消息队列 MQ 目前开放服务的地域(Region)信息列表。

实例管理

API 描述
OnsInstanceBaseInfo 查询实例基本信息和收发消息的接入点。
OnsInstanceCreate 创建实例。
OnsInstanceDelete 删除实例。
OnsInstanceInServiceList 查询当前用户账号下某地域(Region)所有实例的信息。
OnsInstanceUpdate 更新实例名称和描述。

Topic 管理

API 描述
OnsTopicCreate 创建 Topic。
OnsTopicDelete 删除您账号下指定的 Topic。
OnsTopicList 查询账号下所有 Topic 的信息列表。
OnsTopicStatus 查询当前 Topic 下的消息总量以及 Topic 的最后更新时间。
OnsTopicUpdate 配置 Topic 的读写模式。
OnsTopicSubDetail 查看有哪些在线订阅组订阅了这个 Topic。

Group 管理

API 描述
OnsGroupCreate 创建客户端 Group ID。
OnsGroupDelete 删除之前使用 OnsGroupCreate 接口创建的 Group。
OnsGroupList 展示您的 Group ID 资源的列表,并不用于具体的信息查询。
OnsGroupSubDetail 查看 Group 订阅了哪些 Topic,如果 Group 不在线则查不到数据。
OnsGroupConsumerUpdate 配置指定 Group ID 对应的消费集群的消息读取权限。

消费管理

API 描述
OnsConsumerAccumulate 查询指定 Group ID 的消息消费堆积情况,包括当前消息堆积数量和消费延迟时间等。
OnsConsumerStatus 查询指定 Group ID 的详细状态数据,包含订阅关系检查、消费 TPS 统计、负载均衡状态、消费端连接等。
OnsConsumerGetConnection 查询指定 Group ID 下当前客户端的连接情况。
OnsConsumerResetOffset 重置指定的 Group ID 的消费位点到指定时间戳。
OnsConsumerTimeSpan 查询当前 Group ID 订阅的 Topic 的最新消息时间戳以及消费的最新时间。

消费查询

API 描述
OnsMessageTrace 根据 Message ID 来判断目标消息是否曾被消费过。
OnsMessageGetByMsgId 通过传入 Message ID 查询指定消息的信息以及判断该指定的消息是否曾被消费过。查询到的信息包括发送时间、存储服务器和消息的 Key 和 Tag 等属性。
OnsMessageGetByKey 通过传入 Topic 名称和 Message Key 进行模糊查询,得到符合条件的消息的信息列表。
OnsMessagePageQueryByTopic 通过传入 Topic 名称和时间段,分页查询指定时间段内该 Topic 内存在的所有消息。

发布订阅统计

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

消息轨迹

API 描述
OnsTraceGetResult 通过传入轨迹查询任务的 ID 获取之前的轨迹查询结果。
OnsTraceQueryByMsgId 通过传入 Topic 名称和 Message ID 创建轨迹查询任务,得到该查询任务的 ID。
OnsTraceQueryByMsgKey 通过传入 Topic 名称和 Message Key 创建轨迹查询任务,得到该查询任务的 ID。

死信队列

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