跳到主要内容

overview 获取概览信息

POST /api/v1/system/overview​

描述​

用于在系统登录页面的抽屉中显示概览信息。也用于系统OLED屏幕上显示概览信息。信息包括设备IP、MAC地址、设备版本号，设备型号等信息。

访问权限​

没有权限，可以在未登录的情况下访问。

JSON参数​

请求参数如下：

{
  "keys"?: string[]
}
  • keys: 是一个字符串数组，可以是任意值， 如果不传递key，也可以正常访问， 返回尽可能多的静态信息，如果key不正确，返回空对象

响应结果​

请求返回的HTTP状态码为200

返回结果为JSON格式的数据，您可以通过解析JSON数据来获取API调用的结果信息。结构如下：

{
  "success": true|false,
  "data"?: {
    "device": {
      "type": "string",
      "version": "string",
    },
    "mgmt1"?: {
      "ip": "string",
      "mac": "string",
    },
    "mgmt2"?: {
      "ip": "string",
      "mac": "string",
    },
    "source"?: {
      "frequency": "string",
      "time": "string",
    }, 
    "powerOn"?: {
      "duration": "string",  // 开机时长, 格式为"1d 2h 3m 4s"
    },
    "power"?: {
      "power1": "string",  // 电源1状态
      "power2": "string",  // 电源2状态
    },
  },
  "errorCode"?: "option string",
  "errorMessage"?: "option string",
  "showType"?: 0|1|2|4|9,
  "traceId"?: "option string"
}
提示

为了保持一致性，返回的数据结构中，data包含多个字段，每个字段包含一个或者两个属性，比如mgmt1包含ip和mac属性。 返回属性应该都是可以直接显示的字符串，不需要额外的解析。

此信息用于在系统登录页面的抽屉中显示概览信息。也用于系统OLED屏幕上显示概览信息。信息包括设备IP、MAC地址、设备版本号，设备型号等信息。 此信息会每秒刷新一次，所以不需要缓存。超时时间为10秒。超时后会返回错误信息，超时后不会再次请求，手工刷新后会再次请求。

  • mgmt1: 管理口1的IP和MAC地址
  • mgmt2: 管理口2的IP和MAC地址
  • device: 设备型号和版本号
  • source: 信号源的频率和时间
  • powerOn: 开机时长

正确结果示例：

{
  "success": true,
  "data": {
    "mgmt1": {
      "ip": "192.168.188.188",
      "mac": "00:11:22:33:44:55",
    },
    "mgmt2": {
      "ip": "192.168.189.188",
      "mac": "00:11:22:33:44:56",
    },
    "device": {
      "type": "CS1588",
      "version": "1.0.0",
    },
    "source": {
      "frequency": "10MHz",
      "time": "GNSS1"
    },
  },
}