参考API接口说明文档

# 版本更新说明

本文档最新版本包含历史修改记录如下：

更新日期 手册版本 适用产品 更新说明
2025年12月 V1.0 金蝶Apusic分布式消息队列V2.0.6 首次编写

# ADMQ管控台接口文档

# 概述部分

# 统一返回体格式

所有接口请求的响应均为json类型的返回体，返回体具有相同的格式

{
  "code": 0,
  "message": "success",
  "data": {}
}
1
2
3
4
5

返回体中各字段的含义如下表所示

名称 类型 描述
code int 错误码，0代表执行成功，非0代表执行失败的某一种情况
message String 错误码提示信息，执行成功为"success"
data 任意类型 返回数据，执行失败时为详细出错信息

由于执行成功的情况下code字段与message字段相同，后续在介绍接口的返回结果时，只介绍返回数据的data字段

# 错误码汇总

错误码 提示信息 含义
0 SUCCESS 成功执行
1 ERROR 未知异常，错误详情请查看系统日志
6 AUTHORIZE_FAILED 认证失败
7 PERMISSION_DENY 没有权限
12 MQ_GET_ADMIN_FAILED 集群管理服务接口异常，请检查集群是否启动成功并充实
15 SSH_COMMAND_EXEC_FAILED SSH命令执行失败
22 LICENSE_EXPIRED License已过期，请重新申请新的License或者减少节点数
202 TOKEN_INVALID 当前用户未登录，请重新登陆
1000 CLUSTER_NAME_EXIST （集群）名称已经存在
1202 PACKAGE_NEED 请选择软件包上传
1204 PACKAGE_NAME_ILLEGAL 软件包名称格式必须是 名称-V版本号-芯片架构.压缩格式
1250 SERVER_DIR_ILLEGAL 程序目录和数据目录不能存在包含关系
1251 SERVER_EXIST 服务器已存在
1253 SERVER_CONNOT_CONNECT 服务器节点无法连接，请检查连接信息或网络
1262 SERVER_NOT_EXIST 服务器不存在
1263 AREA_EXIST 可用区已存在
1264 AREA_NOT_EXIST 可用区不存在
1406 DEPLOYED_NODE_MISS_OR_NOT_FOUND 未找到可部署的节点
1407 NODE_UNDER_CAN_NOT_DEPLOYED 存在节点不可用状态，自身处于未部署或部署中状态
1500 CLUSTER_PLUGIN_NOT_FOUND 插件不存在
1501 CLUSTER_PLUGIN_UPDATE_FAILED 插件更新失败，错误详情请查看系统日志
1502 CLUSTER_PLUGIN_LOAD_FAILED 插件加载失败，错误详情请查看系统日志
1503 CLUSTER_PLUGIN_UNLOAD_FAILED 插件卸载失败，错误详情请查看系统日志
1504 CLUSTER_PLUGIN_DISTRIBUTE_FAILED 插件下发失败，错误详情请查看系统日志

# 上下文路径

ADMQ管控台的API上下文路径由于功能过多，暂时没有规律性的统一，一般情况都是以/admq-manager路径作为前缀，后续路径根据功能模块的不同使用不同的路径

# 鉴权

首先需要使用用户名和密码登陆ADMQ管控台

输入正确的用户名和密码，进行用户检测，密码需加密
curl -X POST 'http://127.0.0.1:12305/admq-manager/login/checkUser'\
-H 'Content-Type: application/json'\
-d '{"name":"admq","password":"3d4c7047007d736b6c3f59341ee8341deb751ade53d09e0dfb41af02c4b53dd6"}'

