管理平台 API

接口调用说明

假设部署在localhost，80端口，接口为tree 访问的url地址为

  1. http://localhost/pages/tree

业务树

tree

取业务树

参数

无

返回值

  1. {
  2.     "id": "",                  // 节点ID
  3.     "name": "",                // 节点名称
  4.     "pid": "",                 // 父节点ID
  5.     "open": true,              // 是否展开
  6.     "is_parent": true,         // 是否父节点
  7.     "children": []             // 子节点
  8. }

服务管理

server/api/deploy_server

部署服务

参数

  1. {                                  
  2.     "application": "",             // 应用
  3.     "server_name": "",             // 服务
  4.     "node_name": "",               // 节点
  5.     "server_type": "",             // 服务类型
  6.     "template_name": "",           // 模板名
  7.     "enable_set": true,            // 是否启用Set
  8.     "set_name": "",                // Set名
  9.     "set_area": "",                // Set区
  10.     "set_group": "",               // Set组
  11.     "adapters": [{ 
  12.         "obj_name": "",            // OJB名称
  13.         "bind_ip": "",             // Obj绑定IP
  14.         "port": "",                // 端口
  15.         "port_type": "tcp",        // 端口类型
  16.         "protocol": "tars",        // 协议
  17.         "thread_num": 0,           // 线程数
  18.         "max_connections": 0,      // 最大连接数
  19.         "queuecap": 0,             // 队列最大长度
  20.         "queuetimeout": 0          // 队列超时时间
  21.     }]                             
  22. }

返回值

  1. {
  2.     "server_conf": {          //新上线服务信息                        
  3.         "id": 0,                   // 服务ID
  4.         "application": "",         // 应用
  5.         "server_name": "",         // 服务
  6.         "node_name": "",           // 节点
  7.         "server_type": "",         // 服务类型
  8.         "enable_set": true,        // 是否启用Set
  9.         "set_name": "",            // Set名
  10.         "set_area": "",            // Set区
  11.         "set_group": "",           // Set组
  12.         "setting_state": "",       // 设置状态
  13.         "present_state": "",       // 当前状态
  14.         "bak_flag": true,          // 是否备机
  15.         "template_name": "",       // 模板名称
  16.         "profile": "",             // 私有模板
  17.         "async_thread_num": 0,     // 异步线程数
  18.         "base_path": "",           // 缺省路径
  19.         "exe_path": "",            // EXE路径
  20.         "start_script_path": "",   // 启动脚本
  21.         "stop_script_path": "",    // 停止脚本
  22.         "monitor_script_path": "", // 监控脚本
  23.         "patch_time": "",          // 发布时间
  24.         "patch_version", "",       // 发布版本
  25.         "process_id": "",          // 进程ID
  26.         "posttime": ""             // 更新时间
  27.     },
  28.     "tars_node_rst":[   //tarsnode安装结果，若不启用资源模块，则此数据为空
  29.         {
  30.             "ip":"1.1.1.3",  //机器IP
  31.             "rst":false,//安装tarsnode结果
  32.             "msg":"未找到机器配置" //安装结果信息
  33.         }
  34.     ]
  35. }

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/update_server

修改服务

参数

  1. {
  2.     "id": 0,                  // 服务ID
  3.     "isBak": true,            // 是否备机
  4.     "template_name": "",      // 模板名称
  5.     "server_type": "",        // 服务类型
  6.     "enable_set": "",         // 是否启用Set
  7.     "set_name": "",           // Set名
  8.     "ser_area": "",           // Set区
  9.     "set_group": "",          // Set组
  10.     "async_thread_num": 0,    // 异步线程数
  11.     "base_path": "",          // 缺省路径
  12.     "exe_path": "",           // EXE路径
  13.     "start_script_path": "",  // 启动脚本
  14.     "stop_script_path": "",   // 停止脚本
  15.     "monitor_script_path": "",// 监控脚本
  16.     "profile": ""             // 私有模板
  17. }

