ops-server/app/server/api

接口通用调用介绍

  • xxx的api接口调用创建xxxService 对象
  • 通过xxxService 封装对xxx的不同功能,再调用xxxRepo对象的对应方法
  • xxxRepo对象2个功能
    • 1.分页查询
    • 2.简单的增删改查

登录页

login.py

接口

  • /register 用户注册
  • /login 登陆 : 登录成功获取: 登录token,刷新token
    • 接口返回的accesstoken: 2 天过期 refreshtoken: 过期时间30天
  • /testGetData 测试登录保护
  • /refresh_token 只获取刷新token

装饰器

  • @dingtalk_required #判断是否钉钉登录成功(前端会要求钉钉登录,登录成功后将token返回),校验钉钉返回的登录签名是否正确
  • @ops_log.operation_log(verification=False) 如果接口被访问则记录日志到数据库

工具

  • jwt生成token,校验token

页面布局

页面

  • src/layouts/index.js

菜单页

menu.py

页面

  • src/components/asideMenu/Index.js

接口

  • /menu/list # 前端页面的menu数据
    • 获取用户名
    • 根据用户名找到用户分组,根据用户组找到关联的菜单id
    • 根据菜单id找具体菜单信息列,菜单列表分子菜单,和父菜单
    • 根据菜单id排序菜单
    • 循环父菜单列表及子菜单列表,构建前端需要的菜单数据

  • /menu

    • menu_get_parser.parse_args() #get请求参数解析

      1. _args = menu_get_parser.parse_args()  #请求参数解析校验,添加默认值
      2. args = {attr: value if value is not None else '' for attr, value in _args.items()}
      3. if args['limit'] == -1:
      4. args['limit'] = 10000
      5. params = request.args.to_dict()  获取args转字典

    • MenuService 菜单分页服务 ```python

      params : order_by=None, page=None, limit=None, sort=None

      接口参数配置: ops-server/app/server/utils/args_parser.py

      1.class MenuService() self.menurepo=MenuRepo(OrderedQueryBase(QueryHelper)._init(self, Menu, page, per_page, Menu.id)) #以menu.id作为order的key 2.MenuService().get_menus_page(params) === self.menu_repo.find_page(**params) === OrderedQueryBase(QueryHelper).find_page()
      menu_repo() : 1.封装菜单的分页查询 2.封装菜单的增删改普通查询 find_page() : 1.排序 2.其他参数当做条件查询=complex_query 3.返回分页信息 —> QueryHelper(object).paginate_by_query(cls, query, page, per_page): —> query.paginate(page=page, per_page=per_page) #返回分页信息

3.pagination.items 分页后的页面数据

  2.    - get        
  3.       - 查询菜单分页数据
  4.    - post    
  5.       - 菜单对象增删改查
  7. - /menu/<menu_id>
  8.    - get        #查询指定menuid信息,及所有父亲menu_id信息
  9.    - put        #修改menu菜单信息
  10.    - post       删除menu关联信息
  11.       - UserGroupMenuRelationships  分组菜单关联表     表名:group_menu_relationships
  12.       - 删除menu_id对应的用户组关系
  14. ```python
  15. {
  16.   "data": [
  17.     {
  18.       "child": [], 
  19.       "icon": "parent_obj.icon", 
  20.       "id": 1, 
  21.       "key": "/index/home/dashboard", 
  22.       "title": "Dashboard"
  23.     }, 
  24.     {
  25.       "child": [
  26.         {
  27.           "icon": "child_obj.icon", 
  28.           "key": "/index/galaxy/machine", 
  29.           "title": "机器管理"
  30.         }, 
  31.         {
  32.           "icon": "child_obj.icon", 
  33.           "key": "/index/galaxy/service", 
  34.           "title": "服务管理"
  35.         }, 
  36.         {
  37.           "icon": "child_obj.icon", 
  38.           "key": "/index/galaxy/group", 
  39.           "title": "群组信息"
  40.         }
  41.       ], 
  42.       "icon": "parent_obj.icon", 
  43.       "id": 2, 
  44.       "key": "/index/galaxy", 
  45.       "title": "CMDB PRO"
  46.     }, 
  47.     {
  48.       "child": [
  49.         {
  50.           "icon": "child_obj.icon", 
  51.           "key": "/index/resource/ecs", 
  52.           "title": "云服务器"
  53.         }, 
  54.         {
  55.           "icon": "child_obj.icon", 
  56.           "key": "/index/resource/slb", 
  57.           "title": "负载均衡"
  58.         }, 
  59.         {
  60.           "icon": "child_obj.icon", 
  61.           "key": "/index/resource/billing", 
  62.           "title": "Billing"
  63.         }, 
  64.         {
  65.           "icon": "child_obj.icon", 
  66.           "key": "/index/resource/add", 
  67.           "title": "购买机器"
  68.         }
  69.       ], 
  70.       "icon": "parent_obj.icon", 
  71.       "id": 7, 
  72.       "key": "/index/resource", 
  73.       "title": "云平台中心"
  74.     }, 
  75.     {
  76.       "child": [
  77.         {
  78.           "icon": "child_obj.icon", 
  79.           "key": "/index/domain/inner", 
  80.           "title": "内网域名"
  81.         }, 
  82.         {
  83.           "icon": "child_obj.icon", 
  84.           "key": "/index/domain/public", 
  85.           "title": "外网域名"
  86.         }
  87.       ], 
  88.       "icon": "parent_obj.icon", 
  89.       "id": 12, 
  90.       "key": "/index/domain", 
  91.       "title": "域名管理"
  92.     }, 
  93.     {
  94.       "child": [
  95.         {
  96.           "icon": "child_obj.icon", 
  97.           "key": "/index/dingtalk/rebot", 
  98.           "title": "FAQ管理"
  99.         }, 
  100.         {
  101.           "icon": "child_obj.icon", 
  102.           "key": "/index/dingtalk/command", 
  103.           "title": "自定义指令"
  104.         }, 
  105.         {
  106.           "icon": "child_obj.icon", 
  107.           "key": "/index/dingtalk/duty", 
  108.           "title": "Duty管理"
  109.         }, 
  110.         {
  111.           "icon": "child_obj.icon", 
  112.           "key": "/index/dingtalk/history", 
  113.           "title": "记录统计"
  114.         }
  115.       ], 
  116.       "icon": "parent_obj.icon", 
  117.       "id": 15, 
  118.       "key": "/index/dingtalk", 
  119.       "title": "Workflow"
  120.     }, 
  121.     {
  122.       "child": [
  123.         {
  124.           "icon": "child_obj.icon", 
  125.           "key": "/index/alarm/dashboard", 
  126.           "title": "Dashboard"
  127.         }, 
  128.         {
  129.           "icon": "child_obj.icon", 
  130.           "key": "/index/alarm/list", 
  131.           "title": "告警中心"
  132.         }, 
  133.         {
  134.           "icon": "child_obj.icon", 
  135.           "key": "/index/alarm/topology", 
  136.           "title": "网络拓扑"
  137.         }
  138.       ], 
  139.       "icon": "parent_obj.icon", 
  140.       "id": 20, 
  141.       "key": "/index/alarm", 
  142.       "title": "监控告警"
  143.     }, 
  144.     {
  145.       "child": [
  146.         {
  147.           "icon": "child_obj.icon", 
  148.           "key": "/index/task/list", 
  149.           "title": "流程列表"
  150.         }, 
  151.         {
  152.           "icon": "child_obj.icon", 
  153.           "key": "/index/task/record", 
  154.           "title": "流程记录"
  155.         }
  156.       ], 
  157.       "icon": "parent_obj.icon", 
  158.       "id": 24, 
  159.       "key": "/index/task", 
  160.       "title": "流程管理"
  161.     }, 
  162.     {
  163.       "child": [
  164.         {
  165.           "icon": "child_obj.icon", 
  166.           "key": "/index/notify/list", 
  167.           "title": "钉钉群管理"
  168.         }, 
  169.         {
  170.           "icon": "child_obj.icon", 
  171.           "key": "/index/notify/record", 
  172.           "title": "发送记录"
  173.         }
  174.       ], 
  175.       "icon": "parent_obj.icon", 
  176.       "id": 27, 
  177.       "key": "/index/notify", 
  178.       "title": "Notify"
  179.     }, 
  180.     {
  181.       "child": [
  182.         {
  183.           "icon": "child_obj.icon", 
  184.           "key": "/index/infomation/postcode", 
  185.           "title": "发布码管控"
  186.         }, 
  187.         {
  188.           "icon": "child_obj.icon", 
  189.           "key": "/index/infomation/slb", 
  190.           "title": "SLB信息"
  191.         }, 
  192.         {
  193.           "icon": "child_obj.icon", 
  194.           "key": "/index/infomation/proxy", 
  195.           "title": "中间件信息"
  196.         }, 
  197.         {
  198.           "icon": "child_obj.icon", 
  199.           "key": "/index/infomation/appkey", 
  200.           "title": "AppKey查询"
  201.         }, 
  202.         {
  203.           "icon": "child_obj.icon", 
  204.           "key": "/index/infomation/oss", 
  205.           "title": "OSS信息查询"
  206.         }
  207.       ], 
  208.       "icon": "parent_obj.icon", 
  209.       "id": 31, 
  210.       "key": "/index/infomation", 
  211.       "title": "信息汇总"
  212.     }, 
  213.     {
  214.       "child": [
  215.         {
  216.           "icon": "child_obj.icon", 
  217.           "key": "/index/manage/account", 
  218.           "title": "云账号管理"
  219.         }, 
  220.         {
  221.           "icon": "child_obj.icon", 
  222.           "key": "/index/manage/department", 
  223.           "title": "部门管理"
  224.         }, 
  225.         {
  226.           "icon": "child_obj.icon", 
  227.           "key": "/index/manage/user", 
  228.           "title": "用户管理"
  229.         }, 
  230.         {
  231.           "icon": "child_obj.icon", 
  232.           "key": "/index/manage/operation", 
  233.           "title": "操作记录"
  234.         }, 
  235.         {
  236.           "icon": "child_obj.icon", 
  237.           "key": "/index/manage/business", 
  238.           "title": "业务管理"
  239.         }, 
  240.         {
  241.           "icon": "child_obj.icon", 
  242.           "key": "/index/manage/cloud/index", 
  243.           "title": "云平台管理"
  244.         }, 
  245.         {
  246.           "icon": "child_obj.icon", 
  247.           "key": "/index/manage/ansible/log", 
  248.           "title": "Ansible任务系统"
  249.         }
  250.       ], 
  251.       "icon": "parent_obj.icon", 
  252.       "id": 38, 
  253.       "key": "/index/manage", 
  254.       "title": "后台管理"
  255.     }, 
  256.     {
  257.       "child": [], 
  258.       "icon": "parent_obj.icon", 
  259.       "id": 44, 
  260.       "key": "/index/user/info", 
  261.       "title": "个人信息"
  262.     }, 
  263.     {
  264.       "child": [], 
  265.       "icon": "parent_obj.icon", 
  266.       "id": 100, 
  267.       "key": "/index/home/document", 
  268.       "title": "Document"
  269.     }, 
  270.     {
  271.       "child": [
  272.         {
  273.           "icon": "child_obj.icon", 
  274.           "key": "/index/cmdb/host", 
  275.           "title": "云-服务器"
  276.         }, 
  277.         {
  278.           "icon": "child_obj.icon", 
  279.           "key": "/index/cmdb/database", 
  280.           "title": "云-数据库"
  281.         }, 
  282.         {
  283.           "icon": "child_obj.icon", 
  284.           "key": "/index/cmdb/nat_gateway", 
  285.           "title": "云-Nat网关"
  286.         }, 
  287.         {
  288.           "icon": "child_obj.icon", 
  289.           "key": "/index/cmdb/oss", 
  290.           "title": "云-对象存储"
  291.         }, 
  292.         {
  293.           "icon": "child_obj.icon", 
  294.           "key": "/index/cmdb/domain", 
  295.           "title": "云-域名解析"
  296.         }
  297.       ], 
  298.       "icon": "parent_obj.icon", 
  299.       "id": 102, 
  300.       "key": "/index/cmdb", 
  301.       "title": "CMDB"
  302.     }, 
  303.     {
  304.       "child": [
  305.         {
  306.           "icon": "child_obj.icon", 
  307.           "key": "/index/ansible/task", 
  308.           "title": "Ansible任务管理"
  309.         }, 
  310.         {
  311.           "icon": "child_obj.icon", 
  312.           "key": "/index/ansible/log", 
  313.           "title": "Ansible任务日志"
  314.         }, 
  315.         {
  316.           "icon": "child_obj.icon", 
  317.           "key": "/index/ansible/vars", 
  318.           "title": "Ansible变量管理"
  319.         }
  320.       ], 
  321.       "icon": "parent_obj.icon", 
  322.       "id": 112, 
  323.       "key": "/index/ansible", 
  324.       "title": "任务系统"
  325.     }
  326.   ], 
  327.   "msg": "获取菜单列表成功", 
  328.   "return_code": 0
  329. }

装饰器

  • @login_required 需要登录访问,校验request中的token
  • @ops_log.operation_log(verification=False)

Dashboard

machine.py

页面

  • src/pages/home/Dashboard.js

接口

  • /host 查询主机信息(dns记录)
  • /machine cmdb pro机器查询接口
  • /machine/ 根据机器id查询
  • /galaxy/machines
    • Avatar表 关联 : group_id service_id machine_id
    • 根据部门id查询未绑定部门的机器
  • /machine/statistical
    • dashboard 机器相关数据统计

CMDB PRO 页面

机器管理

页面

  • src/pages/galaxy/Machine.js
    • 渲染所有机器信息 tabel

接口
ops-server/app/server/api/machine.py

  • /machine 查询所有机器
  • /machine?page=1&limit=10&zone_id__contains=hangzhou 筛选可用区
  • /machine?page=1&limit=10&instance_idcontains=i-bp14lk95qe2zsdas90uz&zone_idcontains=hangzhou 多个筛选条件

    服务管理

群组信息