若用户名和密码正确，返回信息如下
{
    "code": 0,
    "msg": "成功",
    "data": {
        "userEmail": "youraccount@163.com",
        "uuidByUser": "abc47e97-9b20-4a62-9552-465ae5d23ff2"
    }
}
通过uuid获取对应的token值
curl -X POST '127.0.0.1:12305/admq-manager/login'\
-H 'Content-Type: application/json'
-d '{"uuidByUser":"abc47e97-9b20-4a62-9552-465ae5d23ff2"}'
返回信息如下
{
    "code": 0,
    "msg": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjM0NjAzMDYxMDEiLCJleHAiOjE3NjM2MzMxMDZ9.dEyY7xwsc7sEvWmISXICMmoIkOEU5ij5EFNfkq5GoCk"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

接下来在使用管控台相关功能接口的时候，应当使用该token鉴权，在相关应用添加token配置，或者在使用命令的时候添加-H "Authorization: Bearer token"

# 服务器管理

# 添加可用区

  • 接口描述

​ 根据自定义的可用区名称创建管控台默认可用区-“默认可用区”，用于规范划分节点

  • 请求方式 POST

  • 请求url

    /admq-manager/area
    1

  • 请求参数

    参数名 类型 必填 参数描述
    code string 是 可用区编码
    area string 是 可用区名称

  • 返回数据

    使用curl命令

     curl -X POST 'http://127.0.0.1:12305/admq-manager/area' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NTY3ODEzNDgiLCJleHAiOjE3NjQ3Mjk1ODF9.O3Wv2O-H17AaajRupW3bPJNa3qyykwzdO32ijv_fXkU' -H 'Content-Type: application/json' -d '{"code":"Test","area":"test"}'
    1

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 查看可用区

  • 接口描述 展示当前管理控制台的可用区列表

  • 请求方式 GET

  • 请求url

    /admq-manager/area?pageNum=1&pageSize=10
    1

  • 请求参数 如果不填，则使用默认的1和10

    参数名 类型 必填 参数描述
    pageNum int 是 页数
    pageSize int 是 页面大小

  • 返回数据

    使用curl命令

    curl -X GET 'http://127.0.0.1:12305/admq-manager/area?pageNum=1&pageSize=10' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NTY3ODEzNDgiLCJleHAiOjE3NjQ3Mjk1ODF9.O3Wv2O-H17AaajRupW3bPJNa3qyykwzdO32ijv_fXkU'
    1

    返回信息如下

    {"code":0,"msg":"成功","data":{"total":1,"pageNum":1,"pageSize":10,"pages":1,"list":[{"id":"1","createTime":"2023-03-22 16:40:23","updateTime":"2023-03-22 16:40:23","code":"default","area":"默认可用区"}]}}
    1

    data展示可用区相关信息列表

    参数名 类型 描述
    id string 可用区id
    createTime string 创建时间
    updateTime string 更新时间
    code string 可用区编码
    area string 可用区名称

# 删除可用区

  • 接口描述

​ 根据生成的可用区id删除管控台默认可用区

  • 请求方式 DELETE

  • 请求url

    /admq-manager/area
    1

  • 请求参数

    参数名 类型 必填 参数描述
    id string 是 可用区id

  • 返回数据

    使用curl命令

    curl -X DELETE 'http://127.0.0.1:12305/admq-manager/area' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NTY3ODEzNDgiLCJleHAiOjE3NjQ3Mjk1ODF9.O3Wv2O-H17AaajRupW3bPJNa3qyykwzdO32ijv_fXkU' -H 'Content-Type: application/json' -d '{"id":"1995325829847502849"}'
    1

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 添加服务器节点

  • 接口描述

    添加新的服务器节点

  • 请求方式 POST

  • 请求url

    /admq-manager/server
    1

  • 请求参数

    参数名 类型 必填 参数描述
    room string 是 默认可用区
    managerIp string 是 服务器节点的管理ip地址
    sshPort int 是 服务器节点使用的ssh端口
    account string 是 服务器节点认证用户角色
    password string 是 服务器节点认证用户密码
    programDir string 是 服务器节点程序目录
    dataDir string 是 服务器节点数据目录
    dataIp string 是 服务器节点的数据ip地址

  • 返回数据 使用curl命令

    curl -X POST 'http://127.0.0.1:12305/admq-manager/server' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NjgwNzcyMDUiLCJleHAiOjE3NjQ3NDA4Nzd9.uXE0Zd1m_Ug_p1xWaQOaPMTNCd9gmPX5ROOxnjIuQEM' -H 'Content-Type: application/json' -d '{"room":"默认可用 区","managerIp":"172.20.140.175","sshPort":22,"account":"root","password":"1qazXSW@","programDir":"/usr/local","dataDir":"/var/local","dataIp":"172.20.140.175"}'
    1

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 查看服务器节点列表

  • 接口描述

    分页战术服务器节点列表

  • 请求方式

    GET

  • 请求url

    /admq-manager/server?pageNum=1&pageSize=10
    1

  • 请求参数

    参数名 类型 必填 参数描述
    pageNum int 是 页码
    pageSize int 是 页面大小
    serverUseType int 是 服务展示类型：0表示集群部署使用的服务器节点，1表示集群注册使用的服务器节点
    managerIp string 否 根据输入的ip模糊匹配筛选

  • 返回数据 使用curl命令

    curl -X GET 'http://127.0.0.1:12305/admq-manager/server?pageNum=1&pageSize=10' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NTY3ODEzNDgiLCJleHAiOjE3NjQ3Mjk1ODF9.O3Wv2O-H17AaajRupW3bPJNa3qyykwzdO32ijv_fXkU'
    1

    返回信息如下：

    {"code":0,"msg":"成功","data":{"total":6,"pageNum":1,"pageSize":10,"pages":1,"list":[{"id":"1981719141433319426","createTime":"2025-10-24 21:47:16","updateTime":"2025-12-01 11:05:00","managerIp":"172.20.140.175","dataIp":"172.20.140.175","account":"root","password":"1qazXSW@","programDir":"/usr/local","dataDir":"/var/local","sshPort":22,"room":"默认可用区","cpuInfo":" ","cpuType":1,"serverExporterStatus":0,"deployClusters":"mqtt-175"},{"id":"1981719665582907394","createTime":"2025-10-24 21:49:21","updateTime":"2025-12-01 11:05:00","managerIp":"172.20.140.184","dataIp":"172.20.140.184","account":"root","password":"1qazXSW@","programDir":"/usr/local","dataDir":"/var/local","sshPort":22,"room":"默认可用区","cpuInfo":" ","cpuType":1,"serverExporterStatus":0,"deployClusters":"kafka-184"},{"id":"1981719754791559169","createTime":"2025-10-24 21:49:42","updateTime":"2025-12-01 11:05:00","managerIp":"172.20.140.181","dataIp":"172.20.140.181","account":"root","password":"1qazXSW@","programDir":"/usr/local","dataDir":"/var/local","sshPort":22,"room":"默认可用区","cpuInfo":" ","cpuType":1,"serverExporterStatus":0,"deployClusters":"mqtt-cluster,kafka-cluster,mqtt-cluster-v2.4.5"},{"id":"1981720243448946689","createTime":"2025-10-24 21:51:39","updateTime":"2025-12-01 11:05:00","managerIp":"172.20.140.182","dataIp":"172.20.140.182","account":"root","password":"1qazXSW@","programDir":"/usr/local","dataDir":"/var/local","sshPort":22,"room":"默认可用区","cpuInfo":" ","cpuType":1,"serverExporterStatus":0,"deployClusters":"mqtt-cluster,kafka-cluster,mqtt-cluster-v2.4.5"},{"id":"1981720345559277569","createTime":"2025-10-24 21:52:03","updateTime":"2025-12-01 11:05:00","managerIp":"172.20.140.183","dataIp":"172.20.140.183","account":"root","password":"1qazXSW@","programDir":"/usr/local","dataDir":"/var/local","sshPort":22,"room":"默认可用区","cpuInfo":" ","cpuType":1,"serverExporterStatus":0,"deployClusters":"mqtt-cluster,kafka-cluster,mqtt-cluster-v2.4.5"},{"id":"1981722557198999553","createTime":"2025-10-24 22:00:50","updateTime":"2025-12-01 11:05:00","managerIp":"172.20.140.164","dataIp":"172.20.140.164","account":"root","password":"1qazXSW@","programDir":"/apusic/admq/v2.4/program","dataDir":"/apusic/admq/v2.4/data","sshPort":22,"room":"默认可用区","cpuInfo":" ","cpuType":1,"serverExporterStatus":0,"deployClusters":"mqtt-164"}]}}
    1
    参数名 类型 描述
    id string 服务器id
    room string 默认可用区
    managerIp string 服务器节点的管理ip地址
    sshPort int 服务器节点使用的ssh端口
    account string 服务器节点认证用户角色
    password string 服务器节点认证用户密码
    programDir string 服务器节点程序目录
    dataDir string 服务器节点数据目录
    dataIp string 服务器节点的数据ip地址
    cpuInfo string 服务器节点描述
    cpuType int 服务器节点类型
    serverExporterStatus int 采集器部署状态
    deployClusters string 服务器节点部署集群名称

# 删除服务器节点

  • 接口描述

​ 根据生成的服务器节点id删除管控台服务器节点

  • 请求方式 DELETE

  • 请求url

    /admq-manager/server
    1

  • 请求参数

    参数名 类型 必填 参数描述
    id string 是 服务器节点id

  • 返回数据 使用curl命令

    curl -X DELETE 'http://127.0.0.1:12305/admq-manager/server'  -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NjgwNzcyMDUiLCJleHAiOjE3NjQ3NDA4Nzd9.uXE0Zd1m_Ug_p1xWaQOaPMTNCd9gmPX5ROOxnjIuQEM' -H 'Content-Type: application/json' -d '{"id":"1995369559967191041"}'
    1

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 查看软件包列表

  • 接口描述 查看当前管控台已经上传的软件包

  • 请求方式 GET

  • 请求url

    /admq-manager/package?pageNum=1&pageSize=10&effective=1
    1

  • 请求参数

    参数名 类型 必填 参数描述
    pageNum int 是 页码
    pageSize int 是 页面大小
    effective int 是 软件包禁用参数 1表示否 0表示是

  • 返回数据 使用curl命令

    curl -X GET 'http://127.0.0.1:12305/admq-manager/package?pageNum=1&pageSize=10&effective=1'  -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ1NjgwNzcyMDUiLCJleHAiOjE3NjQ3NDA4Nzd9.uXE0Zd1m_Ug_p1xWaQOaPMTNCd9gmPX5ROOxnjIuQEM'
    1

    返回信息如下

    {"code":0,"msg":"成功","data":{"total":3,"pageNum":1,"pageSize":10,"pages":1,"list":[{"id":"1983433984280469506","createTime":"2025-10-29 15:21:26","updateTime":"2025-10-29 15:21:26","name":"admq-V3.0.13-all.tar.gz","version":"3.0.13","filePath":"/opt/admq-manager-V2.4-SNAPSHOT/data/admq-packages/admq_3.0.13/admq-V3.0.13-all.tar.gz","fileSize":257,"mqType":0,"cpu":"all","packageType":0,"effective":1},{"id":"1983008557208543233","createTime":"2025-10-28 11:10:57","updateTime":"2025-10-28 11:10:57","name":"admq-V4.0.5-all.tar.gz","version":"4.0.5","filePath":"/opt/admq-manager-V2.4-SNAPSHOT/data/admq-packages/admq_4.0.5/admq-V4.0.5-all.tar.gz","fileSize":298,"mqType":0,"cpu":"all","packageType":0,"effective":1},{"id":"1981717644989538306","createTime":"2025-10-24 21:41:19","updateTime":"2025-10-24 21:41:19","name":"admq-V2.4.5-all.tar.gz","version":"2.4.5","filePath":"/opt/admq-manager-V2.4-SNAPSHOT/data/admq-packages/admq_2.4.5/admq-V2.4.5-all.tar.gz","fileSize":221,"mqType":0,"cpu":"all","packageType":0,"effective":1}]}}
    1
    参数名 类型 描述
    id string 软件包id
    createTime string 创建时间
    updateTime string 更新时间
    name string 软件包名称
    version string 软件包版本号
    filePath string 软件包存储在管控台节点的文件地址
    fileSize string 软件包大小
    mqType int 软件包类型
    cpu string 架构类型：all,x86,arm
    effective int 软件包禁用参数 1表示否 0表示是

# 集群管理

# 新增集群

  • 接口描述

    选择服务器节点信息创建集群

  • 请求方式

    POST

  • 请求url

    /admq-manager/admq/cluster
    1

  • 请求参数

    参数名 类型 必填 参数描述
    zkList array 是 ZooKeeper 节点列表，每个节点包含管理 IP、数据目录和程序目录。
    zkList[].managerIp string 是 ZooKeeper 节点的管理 IP 地址。
    zkList[].dataDir string 是 ZooKeeper 节点的数据存储目录路径（支持 {cluster} 和 {nodeDir} 占位符）。
    zkList[].programDir string 是 ZooKeeper 节点的程序安装目录路径（支持 {cluster} 和 {nodeDir} 占位符）。
    storageList array 是 存储节点（如 BookKeeper）列表，结构同 zkList。
    storageList[].managerIp string 是 存储节点的管理 IP 地址。
    storageList[].dataDir string 是 存储节点的数据目录路径（支持占位符）。
    storageList[].programDir string 是 存储节点的程序目录路径（支持占位符）。
    brokerList array 是 消息 Broker节点列表。
    brokerList[].managerIp string 是 Broker 节点的管理 IP 地址。
    brokerList[].dataDir string 是 Broker 节点的数据目录路径（支持占位符）。
    brokerList[].programDir string 是 Broker 节点的程序目录路径（支持占位符）。
    clusterAliasName string 是 集群别名，用于标识该消息中间件集群。
    deployAgreementType integer 是 部署协议类型，默认为0(0:admq,1:rocketmq)
    mode integer 是 部署模式
    packageId string 是 部署包唯一标识 ID。
    zkUrl string 是 ZooKeeper 连接地址列表，多个 IP 用逗号分隔（如 "172.20.140.204,172.20.140.203,172.20.140.205"）。
    bookkeeperUrl string 是 BookKeeper 服务地址列表，格式同 zkUrl。
    brokerUrl string 是 Broker 服务地址列表，用于客户端连接，格式同 zkUrl。
    secertType integer 是 安全认证类型
    openKafka integer 是 是否启用 Kafka 协议（0=不启用，1=启用）。
    openRabbitmq integer 是 是否启用 RabbitMQ 协议（0=不启用，1=启用）。
    openRocketmq integer 是 是否启用 RocketMQ 协议（0=不启用，1=启用）。
    openMqtt integer 是 是否启用 MQTT 协议（0=不启用，1=启用）。

  • 返回数据

    建议使用页面，使用curl命令（命令过于复杂）

    curl -X POST 'http://127.0.0.1:12305/admq-manager/admq/cluster'  -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2Mzg5ODgyNjkiLCJleHAiOjE3NjQ4MTE3ODh9.QSomkiNmo67VzobpNjmwomuo05rL3ws4psAbEYkRMiM' -H 'Content-Type: application/json' -d
'{
  "zkList": [
    {
      "managerIp": "172.24.4.232",
      "dataDir": "/apusic/admq/v2.4/data/{cluster}/standalone/{nodeDir}",
      "programDir": "/apusic/admq/v2.4/program/{cluster}/standalone/{nodeDir}"
    }
  ],
  "storageList": [
    {
      "managerIp": "172.24.4.232",
      "dataDir": "/apusic/admq/v2.4/data/{cluster}/standalone/{nodeDir}",
      "programDir": "/apusic/admq/v2.4/program/{cluster}/standalone/{nodeDir}"
    }
  ],
  "brokerList": [
    {
      "managerIp": "172.24.4.232",
      "dataDir": "/apusic/admq/v2.4/data/{cluster}/standalone/{nodeDir}",
      "programDir": "/apusic/admq/v2.4/program/{cluster}/standalone/{nodeDir}"
    }
  ],
  "clusterAliasName": "Test",
  "deployAgreementType": 0,
  "mode": 0,
  "packageId": "1991397672244678657",
  "zkUrl": "172.24.4.232",
  "bookkeeperUrl": "172.24.4.232",
  "brokerUrl": "172.24.4.232",
  "secertType": 1,
  "openKafka": 0,
  "openRabbitmq": 0,
  "openRocketmq": 0,
  "openMqtt": 1
}
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群单个节点部署

  • 接口描述

    对创建的集群下的单个节点进行部署

  • 请求方式

    POST

  • 请求url

    /admq-manager/admq/deploy
    1

  • 请求参数

    参数名 类型 必填 参数描述
    id string 是 节点Id

  • 返回数据 使用curl命令

    curl -X POST 'http://127.0.0.1:12305/admq-manager/admq/deploy'  -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2Mzg5ODgyNjkiLCJleHAiOjE3NjQ4MTE3ODh9.QSomkiNmo67VzobpNjmwomuo05rL3ws4psAbEYkRMiM' -H 'Content-Type: application/json' -d '{"id":"1995680267035963394"'
    1

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群多个节点一键部署

  • 接口描述

    选择一个集群下多个节点同时一键部署

  • 请求方式

    POST

  • 请求url

    /admq-manager/admq/oneKeyCmd
    1

  • 请求参数

    参数名 类型 必填 参数描述
    clusterId string 是 该集群对应的id
    deployAgreementType int 是 部署协议类型，默认为0(0:admq,1:rocketmq)
    cmd string 是 命令（deploy；start；stop）
    nodeIds string 是 集群需要部署的服务节点对应的id

  • 返回数据 使用curl命令

    curl -X POST 'http://127.0.0.1:12305/admq-manager/admq/oneKeyCmd'  -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2Mzg5ODgyNjkiLCJleHAiOjE3NjQ4MTE3ODh9.QSomkiNmo67VzobpNjmwomuo05rL3ws4psAbEYkRMiM' -H 'Content-Type: application/json' -d 
'{
  "deployAgreementType": 0,
  "clusterId": "1995680266956271618",
  "cmd": "deploy",
  "nodeIds": "1995680267035963394"
}'
    1
    2
    3
    4
    5
    6
    7

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群节点信息展示

  • 接口描述

    展示集群所有节点的基本信息

  • 请求方式 GET

  • 请求url

    /admq-manager/cluster/nodes
    1

  • 请求参数

    参数名 类型 必填 参数描述
    clusterId string 是 集群id
    pageNum int 是 页数
    pageSize int 是 页面大小

  • 返回数据 使用curl命令

    curl -X GET 'http://127.0.0.1:12305/admq-manager/cluster/nodes?pageNum=1&pageSize=10&clusterId=1993148229251305473' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0'
    1

    返回信息

    {"code":0,"msg":"成功","data":{"total":1,"pageNum":1,"pageSize":10,"pages":1,"list":[{"id":"1993148229330997250","createTime":"2025-11-25 10:42:23","updateTime":"2025-12-02 13:47:24","clusterName":"iHlCZnfe","clusterAliasName":"mqtt-175","ip":"172.20.140.175","serverIp":"172.20.140.175","clusterId":"1993148229251305473","fileMap":{"1993148229301637121":"standalone.conf"},"componentType":4,"status":1,"deployStatus":2,"programPath":"/usr/local/iHlCZnfe/standalone/upfXhl50","programDataPath":"/var/local/iHlCZnfe/standalone/upfXhl50","packageId":"1981717644989538306","configFileId":"1993148229301637121","room":"默认可用区","deployAgreementType":0,"componentTypeStr":"admq单机程序","mode":0,"ampFacilityId":0,"ampMonitorId":0,"ampKopMonitorId":0,"ampKopFacilityId":0,"ampUrl":"","syncNodeConfigStatus":0,"serverPort":6650}]}}
    1
    参数名 类型 描述
    id string 服务器节点id
    createTime string (datetime) 创建时间，格式为 yyyy-MM-dd HH:mm:ss
    updateTime string (datetime) 最后更新时间，格式同上
    clusterName string 集群的技术名称（内部标识），如 "ZeMApKSJ"，可能用于系统内部引用
    clusterAliasName string 集群的别名/显示名称，如 "admq-cluster"，供用户友好展示
    ip string 集群节点或服务的 IP 地址（如 ZooKeeper 节点 IP）
    serverIp string 服务实际绑定的服务器 IP，通常与 ip 相同，用于部署定位
    clusterId string 所属集群的主 ID（关联到集群元数据）
    fileMap object 文件 ID 到文件名的映射，例如配置文件 ID → 文件名（如 "1906607968136769537": "zookeeper.conf"）
    componentType integer 组件类型编码，0 可能表示 “协调器”（见 componentTypeStr）
    status integer 当前运行状态，0 通常表示“正常”或“启用”
    deployStatus integer 部署状态，2 可能表示“已部署”或“运行中”（需结合业务定义）
    programPath string 程序安装路径，如二进制或脚本所在目录
    programDataPath string 程序数据存储路径，如日志、持久化数据目录
    packageId string 关联的软件包 ID，用于版本管理或部署来源追踪
    configFileId string 主配置文件的 ID，对应 fileMap 中的 key
    room string 机房/区域标识，如 "openstack3"，用于多可用区部署
    deployAgreementType integer 部署协议类型，0 可能表示默认或标准协议
    componentTypeStr string 组件类型的中文描述，如 "admq协调器"，用于前端展示
    mode integer 运行模式，1 表示是否正常
    ampFacilityId integer AMP（监控/设施平台）设施 ID，0 表示未关联
    ampMonitorId integer AMP 监控项 ID，0 表示未配置监控
    ampKopMonitorId integer KOP监控 ID，0 表示未启用
    ampKopFacilityId integer KOP 设施 ID，0 表示未关联
    ampUrl string AMP 管理平台访问 URL，空字符串表示未配置
    syncNodeConfigStatus integer 节点配置同步状态，0 可能表示“未同步”或“同步成功”
    serverPort integer 服务监听端口，如 ZooKeeper 默认 2181