返回值

  1. {
  2.     "id": 0,                   // 服务ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "server_type": "",         // 服务类型
  7.     "enable_set": true,        // 是否启用Set
  8.     "set_name": "",            // Set名
  9.     "set_area": "",            // Set区
  10.     "set_group": "",           // Set组
  11.     "setting_state": "",       // 设置状态
  12.     "present_state": "",       // 当前状态
  13.     "bak_flag": true,          // 是否备机
  14.     "template_name": "",       // 模板名称
  15.     "profile": "",             // 私有模板
  16.     "async_thread_num": 0,     // 异步线程数
  17.     "base_path": "",           // 缺省路径
  18.     "exe_path": "",            // EXE路径
  19.     "start_script_path": "",   // 启动脚本
  20.     "stop_script_path": "",    // 停止脚本
  21.     "monitor_script_path": "", // 监控脚本
  22.     "patch_time": "",          // 发布时间
  23.     "patch_version", "",       // 发布版本
  24.     "process_id": "",          // 进程ID
  25.     "posttime": ""             // 更新时间
  26. }

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/server

取服务

参数

  1. id // 服务ID

返回值

  1. {
  2.     "id": 0,                   // 服务ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "server_type": "",         // 服务类型
  7.     "enable_set": true,        // 是否启用Set
  8.     "set_name": "",            // Set名
  9.     "set_area": "",            // Set区
  10.     "set_group": "",           // Set组
  11.     "setting_state": "",       // 设置状态
  12.     "present_state": "",       // 当前状态
  13.     "bak_flag": true,          // 是否备机
  14.     "template_name": "",       // 模板名称
  15.     "profile": "",             // 私有模板
  16.     "async_thread_num": 0,     // 异步线程数
  17.     "base_path": "",           // 缺省路径
  18.     "exe_path": "",            // EXE路径
  19.     "start_script_path": "",   // 启动脚本
  20.     "stop_script_path": "",    // 停止脚本
  21.     "monitor_script_path": "", // 监控脚本
  22.     "patch_time": "",          // 发布时间
  23.     "patch_version", "",       // 发布版本
  24.     "process_id": "",          // 进程ID
  25.     "posttime": ""             // 更新时间
  26. }

server/api/server_list

取服务列表

参数

  1. tree_node_id // 树节点ID

返回值

  1. [{
  2.     "id": 0,                   // 服务ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "server_type": "",         // 服务类型
  7.     "enable_set": true,        // 是否启用Set
  8.     "set_name": "",            // Set名
  9.     "set_area": "",            // Set区
  10.     "set_group": "",           // Set组
  11.     "setting_state": "",       // 设置状态
  12.     "present_state": "",       // 当前状态
  13.     "bak_flag": true,          // 是否备机
  14.     "template_name": "",       // 模板名称
  15.     "profile": "",             // 私有模板
  16.     "async_thread_num": 0,     // 异步线程数
  17.     "base_path": "",           // 缺省路径
  18.     "exe_path": "",            // EXE路径
  19.     "start_script_path": "",   // 启动脚本
  20.     "stop_script_path": "",    // 停止脚本
  21.     "monitor_script_path": "", // 监控脚本
  22.     "patch_time": "",          // 发布时间
  23.     "patch_version": "",       // 发布版本
  24.     "process_id": "",          // 进程ID
  25.     "posttime": ""             // 更新时间
  26. }]

server/api/inactive_server_list

取设置状态为inactive的服务列表

参数

  1. application // 应用
  2. server_name // 服务
  3. node_name   // 节点

返回值

  1. [{
  2.     "id": 0,                   // 服务ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "server_type": "",         // 服务类型
  7.     "enable_set": true,        // 是否启用Set
  8.     "set_name": "",            // Set名
  9.     "set_area": "",            // Set区
  10.     "set_group": "",           // Set组
  11.     "setting_state": "",       // 设置状态
  12.     "present_state": "",       // 当前状态
  13.     "bak_flag": true,          // 是否备机
  14.     "template_name": "",       // 模板名称
  15.     "profile": "",             // 私有模板
  16.     "async_thread_num": 0,     // 异步线程数
  17.     "base_path": "",           // 缺省路径
  18.     "exe_path": "",            // EXE路径
  19.     "start_script_path": "",   // 启动脚本
  20.     "stop_script_path": "",    // 停止脚本
  21.     "monitor_script_path": "", // 监控脚本
  22.     "patch_time": "",          // 发布时间
  23.     "patch_version": "",       // 发布版本
  24.     "process_id": "",          // 进程ID
  25.     "posttime": ""             // 更新时间
  26. }]

