FolkMQ v1.7.8

集成管理接口

集成管理接口,是指用户要建立自己的管理中台,需要通过接口方式管理 FolkMQ。此功能,目前为试用阶段,未来接口有可能会变。

1、基础知识

  • 使用此接口,需要专门的令牌配置(folkmq.api.token
    • 如果是集群,则在 server-broker 节点添加配置
    • 如要是单例,则在 server 节点添加配置
  • 使用统一的接口进行调用,每次调用需要输入 token
  • 接口为弱类型约束。统一返回{code, data},就像 ajax
    • code=200 表示成功
    • code=400 表示失败

2、调用示例

//call 返回的是 CompletableFuture<String>,根据需要可以同步或异步
String json = client.call(MqApis.MQ_QUEUE_VIEW_MESSAGE, token, "demo","demoApp").get();

如果没有权限会直接出异常!

3、接口字典

接口说明返回结果格式示例
MqApis.MQ_QUEUE_LIST获取所有队列及消息数量{code,data:[]}
MqApis.MQ_QUEUE_VIEW_MESSAGE获取某个队列的消息数量{code,data:{}}
MqApis.MQ_QUEUE_VIEW_SESSION获取某个队列的所有消息者ip{code,data:[]}
MqApis.MQ_QUEUE_FORCE_DISTRIBUTE强制立即派发某个队列的所有消息{code,data}
MqApis.MQ_QUEUE_FORCE_CLEAR强制清空某个队列的所有消息{code,data}
MqApis.MQ_QUEUE_FORCE_DELETE强制删除某个队列{code,data}
  • MqApis.MQ_QUEUE_LIST
{code:200,data:[{queue,sessionCount,messageCount,messageDelayedCount1,...messageDelayedCount8}]}
  • MqApis.MQ_QUEUE_VIEW_MESSAGE
{code:200,data:{queue,sessionCount,messageCount,messageDelayedCount1,...messageDelayedCount8}}
  • MqApis.MQ_QUEUE_VIEW_SESSION
{code:200,data:["",""]}