# 集群服务节点配置文件信息展示

  • 接口描述 每个服务节点的配置文件的基本信息

  • 请求方式 GET

  • 请求url

    /admq-manager/cluster/node/config
    1

  • 请求参数

    参数名 类型 必填 参数描述
    configFileId string 是 配置Id

  • 返回数据 使用curl命令

     curl -X GET 'http://127.0.0.1:12305/admq-manager/cluster/node/config?pageNum=1&pageSize=10&configFileId=1993148229301637121' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0'
    1

    返回信息

    {"code":0,"msg":"成功","data":{"total":95,"pageNum":1,"pageSize":10,"pages":10,"list":[{"id":"1995737921880641537","createTime":"2025-12-02 14:12:54","updateTime":"2025-12-02 14:12:54","configKey":"test","configValue":"test","effective":1,"describes":"111"},{"id":"1994413886932570114","createTime":"2025-11-28 22:31:39","updateTime":"2025-11-28 22:31:39","configKey":"loadBalancerAutoUnloadSplitBundlesEnabled","configValue":"false","effective":1},{"id":"1994413886886432770","createTime":"2025-11-28 22:31:39","updateTime":"2025-11-28 22:31:39","configKey":"loadBalancerAutoBundleSplitEnabled","configValue":"false","effective":1},{"id":"1993148290047741953","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"apusic_acls_ns","configValue":"public","effective":1},{"id":"1993148290026770434","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"apusic_acls_tenant","configValue":"public","effective":1},{"id":"1993148290005798914","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"apusic_acls_authUrls","configValue":"","effective":1},{"id":"1993148289989021697","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"apusic_acls_enable","configValue":"false","effective":1},{"id":"1993148289972244482","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"monitor_password","configValue":"11111111","effective":1},{"id":"1993148289951272961","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"monitor_username","configValue":"__sys__monitor","effective":1},{"id":"1993148289934495746","createTime":"2025-11-25 10:42:37","updateTime":"2025-11-25 10:42:37","configKey":"monitor_servicePort","configValue":"6650","effective":1}]}}
    1
    参数名 类型 描述
    id string 配置项id
    createTime string 创建时间
    updateTime string 更新时间
    configKey string 配置参数
    configValue string 配置项
    effective int 是否启用，1启用，0停用