server/api/server_notify_list

取服务notify日志列表

参数

  1. tree_node_id // 树节点ID

返回值

  1. {
  2.     "count": 0,
  3.     "rows":[{
  4.         "notifytime": "",          // 时间
  5.         "server_id": "",           // 服务ID
  6.         "thread_id": "",           // 线程ID
  7.         "command": "",             // 命令
  8.         "result": ""               // 结果
  9.     }]
  10. }

是否支持分页

是

server/api/get_realtime_state

取服务实时状态

参数

  1. id // 服务ID

返回值

  1. {
  2.     "realtime_state": ""       // 实时状态
  3. }

server/api/load_server

加载服务

参数

  1. application  // 应用
  2. server_name  // 服务
  3. node_name    // 节点

返回值

  1. "" // 执行结果

server/api/expand_server_preview

预扩容

参数

  1. {
  2.     "application": "",        // 应用
  3.     "server_name": "",        // 服务
  4.     "set": "",                // Set
  5.     "node_name": "",          // 节点
  6.     "expand_nodes": [""],     // 扩容节点
  7.     "enable_set": true,       // 是否启用Set
  8.     "set_name": "",           // Set名
  9.     "set_area": "",           // Set区    
  10.     "set_group": "",          // Set组
  11.     "copy_node_config": true  // node_name非空时是否复制节点配置
  12. }

返回值

  1. [{
  2.     "application": "",        // 应用
  3.     "server_name": "",        // 服务
  4.     "set": "",                // Set
  5.     "obj_name": "",           // OBJ名称
  6.     "node_name": "",          // 节点
  7.     "bind_ip": "",            // Obj绑定IP
  8.     "port": 0,                // 端口
  9.     "template_name": "",      // 模板名
  10.     "status": "",             // 状态
  11. }]

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/expand_server

扩容

参数

  1. {
  2.     "application": "",            // 应用
  3.     "server_name": "",            // 服务
  4.     "set": "",                    // Set
  5.     "node_name": "",              // 节点
  6.     "copy_node_config": true，    // node_name非空时是否复制节点配置
  7.     "expand_preview_servers": [{
  8.         "node_name": "",          // 节点
  9.         "set": "",                // Set
  10.         "obj_name": "",           // OBJ名称
  11.         "bind_ip": "",            // Obj绑定IP
  12.         "port": 0                 // 端口
  13.     }]
  14. }

返回值

  1. {
  2.         "server_conf": {          //新上线服务信息  
  3.             [{                                  
  4.                 "id": 0,                   // 服务ID
  5.                 "application": "",         // 应用
  6.                 "server_name": "",         // 服务
  7.                 "node_name": "",           // 节点
  8.                 "server_type": "",         // 服务类型
  9.                 "enable_set": true,        // 是否启用Set
  10.                 "set_name": "",            // Set名
  11.                 "set_area": "",            // Set区
  12.                 "set_group": "",           // Set组
  13.                 "setting_state": "",       // 设置状态
  14.                 "present_state": "",       // 当前状态
  15.                 "bak_flag": true,          // 是否备机
  16.                 "template_name": "",       // 模板名称
  17.                 "profile": "",             // 私有模板
  18.                 "async_thread_num": 0,     // 异步线程数
  19.                 "base_path": "",           // 缺省路径
  20.                 "exe_path": "",            // EXE路径
  21.                 "start_script_path": "",   // 启动脚本
  22.                 "stop_script_path": "",    // 停止脚本
  23.                 "monitor_script_path": "", // 监控脚本
  24.                 "patch_time": "",          // 发布时间
  25.                 "patch_version", "",       // 发布版本
  26.                 "process_id": "",          // 进程ID
  27.                 "posttime": ""             // 更新时间
  28.             }]
  29.         },
  30.         "tars_node_rst":[   //tarsnode安装结果，若不启用资源模块，则此数据为空
  31.             {
  32.                 "ip":"1.1.1.3",  //机器IP
  33.                 "rst":false,//安装tarsnode结果
  34.                 "msg":"未找到机器配置" //安装结果信息
  35.             }
  36.         ]
  37. }

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/add_adapter_conf

新增Adapter

