swagger.yaml

basePath: /api/cmd
definitions:
  backend.AllInfo:
    properties:
      dcuInfo:
        items:
          $ref: '#/definitions/backend.DCULoad'
        type: array
      loginUserInfo:
        items:
          $ref: '#/definitions/backend.LoginUserInfo'
        type: array
      sysInfo:
        $ref: '#/definitions/backend.SysInfo'
    type: object
  backend.DCULoad:
    properties:
      dcuUtilPercent:
        type: number
      fan:
        type: string
      index:
        type: integer
      memTotal:
        type: integer
      memUsed:
        type: integer
      memUsedPercent:
        type: number
      name:
        type: string
      pwrAvg:
        description: 单位是瓦
        type: number
      pwrCap:
        description: 单位是瓦
        type: number
      temp:
        description: 单位是摄氏度
        type: number
    type: object
  backend.LoginUserInfo:
    properties:
      loginFrom:
        description: 登录方式
        type: string
      loginTime:
        description: 登录时间
        type: string
      name:
        description: 用户名
        type: string
      pid:
        description: 登录的接管进程
        items:
          type: integer
        type: array
      tty:
        description: 占用的终端
        type: string
    type: object
  backend.Metrics:
    properties:
      alg_bw:
        type: number
      bus_bw:
        type: number
      time:
        type: number
      wrong:
        type: integer
    type: object
  backend.RcclTestAllReducePrefResult:
    properties:
      args:
        description: 执行参数
        type: string
      dtk_path:
        description: dtk 库路径
        type: string
      raw_output:
        type: string
      results:
        items:
          $ref: '#/definitions/backend.RcclTestItem'
        type: array
      test_version:
        description: rccl-tests 版本信息
        type: string
      use_device:
        description: 使用的设备列表
        items:
          type: string
        type: array
    type: object
  backend.RcclTestItem:
    properties:
      count:
        type: integer
      in_place:
        $ref: '#/definitions/backend.Metrics'
      out_of_place:
        $ref: '#/definitions/backend.Metrics'
      redop:
        type: string
      root:
        type: integer
      size:
        type: integer
      type:
        type: string
    type: object
  backend.SysInfo:
    properties:
      cpuPercent:
        description: CPU使用率
        type: number
      loadAverage1:
        description: 1分钟内平均负载
        type: number
      loadAverage5:
        description: 5分钟平均负载
        type: number
      loadAverage15:
        description: 15分钟平均负载
        type: number
      memTotal:
        description: 总内存
        type: integer
      memUsage:
        description: 已使用内存
        type: integer
      memUsagePercent:
        description: 已使用内存百分比
        type: number
      swapTotal:
        description: 总swap
        type: integer
      swapUsage:
        description: 已使用swap
        type: integer
      swapUsagePercent:
        description: 已使用swap百分比
        type: number
    type: object
  web.RcclArgs:
    properties:
      args:
        items:
          type: string
        type: array
    type: object
  web.RestfulListResult-backend_DCULoad:
    properties:
      code:
        type: integer
      data:
        items:
          $ref: '#/definitions/backend.DCULoad'
        type: array
      msg:
        type: string
    type: object
  web.RestfulListResult-backend_LoginUserInfo:
    properties:
      code:
        type: integer
      data:
        items:
          $ref: '#/definitions/backend.LoginUserInfo'
        type: array
      msg:
        type: string
    type: object
  web.RestfulNoDataResult:
    properties:
      code:
        type: integer
      msg:
        type: string
    type: object
  web.RestfulResult-backend_AllInfo:
    properties:
      code:
        type: integer
      data:
        $ref: '#/definitions/backend.AllInfo'
      msg:
        type: string
    type: object
  web.RestfulResult-backend_RcclTestAllReducePrefResult:
    properties:
      code:
        type: integer
      data:
        $ref: '#/definitions/backend.RcclTestAllReducePrefResult'
      msg:
        type: string
    type: object
  web.RestfulResult-backend_SysInfo:
    properties:
      code:
        type: integer
      data:
        $ref: '#/definitions/backend.SysInfo'
      msg:
        type: string
    type: object
info:
  contact: {}
  description: 这是opsflow节点命令在服务模式下的接口文档
  title: OpsFlow API
  version: "1.0"
paths:
  /all:
    get:
      consumes:
      - application/json
      description: 获取所有信息（系统负载、DCU 负载、在线用户）
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/web.RestfulResult-backend_AllInfo'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/web.RestfulNoDataResult'
      summary: 获取所有信息（系统负载、DCU 负载、在线用户）
  /dcuload:
    get:
      consumes:
      - application/json
      description: 获取 DCU 负载信息
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/web.RestfulListResult-backend_DCULoad'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/web.RestfulNoDataResult'
      summary: 获取 DCU 负载信息
  /loginUser:
    get:
      consumes:
      - application/json
      description: 获取在线用户信息
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/web.RestfulListResult-backend_LoginUserInfo'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/web.RestfulNoDataResult'
      summary: 获取在线用户信息
  /rccl/post:
    post:
      consumes:
      - application/json
      description: 给出rccl all_reduce_perf参数，执行单机测试
      parameters:
      - description: rccl all reduce perf args
        in: body
        name: args
        required: true
        schema:
          $ref: '#/definitions/web.RcclArgs'
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/web.RestfulResult-backend_RcclTestAllReducePrefResult'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/web.RestfulNoDataResult'
      summary: 给出rccl all_reduce_perf参数，执行单机测试
  /rcclinfo:
    get:
      consumes:
      - application/json
      description: 获取 rccl all_reduce_perf 性能信息
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/web.RestfulResult-backend_RcclTestAllReducePrefResult'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/web.RestfulNoDataResult'
      summary: 获取 rccl all_reduce_perf 性能信息
  /sysload:
    get:
      consumes:
      - application/json
      description: 获取系统负载信息
      produces:
      - application/json
      responses:
        "200":
          description: OK
          schema:
            $ref: '#/definitions/web.RestfulResult-backend_SysInfo'
        "500":
          description: Internal Server Error
          schema:
            $ref: '#/definitions/web.RestfulNoDataResult'
      summary: 获取系统负载信息
swagger: "2.0"