# 集群服务节点新增配置

  • 接口描述

    对集群中服务节点的配置文件新增一个参数

  • 请求方法 POST

  • 请求url

    /admq-manager/cluster/node/config
    1

  • 请求参数

    参数名 类型 必填 参数描述
    fileMap Map<String, String> 是 配置文件 ID 与文件名的映射关系，key 为配置文件唯一 ID，value 为实际文件名（如 "1906607968111603713": "zookeeper.conf"）
    configFileId string 是 当前使用的主配置文件 ID
    cid string 是 集群 ID（Cluster ID），用于标识所属集群，通常与 clusterId 含义相同
    total int 是 总数，表示该集群下该节点配置项总数
    configKey string 是 配置项的键名
    configValue string 是 配置项的值

  • 返回数据 使用curl命令

     curl -X POST 'http://127.0.0.1:12305/admq-manager/cluster/node/config' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0' -H 'Content-Type: application/json' -d  '{
  "fileMap": {
    "1993148229301637121": "standalone.conf"
  },
  "configFileId": "1993148229301637121",
  "cid": "1993148229251305473",
  "total": 94,
  "configKey": "test",
  "configValue": "test",
  "describes": "111"}'
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群服务节点配置文件参数启停

  • 接口描述

    对服务节点中配置文件的单个参数进行启停操作

  • 请求方式 PUT

  • 请求url

    /admq-manager/cluster/node/status
    1

  • 请求参数

    参数名 类型 必填 参数描述
    id string 是 配置文件的参数id
    effective int 是 启停标识(0:停用，1:启用)

  • 返回数据 使用curl命令

     curl -X PUT 'http://127.0.0.1:12305/admq-manager/cluster/node/config/status' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0' -H 'Content-Type: application/json' -d '{
  "id": "1995737921880641537",
  "effective": 0
}'
    1
    2
    3
    4

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群服务节点配置文件参数一键启停

  • 接口描述

    对服务节点中配置文件的多个参数进行启停操作

  • 请求方式 PUT

  • 请求url

    /admq-manager/cluster/node/config/status/batch
    1

  • 请求参数

    参数名 类型 必填 参数描述
    ids string 是 所有更改的配置文件的参数id
    effective int 是 启停标识(0:停用，1:启用)

  • 返回数据

    curl -X PUT 'http://127.0.0.1:12305/admq-manager/cluster/node/config/status/batch' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0' -H 'Content-Type: application/json' -d '
{
  "ids": [
    "1995737921880641537",
    "1994413886932570114"
  ],
  "effective": 1
}'
    1
    2
    3
    4
    5
    6
    7
    8

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群服务节点更新配置文件

  • 接口描述 在修改对应服务节点下的配置文件参数后，调用接口更新配置文件，然后重启节点，完成新的配置启用

  • 请求方式 POST

  • 请求url

    /admq-manager/cluster/node/config/flush
    1

  • 请求参数

    参数名 类型 必填 参数描述
    configFileId string 是 配置文件id
    clusterId string 是 集群id
    nodeId string 是 服务器节点id

  • 返回数据

    curl -X PUT 'http://127.0.0.1:12305/admq-manager/cluster/node/config/flush' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0' -H 'Content-Type: application/json' -d '
{
  "configFileId": "1993148229301637121",
  "clusterId": "1993148229251305473",
  "nodeId": "1993148229330997250"
}'
    1
    2
    3
    4
    5
    6

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 集群单个节点执行命令

  • 接口描述 启动集群下某个节点

  • 请求方式 POST

  • 请求url

    /admq-manager/admq/cmd
    1

  • 请求参数

    参数名 类型 必填 参数描述
    id string 是 集群服务节点id
    cmd string 是 执行命令（start; stop; restart）

  • 返回数据

    curl -X POST 'http://127.0.0.1:12305/admq-manager/admq/cmd' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0' -H 'Content-Type: application/json' -d '
{
  "id": "1993148229330997250",
  "cmd": "start"
}'
    1
    2
    3
    4
    5

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2

# 删除集群

  • 接口描述 删除集群

  • 请求方式 DELETE

  • 请求url

    /admq-manager/cluster
    1

  • 请求参数

    参数名 类型 必填 参数描述
    id string 是 集群id

  • 返回数据

    curl -X DELETE 'http://127.0.0.1:12305/admq-manager/cluster' -H 'Authorization:Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1xNzYxYmJlNzIwNTcxNjZmNzRhNDExODhhNzdmMDE2NWUyNTYzZjMyYWEzYmE5YjY5ZjlmNWMwNGY0NjQ5NGZiYjE3NjQ2NTQyNTQ2OTQiLCJleHAiOjE3NjQ4MjcwNTR9.0gjqcUV7neHEZsue6DUvVGcms0RmtNbw-EfMvoYnZQ0' -H 'Content-Type: application/json' -d '
{
  "id": "1995680266956271618"
}'
    1
    2
    3
    4

    返回信息如下

    200 成功
{"code":0,"msg":"SUCCESS"}
    1
    2
编辑页面 (opens new window)
#参考API接口说明文档

← 兼容版本说明文档→