参数

  1. {
  2.     "application": "",         // 应用
  3.     "server_name": "",         // 服务
  4.     "node_name": "",           // 节点
  5.     "thread_num": 1,           // 线程数
  6.     "endpoint": "",            // EndPoint
  7.     "max_connections": 0,      // 最大连接数
  8.     "allow_ip": "",            // 允许IP
  9.     "servant": "",             // Servant
  10.     "queuecap": 0,             // 队列长度
  11.     "queuetimeout": 0,         // 队列超时时间
  12.     "protocol": "",            // 协议
  13.     "handlegroup": ""          // 处理组
  14. }

返回值

  1. {
  2.     "id": 0,                   // Adapter ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "adapter_name": "",        // Adapter名
  7.     "thread_num": 1,           // 线程数
  8.     "endpoint": "",            // EndPoint
  9.     "max_connections": 0,      // 最大连接数
  10.     "allow_ip": "",            // 允许IP
  11.     "servant": "",             // Servant
  12.     "queuecap": 0,             // 队列长度
  13.     "queuetimeout": 0,         // 队列超时时间
  14.     "posttime": "",            // 更新时间
  15.     "protocol": "",            // 协议
  16.     "handlegroup": ""          // 处理组
  17. }

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/delete_adapter_conf

删除Adapter

参数

  1. id // Adapter ID

返回值

  1. [0] // 删除的Adapter ID

server/api/update_adapter_conf

修改Adapter

参数

  1. {
  2.     "id": 0,                   // Adapter ID
  3.     "thread_num": 1,           // 线程数
  4.     "endpoint": "",            // EndPoint
  5.     "max_connections": 0,      // 最大连接数
  6.     "allow_ip": "",            // 允许IP
  7.     "servant": "",             // Servant
  8.     "queuecap": 0,             // 队列长度
  9.     "queuetimeout": 0,         // 队列超时时间
  10.     "protocol": "",            // 协议
  11.     "handlegroup": ""          // 处理组
  12. }

返回值

  1. {
  2.     "id": 0,                   // Adapter ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "adapter_name": "",        // Adapter名
  7.     "thread_num": 1,           // 线程数
  8.     "endpoint": "",            // EndPoint
  9.     "max_connections": 0,      // 最大连接数
  10.     "allow_ip": "",            // 允许IP
  11.     "servant": "",             // Servant
  12.     "queuecap": 0,             // 队列长度
  13.     "queuetimeout": 0,         // 队列超时时间
  14.     "posttime": "",            // 更新时间
  15.     "protocol": "",            // 协议
  16.     "handlegroup": ""          // 处理组
  17. }

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/adapter_conf

取Adapter

参数

  1. id // Adapter ID

返回值

  1. {
  2.     "id": 0,                   // Adapter ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "adapter_name": "",        // Adapter名
  7.     "thread_num": 1,           // 线程数
  8.     "endpoint": "",            // EndPoint
  9.     "max_connections": 0,      // 最大连接数
  10.     "allow_ip": "",            // 允许IP
  11.     "servant": "",             // Servant
  12.     "queuecap": 0,             // 队列长度
  13.     "queuetimeout": 0,         // 队列超时时间
  14.     "posttime": "",            // 更新时间
  15.     "protocol": "",            // 协议
  16.     "handlegroup": ""          // 处理组
  17. }

server/api/adapter_conf_list

取Adapter列表

参数

  1. id // 服务ID

返回值

  1. [{
  2.     "id": 0,                   // Adapter ID
  3.     "application": "",         // 应用
  4.     "server_name": "",         // 服务
  5.     "node_name": "",           // 节点
  6.     "adapter_name": "",        // Adapter名
  7.     "thread_num": 1,           // 线程数
  8.     "endpoint": "",            // EndPoint
  9.     "max_connections": 0,      // 最大连接数
  10.     "allow_ip": "",            // 允许IP
  11.     "servant": "",             // Servant
  12.     "queuecap": 0,             // 队列长度
  13.     "queuetimeout": 0,         // 队列超时时间
  14.     "posttime": "",            // 更新时间
  15.     "protocol": "",            // 协议
  16.     "handlegroup": ""          // 处理组
  17. }]

服务配置

server/api/add_config_file

新增配置文件

参数

  1. {
  2.     "level": 1,         // 层级
  3.     "application": "",  // 应用
  4.     "server_name": "",  // 服务
  5.     "node_name": "",    // 节点
  6.     "set_name": "",     // Set名
  7.     "set_area": "",     // Set取
  8.     "set_group": "",    // Set组
  9.     "filename": "",     // 文件名
  10.     "config": ""        // 文件内容
  11. }

返回值

  1. {
  2.     "id": 0,            // 配置文件ID
  3.     "server_name": "",  // 服务
  4.     "node_name": "",    // 节点
  5.     "set_name": "",     // Set名
  6.     "set_area": "",     // Set取
  7.     "set_group": "",    // Set组
  8.     "filename": "",     // 文件名
  9.     "config": "",       // 文件内容
  10.     "level": 1,         // 层级，1：应用或Set，2：服务，3：节点
  11.     "posttime": "",     // 更新时间
  12. }

server/api/delete_config_file

删除配置文件

参数

  1. id // 配置文件ID

返回值

  1. [0] // 删除的配置文件ID

server/api/update_config_file

修改配置文件

参数

  1. {
  2.     "id": 0,            // 配置文件ID
  3.     "config": "",       // 文件内容
  4.     "reason": ""        // 备注
  5. }

返回值

  1. {
  2.     "id": 0,            // 配置文件ID
  3.     "server_name": "",  // 服务
  4.     "node_name": "",    // 节点
  5.     "set_name": "",     // Set名
  6.     "set_area": "",     // Set取
  7.     "set_group": "",    // Set组
  8.     "filename": "",     // 文件名
  9.     "config": "",       // 文件内容
  10.     "level": 1,         // 层级，1：应用或Set，2：服务，3：节点
  11.     "posttime": "",     // 更新时间
  12. }

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/config_file

取配置文件

参数

  1. id // 配置文件ID

返回值

  1. {
  2.     "id": 0,            // 配置文件ID
  3.     "server_name": "",  // 服务
  4.     "node_name": "",    // 节点
  5.     "set_name": "",     // Set名
  6.     "set_area": "",     // Set取
  7.     "set_group": "",    // Set组
  8.     "filename": "",     // 文件名
  9.     "config": "",       // 文件内容
  10.     "level": 1,         // 层级，1：应用或Set，2：服务，3：节点
  11.     "posttime": "",     // 更新时间
  12. }

server/api/config_file_list

取配置文件列表

参数

  1. level       // 层级,1:应用，2：Set名，3：Set区，4：Set组，5：服务
  2. application // 应用
  3. server_name // 服务
  4. set_name    // Set名
  5. set_area    // Set区
  6. set_group   // Set组

返回值

  1. [{
  2.     "id": 0,            // 配置文件ID
  3.     "server_name": "",  // 服务
  4.     "node_name": "",    // 节点
  5.     "set_name": "",     // Set名
  6.     "set_area": "",     // Set取
  7.     "set_group": "",    // Set组
  8.     "filename": "",     // 文件名
  9.     "config": "",       // 文件内容
  10.     "level": 1,         // 层级，1：应用或Set，2：服务，3：节点
  11.     "posttime": "",     // 更新时间
  12. }]

server/api/node_config_file_list

取节点配置文件列表

参数

  1. application // 应用
  2. server_name // 服务
  3. set_name    // Set名
  4. set_area    // Set区
  5. set_group   // Set组
  6. config_id   // 配置文件ID

返回值

  1. [{
  2.     "id": 0,            // 配置文件ID
  3.     "server_name": "",  // 服务
  4.     "node_name": "",    // 节点
  5.     "set_name": "",     // Set名
  6.     "set_area": "",     // Set取
  7.     "set_group": "",    // Set组
  8.     "filename": "",     // 文件名
  9.     "config": "",       // 文件内容
  10.     "level": 1,         // 层级，1：应用或Set，2：服务，3：节点
  11.     "posttime": "",     // 更新时间
  12. }]

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/config_file_history

取配置文件修改记录

参数

  1. id  // 变更记录ID

返回值

  1. {
  2.     "id": "",        // 变更记录ID
  3.     "config_id": "", // 配置文件ID
  4.     "reason": "",    // 备注
  5.     "content": "",   // 变更内容
  6.     "posttime": "",  // 更新时间
  7. }

server/api/config_file_history_list

取配置文件修改记录

参数

  1. config_id // 配置文件ID

返回值

  1. {
  2.     "count":0,
  3.     "rows":[{
  4.         "id": "",        // 变更记录ID
  5.         "config_id": "", // 配置文件ID
  6.         "reason": "",    // 备注
  7.         "content": "",   // 变更内容
  8.         "posttime": "",  // 更新时间
  9.     }]
  10. }

是否支持分页

是

server/api/add_config_ref

新增引用

参数

  1. config_id    // 配置文件ID
  2. reference_id // 引用配置文件ID

返回值

  1. {
  2.     "id": "",           // 引用ID
  3.     "config_id": "",    // 配置文件ID
  4.     "reference_id": ""  // 引用配置文件ID
  5. }

server/api/delete_config_ref

删除引用

参数

  1. id // 引用ID

返回值

  1. [0] // 删除的引用ID

server/api/config_ref_list

引用列表

参数

  1. config_id // 配置文件ID

返回值

  1. [{
  2.     "id": 0,                // 引用ID
  3.     "config_id": 0,         // 配置文件ID
  4.     "reference": {
  5.         "id": 0,            // 配置文件ID
  6.         "server_name": "",  // 服务
  7.         "node_name": "",    // 节点
  8.         "set_name": "",     // Set名
  9.         "set_area": "",     // Set取
  10.         "set_group": "",    // Set组
  11.         "filename": "",     // 文件名
  12.         "config": "",       // 文件内容
  13.         "level": 1,         // 层级，1：应用或Set，2：服务，3：节点
  14.         "posttime": "",     // 更新时间
  15.     }
  16. }]

server/api/merged_node_config

合并后节点配置

参数

  1. id // 配置文件ID

返回值

  1. "" // 配置文件内容

server/api/push_config_file

下发节点配置

参数

  1. ids // 配置文件ID，用;分隔

返回值

  1. [{
  2.     "application": "",    // 应用
  3.     "server_name": "",    // 服务
  4.     "node_name": "",      // 节点
  5.     "ret_code": 0,        // 执行结果，0成功
  6.     "err_msg": ""         // 错误信息
  7. }]

任务管理

涵盖启动、停止、发布、下线

server/api/add_task

新增任务

参数

  1. {
  2.     "serial": true, // 是否串行
  3.     "items": [{
  4.         "server_id": "",    // 服务
  5.         "command": "",     // 命令字
  6.         "parameters": {     // 参数
  7.         }
  8.     }]
  9. }
  11. 命令字包括restart，stop，undeploy_tars，patch_tars
  12. 当command!=patch_tars时，parameter为空
  13. 当command=patch_tars时，parameter格式为
  14. {
  15.     patch_id: "0",    // 版本号
  16.     update_text: "",  // 备注
  17.     bak_flag: true    // 备机标识，true：备机，false：主机
  18. }

返回值

  1. ""  // 任务ID

备注

只支持POST方式，Header中指定Content-Type:application/json

server/api/task

取任务及子任务详细信息

参数

  1. task_no // 任务ID

返回值

  1. {
  2.     "task_no": "",               // 任务ID
  3.     "serial": true,              // 是否串行
  4.     "status": 0,                 // 任务状态
  5.     "items":[{
  6.         "task_no": "",
  7.         "item_no": "",           // 子任务ID
  8.         "application": "",       // 应用
  9.         "server_name": "",       // 服务
  10.         "node_name": "",         // 节点
  11.         "command": "",           // 命令
  12.         "parameters": {},        // 参数
  13.         "start_time": "",        // 开始时间
  14.         "end_time": "",          // 结束时间
  15.         "status": "",            // 子任务状态
  16.         "status_info": "",       // 状态信息
  17.         "execute_info": ""       // 执行信息
  18.     }]
  19. }
  20. // 如果用了kafka，当任务还在排队时只会返回{status:0}

server/api/task_list

取任务列表

参数

  1. application // 应用
  2. server_name // 服务
  3. command     // 命令
  4. from        // 开始日期
  5. to          // 结束日期

返回值

  1. [{
  2.     "task_no": "",               // 任务ID
  3.     "serial": true,              // 是否串行
  4.     "status": 0,                 // 任务状态
  5.     "items":[{
  6.         "task_no": "",
  7.         "item_no": "",           // 子任务ID
  8.         "application": "",       // 应用
  9.         "server_name": "",       // 服务
  10.         "node_name": "",         // 节点
  11.         "command": "",           // 命令
  12.         "parameters": {},        // 参数
  13.         "start_time": "",        // 开始时间
  14.         "end_time": "",          // 结束时间
  15.         "status": "",            // 子任务状态
  16.         "status_info": "",       // 状态信息
  17.         "execute_info": ""       // 执行信息
  18.     }]
  19. }]

发布包

server/api/upload_patch_package

上传发布包

参数

  1. application // 应用
  2. module_name // 模块名
  3. comment     // 备注
  4. suse        // 发布包上传组件名称
  5. task_id     // 任务ID（可用时间戳）
  6. md5         // 发布包的md5值（不填则不校验）

返回值

  1. {
  2.     "id": 0,        // 发布包ID
  3.     "server": "",   // 服务，应用+模块名
  4.     "tgz": "",      // 发布包名称
  5.     "comment": "",  // 备注
  6.     "posttime": ""  // 更新时间
  7. }

server/api/server_patch_list

取发布版本列表

参数

  1. application // 应用
  2. module_name // 模块名

返回值

  1. {
  2.     "count":0,
  3.     "rows":[{
  4.         "id": 0,        // 发布包ID
  5.         "server": "",   // 服务，应用+模块名
  6.         "tgz": "",      // 发布包名称
  7.         "comment": "",  // 备注
  8.         "posttime": ""  // 更新时间
  9.     }]
  10. }

是否支持分页

是

模板

server/api/add_profile_template

新增模板

参数

  1. {
  2.     "template_name": "",      // 必填，模板名称
  3.     "parents_name": "",       // 必填，父模板
  4.     "profile": ""             // 必填，模板内容
  5. }

返回值

  1. {
  2.     "id": 0,                  // 模板ID
  3.     "template_name": "",      // 模板名称
  4.     "parents_name": "",       // 父模板
  5.     "profile": "",            // 模板内容
  6.     "posttime": ""            // 更新时间
  7. }

server/api/delete_profile_template

修改模板

参数

  1. id  // 模板ID

返回值

  1. [0] // 删除的模板ID

server/api/update_profile_template

修改模板

参数

  1. {
  2.     "id": "",                 // 必填，模板ID
  3.     "template_name": "",      // 必填，模板名称
  4.     "parents_name": "",       // 必填，父模板
  5.     "profile": ""             // 必填，模板内容
  6. }

返回值

  1. {
  2.     "id": 0,                  // 模板ID
  3.     "template_name": "",      // 模板名称
  4.     "parents_name": "",       // 父模板
  5.     "profile": "",            // 模板内容
  6.     "posttime": ""            // 更新时间
  7. }

server/api/profile_template

取模板

参数

  1. template_name // 模板名称

返回值

  1. {
  2.     "id": 0,                  // 模板ID
  3.     "template_name": "",      // 模板名称
  4.     "parents_name": "",       // 父模板
  5.     "profile": "",            // 模板内容
  6.     "posttime": ""            // 更新时间
  7. }

server/api/query_profile_template

查询模板

参数

  1. template_name  // 模板名称
  2. parents_name   // 父模板名称

返回值

  1. [{
  2.     "id": 0,                  // 模板ID
  3.     "template_name": "",      // 模板名称
  4.     "parents_name": "",       // 父模板
  5.     "profile": "",            // 模板内容
  6.     "posttime": ""            // 更新时间
  7. }]

监控

server/api/tarsstat_monitor_data

取tarsstat监控数据

参数

  1. thedate         // 显示日期
  2. predate         // 对比日期
  3. startshowtime   // 开始时间
  4. endshowtime     // 结束时间
  5. master_name     // 主调
  6. slave_name      // 被调
  7. interface_name  // 接口名
  8. master_ip       // 主调IP
  9. slave_ip        // 被调IP
  10. group_by        // 分组

返回值

  1. [{
  2.     "show_date": "",          // 日期
  3.     "show_time": "",          // 时间点
  4.     "master_name": "",        // 主调
  5.     "slave_name": "",         // 被调
  6.     "interface_name": "",     // 接口名
  7.     "master_ip": "",          // 主调IP
  8.     "slave_ip": "",           // 被调IP
  9.     "the_total_count": "",    // 当日总流量
  10.     "pre_total_count": "",    // 对比日总流量
  11.     "total_count_wave": "",   // 流量同比波动
  12.     "the_avg_time": "",       // 当日平均耗时
  13.     "pre_avg_time": "",       // 对比日平均耗时
  14.     "the_fail_rate": "",      // 当日失败率
  15.     "pre_fail_rate": "",      // 对比日失败率
  16.     "the_timeout_rate": "",   // 当日失败率
  17.     "pre_timeout_rate": ""    // 对比日失败率
  18. }]

server/api/tarsproperty_monitor_data

取tarsproperty监控数据

参数

  1. thedate         // 显示日期
  2. predate         // 对比日期
  3. startshowtime   // 开始时间
  4. endshowtime     // 结束时间
  5. master_name     // 服务名
  6. master_ip       // IP
  7. property_name   // 特性
  8. policy          // 策略

返回值

  1. [{
  2.     "show_date": "",          // 日期
  3.     "show_time": "",          // 时间点
  4.     "master_name": "",        // 服务名
  5.     "master_ip": "",          // IP
  6.     "property_name": "",      // 特性
  7.     "policy": "",             // 策略
  8.     "the_value": "",          // 当日特征值
  9.     "pre_value": ""           // 对比日特征值
  10. }]

鉴权

server/api/get_tokens

获取鉴权列表

参数

  1. application // 应用
  2. server_name // 模块名

返回值

  1. [
  2. {
  3. "s_obj_name": "Robin.TestServer2.TestObj",
  4. "m_tokens": {
  5.         "application.server_name": "68765dd7b5fe92b3"
  6.             }
  7. }
  8. ]

server/api/add_token

新增鉴权信息

参数

  1. obj_name    //需要鉴权的OBJ
  2. application // 授权的主调应用名
  3. server_name // 授权的主调服务名

返回值

  1. {
  2.         "s_key": {
  3.             "s_application": "application",
  4.             "s_server": "server_name",
  5.             "s_obj_name": "Robin.TestServer2.TestObj",
  6.         },
  7.         "s_token": "4969ebf04a7f82c0",
  8.     }

server/api/delete_token

删除鉴权信息

参数

  1. obj_name    //需要鉴权的OBJ
  2. application // 授权的主调应用名
  3. server_name // 授权的主调服务名

返回值

  1. "data":0

字典

server/api/server_type_list

取服务类型列表

参数

无

返回值

  1. ["tars_cpp"]

server/api/template_name_list

取模板列表

参数

无

返回值

  1. ["tars.default"]

server/api/cascade_select_server

级联选择服务

参数

  1. level        // 层级，1：应用，2：服务，3：Set，4：节点
  2. application  // 应用，level>1时必填
  3. server_name  // 服务，level>2时必填
  4. set          // Set，level>3时必填，格式：Set名.Set区.Set组

返回值

  1. [""] 对应层级数据

资源

/server/api/install_tars_node

安装Tars Node

参数

  1. ips    //需要安装tarsnode的机器IP

返回值

  1. [
  2.     {
  3.         "ip": "",  //机器IP
  4.         "rst": true, //安装结果
  5.         "msg":"" //安装结果信息
  6.     }
  7. ]

/server/api/uninstall_tars_node

卸载Tars Node

参数

  1. ips    //需要卸载tarsnode的机器IP

返回值

  1. [
  2.     {
  3.         "ip": "",  //机器IP
  4.         "rst": true, //卸载结果
  5.         "msg":"" //卸载结果信息
  6.     }
  7. ]

其他

server/api/send_command

发送自定义命令

参数

  1. server_ids // 服务ID
  2. command    // 命令

返回值

  1. [{
  2.     "application": "", // 应用
  3.     "server_name": "", // 服务
  4.     "node_name": "",   // 节点
  5.     "ret_code": "",    // 返回值
  6.     "err_msg": ""      // 错误消息
  7. }]

server/api/auto_port

自动获取未被占用的端口

参数

  1. node_name // 机器IP，用；隔开

返回值

  1. [{
  2.     "node_name": "", //机器IP
  3.     "port": "", // 端口
  4. }]